class PostFinanceCheckout::UserAccountRoleService
Attributes
Public Class Methods
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Add Role
This operation grants the role to the given user with in the given account. @param user_id The id of the user to whom the role is assigned. @param account_id The account to which the role is mapped. @param role_id The role which is mapped to the user and account. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :applies_on_subaccount Whether the role applies only on subaccount. @return [UserAccountRole]
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 36 def add_role(user_id, account_id, role_id, opts = {}) data, _status_code, _headers = add_role_with_http_info(user_id, account_id, role_id, opts) return data end
Add Role
This operation grants the role to the given user with in the given account. @param user_id The id of the user to whom the role is assigned. @param account_id The account to which the role is mapped. @param role_id The role which is mapped to the user and account. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :applies_on_subaccount Whether the role applies only on subaccount. @return [Array<(UserAccountRole
, Fixnum, Hash)>] UserAccountRole
data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 49 def add_role_with_http_info(user_id, account_id, role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UserAccountRoleService.add_role ..." end # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling UserAccountRoleService.add_role" if user_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling UserAccountRoleService.add_role" if account_id.nil? # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling UserAccountRoleService.add_role" if role_id.nil? # resource path local_var_path = "/user-account-role/addRole".sub('{format}','json') # query parameters query_params = {} query_params[:'userId'] = user_id query_params[:'accountId'] = account_id query_params[:'roleId'] = role_id query_params[:'appliesOnSubaccount'] = opts[:'applies_on_subaccount'] if !opts[:'applies_on_subaccount'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserAccountRole') if @api_client.config.debugging @api_client.config.logger.debug "API called: UserAccountRoleService#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Roles List all the roles that are assigned to the given user in the given account. @param user_id The id of the user to whom the role is assigned. @param account_id The account to which the role is mapped. @param [Hash] opts the optional parameters @return [Array<UserAccountRole>]
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 105 def list(user_id, account_id, opts = {}) data, _status_code, _headers = list_with_http_info(user_id, account_id, opts) return data end
List Roles List all the roles that are assigned to the given user in the given account. @param user_id The id of the user to whom the role is assigned. @param account_id The account to which the role is mapped. @param [Hash] opts the optional parameters @return [Array<(Array<UserAccountRole>, Fixnum, Hash)>] Array<UserAccountRole> data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 116 def list_with_http_info(user_id, account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UserAccountRoleService.list ..." end # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling UserAccountRoleService.list" if user_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling UserAccountRoleService.list" if account_id.nil? # resource path local_var_path = "/user-account-role/list".sub('{format}','json') # query parameters query_params = {} query_params[:'userId'] = user_id query_params[:'accountId'] = account_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<UserAccountRole>') if @api_client.config.debugging @api_client.config.logger.debug "API called: UserAccountRoleService#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Remove Role
This operation removes the specified user account role. @param id The id of user account role which should be removed @param [Hash] opts the optional parameters @return [nil]
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 167 def remove_role(id, opts = {}) remove_role_with_http_info(id, opts) return nil end
Remove Role
This operation removes the specified user account role. @param id The id of user account role which should be removed @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/user_account_role_service_api.rb, line 177 def remove_role_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UserAccountRoleService.remove_role ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling UserAccountRoleService.remove_role" if id.nil? # resource path local_var_path = "/user-account-role/removeRole".sub('{format}','json') # query parameters query_params = {} query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UserAccountRoleService#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end