class Bfwd::RolesApi
Attributes
Public Class Methods
# File lib/bf_ruby2/api/roles_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a new role. {"nickname":"Create a new role","request":"createRoleRequest.html","response":"createRoleResponse.html"} @param role_request @param [Hash] opts the optional parameters @return [RolePagedMetadata]
# File lib/bf_ruby2/api/roles_api.rb, line 28 def create_role(role_request, opts = {}) data, _status_code, _headers = create_role_with_http_info(role_request, opts) return data end
Create a new role. {"nickname":"Create a new role","request":"createRoleRequest.html","response":"createRoleResponse.html"} @param role_request @param [Hash] opts the optional parameters @return [Array<(RolePagedMetadata
, Fixnum, Hash)>] RolePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/roles_api.rb, line 38 def create_role_with_http_info(role_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RolesApi.create_role ..." end # verify the required parameter 'role_request' is set if @api_client.config.client_side_validation && role_request.nil? fail ArgumentError, "Missing the required parameter 'role_request' when calling RolesApi.create_role" end # resource path local_var_path = "/roles" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(role_request) 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 => 'RolePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#create_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. {"nickname":"Retrieve all roles","response":"getRoleAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @option opts [Integer] :offset The offset from the first subscription to return. (default to 0) @option opts [Integer] :records The maximum number of subscriptions to return. (default to 10) @option opts [String] :order_by Specify a field used to order the result set. (default to created) @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC) @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. (default to false) @return [RolePagedMetadata]
# File lib/bf_ruby2/api/roles_api.rb, line 88 def get_all_roles(opts = {}) data, _status_code, _headers = get_all_roles_with_http_info(opts) return data end
Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. {"nickname":"Retrieve all roles","response":"getRoleAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @option opts [Integer] :offset The offset from the first subscription to return. @option opts [Integer] :records The maximum number of subscriptions to return. @option opts [String] :order_by Specify a field used to order the result set. @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. @return [Array<(RolePagedMetadata
, Fixnum, Hash)>] RolePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/roles_api.rb, line 103 def get_all_roles_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RolesApi.get_all_roles ..." end if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order']) fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC' end # resource path local_var_path = "/roles" # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil? query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RolePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#get_all_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves a single role, specified by the ID parameter. {"nickname":"Retrieve a role","response":"getRoleByID.html"} @param role ID or name of the role. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. (default to false) @return [RolePagedMetadata]
# File lib/bf_ruby2/api/roles_api.rb, line 153 def get_role_by_id(role, opts = {}) data, _status_code, _headers = get_role_by_id_with_http_info(role, opts) return data end
Retrieves a single role, specified by the ID parameter. {"nickname":"Retrieve a role","response":"getRoleByID.html"} @param role ID or name of the role. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. @return [Array<(RolePagedMetadata
, Fixnum, Hash)>] RolePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/roles_api.rb, line 165 def get_role_by_id_with_http_info(role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RolesApi.get_role_by_id ..." end # verify the required parameter 'role' is set if @api_client.config.client_side_validation && role.nil? fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.get_role_by_id" end # resource path local_var_path = "/roles/{role}".sub('{' + 'role' + '}', role.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RolePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#get_role_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Revokes a particular permission {"nickname":"Remove Permission from role","response":"removePermissionFromGroup.html","request":"removePermissionFromGroupRequest.html"} @param role ID or name of the role. @param resource @param action @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @return [RolePagedMetadata]
# File lib/bf_ruby2/api/roles_api.rb, line 215 def remove_permission_from_role(role, resource, action, opts = {}) data, _status_code, _headers = remove_permission_from_role_with_http_info(role, resource, action, opts) return data end
Revokes a particular permission {"nickname":"Remove Permission from role","response":"removePermissionFromGroup.html","request":"removePermissionFromGroupRequest.html"} @param role ID or name of the role. @param resource @param action @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @return [Array<(RolePagedMetadata
, Fixnum, Hash)>] RolePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/roles_api.rb, line 228 def remove_permission_from_role_with_http_info(role, resource, action, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RolesApi.remove_permission_from_role ..." end # verify the required parameter 'role' is set if @api_client.config.client_side_validation && role.nil? fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.remove_permission_from_role" end # verify the required parameter 'resource' is set if @api_client.config.client_side_validation && resource.nil? fail ArgumentError, "Missing the required parameter 'resource' when calling RolesApi.remove_permission_from_role" end # verify enum value if @api_client.config.client_side_validation && !['All', 'Account', 'Address', 'Amendment', 'Analytics', 'Audit', 'BFAdmin', 'BFJS', 'Charge', 'Client', 'Configuration', 'CouponBook', 'CouponBookDefinition', 'CouponDefinition', 'CouponInstance', 'CouponModifier', 'CouponRule', 'Coupon', 'Credit', 'CybersourceToken', 'Dunning', 'Email', 'FixedTerm', 'Gateway', 'Invoice', 'Notification', 'Organization', 'Password', 'PaymentMethod', 'Payment', 'Permission', 'PricingComponent', 'PricingComponentTier', 'PricingComponentValueChange', 'PricingComponentValue', 'ProductRatePlan', 'Product', 'ProductResources', 'Profile', 'Quote', 'Receipt', 'Refund', 'Salesforce', 'Search', 'Subscription', 'Tax', 'UnitOfMeasure', 'Usage', 'Username', 'User', 'UserResources', 'Webhook'].include?(resource) fail ArgumentError, "invalid value for 'resource', must be one of All, Account, Address, Amendment, Analytics, Audit, BFAdmin, BFJS, Charge, Client, Configuration, CouponBook, CouponBookDefinition, CouponDefinition, CouponInstance, CouponModifier, CouponRule, Coupon, Credit, CybersourceToken, Dunning, Email, FixedTerm, Gateway, Invoice, Notification, Organization, Password, PaymentMethod, Payment, Permission, PricingComponent, PricingComponentTier, PricingComponentValueChange, PricingComponentValue, ProductRatePlan, Product, ProductResources, Profile, Quote, Receipt, Refund, Salesforce, Search, Subscription, Tax, UnitOfMeasure, Usage, Username, User, UserResources, Webhook" end # verify the required parameter 'action' is set if @api_client.config.client_side_validation && action.nil? fail ArgumentError, "Missing the required parameter 'action' when calling RolesApi.remove_permission_from_role" end # verify enum value if @api_client.config.client_side_validation && !['All', 'AddToInvoice', 'AddToProductRatePlan', 'AddToSubscription', 'Advance', 'Aggregate', 'RemoveFromInvoice', 'RemoveFromProductRatePlan', 'RemoveFromSubscription', 'Cancel', 'Create', 'Delete', 'Edit', 'Execute', 'Freeze', 'Import', 'InvoiceCharges', 'Issue', 'Migrate', 'Read', 'Recalculate', 'Reset', 'Resume', 'Revive', 'Stop', 'Tokenize', 'Void'].include?(action) fail ArgumentError, "invalid value for 'action', must be one of All, AddToInvoice, AddToProductRatePlan, AddToSubscription, Advance, Aggregate, RemoveFromInvoice, RemoveFromProductRatePlan, RemoveFromSubscription, Cancel, Create, Delete, Edit, Execute, Freeze, Import, InvoiceCharges, Issue, Migrate, Read, Recalculate, Reset, Resume, Revive, Stop, Tokenize, Void" end # resource path local_var_path = "/roles/{role}/permission/{resource}/{action}".sub('{' + 'role' + '}', role.to_s).sub('{' + 'resource' + '}', resource.to_s).sub('{' + 'action' + '}', action.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RolePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#remove_permission_from_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Revokes a role {"nickname":"Revoke role","response":"revokeRole.html","request":"revokeRoleRequest.html"} @param role ID or name of the role. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @return [RolePagedMetadata]
# File lib/bf_ruby2/api/roles_api.rb, line 291 def revoke_role(role, opts = {}) data, _status_code, _headers = revoke_role_with_http_info(role, opts) return data end
Revokes a role {"nickname":"Revoke role","response":"revokeRole.html","request":"revokeRoleRequest.html"} @param role ID or name of the role. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations @return [Array<(RolePagedMetadata
, Fixnum, Hash)>] RolePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/roles_api.rb, line 302 def revoke_role_with_http_info(role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RolesApi.revoke_role ..." end # verify the required parameter 'role' is set if @api_client.config.client_side_validation && role.nil? fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.revoke_role" end # resource path local_var_path = "/roles/{role}".sub('{' + 'role' + '}', role.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RolePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#revoke_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a role. {"nickname":"Update a role","request":"updateRoleRequest.html","response":"updateRoleResponse.html"} @param role_request @param [Hash] opts the optional parameters @return [RolePagedMetadata]
# File lib/bf_ruby2/api/roles_api.rb, line 348 def update_role(role_request, opts = {}) data, _status_code, _headers = update_role_with_http_info(role_request, opts) return data end
Update a role. {"nickname":"Update a role","request":"updateRoleRequest.html","response":"updateRoleResponse.html"} @param role_request @param [Hash] opts the optional parameters @return [Array<(RolePagedMetadata
, Fixnum, Hash)>] RolePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/roles_api.rb, line 358 def update_role_with_http_info(role_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RolesApi.update_role ..." end # verify the required parameter 'role_request' is set if @api_client.config.client_side_validation && role_request.nil? fail ArgumentError, "Missing the required parameter 'role_request' when calling RolesApi.update_role" end # resource path local_var_path = "/roles" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(role_request) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RolePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#update_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end