class Bfwd::PermissionsApi
Attributes
Public Class Methods
# File lib/bf_ruby2/api/permissions_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a new permission. {"nickname":"Create a new permission","request":"createPermissionRequest.html","response":"createPermissionResponse.html"} @param permission_request @param [Hash] opts the optional parameters @return [BFPermissionPagedMetadata]
# File lib/bf_ruby2/api/permissions_api.rb, line 28 def create_permission(permission_request, opts = {}) data, _status_code, _headers = create_permission_with_http_info(permission_request, opts) return data end
Create a new permission. {"nickname":"Create a new permission","request":"createPermissionRequest.html","response":"createPermissionResponse.html"} @param permission_request @param [Hash] opts the optional parameters @return [Array<(BFPermissionPagedMetadata
, Fixnum, Hash)>] BFPermissionPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/permissions_api.rb, line 38 def create_permission_with_http_info(permission_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PermissionsApi.create_permission ..." end # verify the required parameter 'permission_request' is set if @api_client.config.client_side_validation && permission_request.nil? fail ArgumentError, "Missing the required parameter 'permission_request' when calling PermissionsApi.create_permission" end # resource path local_var_path = "/permissions" # 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(permission_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 => 'BFPermissionPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionsApi#create_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. {"nickname":"Retrieve all permissions","response":"getPermissionAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @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 [BFPermissionPagedMetadata]
# File lib/bf_ruby2/api/permissions_api.rb, line 88 def get_all_permissions(opts = {}) data, _status_code, _headers = get_all_permissions_with_http_info(opts) return data end
Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. {"nickname":"Retrieve all permissions","response":"getPermissionAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @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<(BFPermissionPagedMetadata
, Fixnum, Hash)>] BFPermissionPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/permissions_api.rb, line 103 def get_all_permissions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PermissionsApi.get_all_permissions ..." 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 = "/permissions" # 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 => 'BFPermissionPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionsApi#get_all_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves all the available actions for the specified resource. {"nickname":"Retrieve available actions","response":"getAvailableActions.html"} @param resource @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [PermissionActionEntityPagedMetadata]
# File lib/bf_ruby2/api/permissions_api.rb, line 152 def get_available_actions_for_resource(resource, opts = {}) data, _status_code, _headers = get_available_actions_for_resource_with_http_info(resource, opts) return data end
Retrieves all the available actions for the specified resource. {"nickname":"Retrieve available actions","response":"getAvailableActions.html"} @param resource @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(PermissionActionEntityPagedMetadata
, Fixnum, Hash)>] PermissionActionEntityPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/permissions_api.rb, line 163 def get_available_actions_for_resource_with_http_info(resource, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PermissionsApi.get_available_actions_for_resource ..." 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 PermissionsApi.get_available_actions_for_resource" 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 # resource path local_var_path = "/permissions/resources/{resource}".sub('{' + 'resource' + '}', resource.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(: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 => 'PermissionActionEntityPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionsApi#get_available_actions_for_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves all available resource. {"nickname":"Retrieve available resources","response":"getAvailableResources.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [PermissionResourceEntityPagedMetadata]
# File lib/bf_ruby2/api/permissions_api.rb, line 213 def get_available_resources(opts = {}) data, _status_code, _headers = get_available_resources_with_http_info(opts) return data end
Retrieves all available resource. {"nickname":"Retrieve available resources","response":"getAvailableResources.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(PermissionResourceEntityPagedMetadata
, Fixnum, Hash)>] PermissionResourceEntityPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/permissions_api.rb, line 223 def get_available_resources_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PermissionsApi.get_available_resources ..." end # resource path local_var_path = "/permissions/resources" # 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(: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 => 'PermissionResourceEntityPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionsApi#get_available_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves a single permission, specified by the ID parameter. {"nickname":"Retrieve a permission","response":"getPermissionByID.html"} @param permission_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. (default to false) @return [BFPermissionPagedMetadata]
# File lib/bf_ruby2/api/permissions_api.rb, line 267 def get_permission_by_id(permission_id, opts = {}) data, _status_code, _headers = get_permission_by_id_with_http_info(permission_id, opts) return data end
Retrieves a single permission, specified by the ID parameter. {"nickname":"Retrieve a permission","response":"getPermissionByID.html"} @param permission_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. @return [Array<(BFPermissionPagedMetadata
, Fixnum, Hash)>] BFPermissionPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/permissions_api.rb, line 279 def get_permission_by_id_with_http_info(permission_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PermissionsApi.get_permission_by_id ..." end # verify the required parameter 'permission_id' is set if @api_client.config.client_side_validation && permission_id.nil? fail ArgumentError, "Missing the required parameter 'permission_id' when calling PermissionsApi.get_permission_by_id" end # resource path local_var_path = "/permissions/{permission-ID}".sub('{' + 'permission-ID' + '}', permission_id.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 => 'BFPermissionPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionsApi#get_permission_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Revokes a permission {"nickname":"Revoke permission","response":"revokePermission.html","request":"revokePErmissionRequest.html"} @param permission_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [BFPermissionPagedMetadata]
# File lib/bf_ruby2/api/permissions_api.rb, line 327 def revoke_permission(permission_id, opts = {}) data, _status_code, _headers = revoke_permission_with_http_info(permission_id, opts) return data end
Revokes a permission {"nickname":"Revoke permission","response":"revokePermission.html","request":"revokePErmissionRequest.html"} @param permission_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(BFPermissionPagedMetadata
, Fixnum, Hash)>] BFPermissionPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/permissions_api.rb, line 338 def revoke_permission_with_http_info(permission_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PermissionsApi.revoke_permission ..." end # verify the required parameter 'permission_id' is set if @api_client.config.client_side_validation && permission_id.nil? fail ArgumentError, "Missing the required parameter 'permission_id' when calling PermissionsApi.revoke_permission" end # resource path local_var_path = "/permissions/{permission-ID}".sub('{' + 'permission-ID' + '}', permission_id.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(['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(: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 => 'BFPermissionPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionsApi#revoke_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end