Class: Bfwd::PermissionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/permissions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PermissionsApi

Returns a new instance of PermissionsApi.



19
20
21
 
# File 'lib/bf_ruby2/api/permissions_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bf_ruby2/api/permissions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_permission(permission_request, opts = {}) ⇒ BFPermissionPagedMetadata

Create a new permission. a new permission","request":"createPermissionRequest.html","response":"createPermissionResponse.html"

Parameters:

  • permission_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# 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_permission_with_http_info(permission_request, opts = {}) ⇒ Array<(BFPermissionPagedMetadata, Fixnum, Hash)>

Create a new permission. a new permission&quot;,&quot;request&quot;:&quot;createPermissionRequest.html&quot;,&quot;response&quot;:&quot;createPermissionResponse.html&quot;

Parameters:

  • permission_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BFPermissionPagedMetadata, Fixnum, Hash)>) —

    BFPermissionPagedMetadata data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# 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

#get_all_permissions(opts = {}) ⇒ BFPermissionPagedMetadata

Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. all permissions","response":"getPermissionAll.html"

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return. (default to 0)

  • :records (Integer) —

    The maximum number of subscriptions to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired subscriptions should be returned. (default to false)

Returns:



88
89
90
91
 
# 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

#get_all_permissions_with_http_info(opts = {}) ⇒ Array<(BFPermissionPagedMetadata, Fixnum, Hash)>

Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. all permissions&quot;,&quot;response&quot;:&quot;getPermissionAll.html&quot;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return.

  • :records (Integer) —

    The maximum number of subscriptions to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired subscriptions should be returned.

Returns:

  • (Array<(BFPermissionPagedMetadata, Fixnum, Hash)>) —

    BFPermissionPagedMetadata data, response status code and response headers



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# 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

#get_available_actions_for_resource(resource, opts = {}) ⇒ PermissionActionEntityPagedMetadata

Retrieves all the available actions for the specified resource. available actions","response":"getAvailableActions.html"

Parameters:

  • resource
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



152
153
154
155
 
# 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

#get_available_actions_for_resource_with_http_info(resource, opts = {}) ⇒ Array<(PermissionActionEntityPagedMetadata, Fixnum, Hash)>

Retrieves all the available actions for the specified resource. available actions&quot;,&quot;response&quot;:&quot;getAvailableActions.html&quot;

Parameters:

  • resource
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# 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

#get_available_resources(opts = {}) ⇒ PermissionResourceEntityPagedMetadata

Retrieves all available resource. available resources","response":"getAvailableResources.html"

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



213
214
215
216
 
# 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

#get_available_resources_with_http_info(opts = {}) ⇒ Array<(PermissionResourceEntityPagedMetadata, Fixnum, Hash)>

Retrieves all available resource. available resources&quot;,&quot;response&quot;:&quot;getAvailableResources.html&quot;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# 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

#get_permission_by_id(permission_id, opts = {}) ⇒ BFPermissionPagedMetadata

Retrieves a single permission, specified by the ID parameter. a permission","response":"getPermissionByID.html"

Parameters:

  • permission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :include_retired (BOOLEAN) —

    Whether retired subscriptions should be returned. (default to false)

Returns:



267
268
269
270
 
# 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

#get_permission_by_id_with_http_info(permission_id, opts = {}) ⇒ Array<(BFPermissionPagedMetadata, Fixnum, Hash)>

Retrieves a single permission, specified by the ID parameter. a permission&quot;,&quot;response&quot;:&quot;getPermissionByID.html&quot;

Parameters:

  • permission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :include_retired (BOOLEAN) —

    Whether retired subscriptions should be returned.

Returns:

  • (Array<(BFPermissionPagedMetadata, Fixnum, Hash)>) —

    BFPermissionPagedMetadata data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# 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

#revoke_permission(permission_id, opts = {}) ⇒ BFPermissionPagedMetadata

Revokes a permission permission","response":"revokePermission.html","request":"revokePErmissionRequest.html"

Parameters:

  • permission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



327
328
329
330
 
# 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

#revoke_permission_with_http_info(permission_id, opts = {}) ⇒ Array<(BFPermissionPagedMetadata, Fixnum, Hash)>

Revokes a permission permission&quot;,&quot;response&quot;:&quot;revokePermission.html&quot;,&quot;request&quot;:&quot;revokePErmissionRequest.html&quot;

Parameters:

  • permission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(BFPermissionPagedMetadata, Fixnum, Hash)>) —

    BFPermissionPagedMetadata data, response status code and response headers



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# 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