Class: OCI::OspGateway::SubscriptionServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/osp_gateway/subscription_service_client.rb

Overview

This site describes all the Rest endpoints of OSP Gateway.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ SubscriptionServiceClient

Creates a new SubscriptionServiceClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20191001'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "SubscriptionServiceClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#authorize_subscription_payment(osp_home_region, subscription_id, compartment_id, authorize_subscription_payment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use authorize_subscription_payment API.

PSD2 authorization for subscription payment

Parameters:

  • osp_home_region (String) —

    The home region's public name of the logged in user.

  • subscription_id (String) —

    Subscription id(OCID).

  • compartment_id (String) —

    The OCID of the compartment.

  • authorize_subscription_payment_details (OCI::OspGateway::Models::AuthorizeSubscriptionPaymentDetails) —

    subscription payment request.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 127

def authorize_subscription_payment(osp_home_region, subscription_id, compartment_id, authorize_subscription_payment_details, opts = {})
  logger.debug 'Calling operation SubscriptionServiceClient#authorize_subscription_payment.' if logger

  raise "Missing the required parameter 'osp_home_region' when calling authorize_subscription_payment." if osp_home_region.nil?
  raise "Missing the required parameter 'subscription_id' when calling authorize_subscription_payment." if subscription_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling authorize_subscription_payment." if compartment_id.nil?
  raise "Missing the required parameter 'authorize_subscription_payment_details' when calling authorize_subscription_payment." if authorize_subscription_payment_details.nil?
  raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id)

  path = '/subscriptions/{subscriptionId}/actions/psd2auth'.sub('{subscriptionId}', subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:ospHomeRegion] = osp_home_region
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(authorize_subscription_payment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SubscriptionServiceClient#authorize_subscription_payment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OspGateway::Models::AuthorizeSubscriptionPaymentReceipt'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_subscription(subscription_id, osp_home_region, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_subscription API.

Get the subscription plan.

Parameters:

  • subscription_id (String) —

    Subscription id(OCID).

  • osp_home_region (String) —

    The home region's public name of the logged in user.

  • compartment_id (String) —

    The OCID of the compartment.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 195

def get_subscription(subscription_id, osp_home_region, compartment_id, opts = {})
  logger.debug 'Calling operation SubscriptionServiceClient#get_subscription.' if logger

  raise "Missing the required parameter 'subscription_id' when calling get_subscription." if subscription_id.nil?
  raise "Missing the required parameter 'osp_home_region' when calling get_subscription." if osp_home_region.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_subscription." if compartment_id.nil?
  raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id)

  path = '/subscriptions/{subscriptionId}'.sub('{subscriptionId}', subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:ospHomeRegion] = osp_home_region
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SubscriptionServiceClient#get_subscription') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OspGateway::Models::Subscription'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_subscriptions(osp_home_region, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_subscriptions API.

Get the subscription data for the compartment Allowed values are: INVOICE_NO, REF_NO, STATUS, TYPE, INVOICE_DATE, DUE_DATE, PAYM_REF, TOTAL_AMOUNT, BALANCE_DUE Allowed values are: ASC, DESC

Parameters:

  • osp_home_region (String) —

    The home region's public name of the logged in user.

  • compartment_id (String) —

    The OCID of the compartment.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. (default to 500)

  • :sort_by (String) —

    The field to sort by. Only one field can be selected for sorting. (default to INVOICE_NO)

  • :sort_order (String) —

    The sort order to use (ascending or descending). (default to ASC)

Returns:



268
269
270
271
272
273
274
275
276
277
278
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
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 268

def list_subscriptions(osp_home_region, compartment_id, opts = {})
  logger.debug 'Calling operation SubscriptionServiceClient#list_subscriptions.' if logger

  raise "Missing the required parameter 'osp_home_region' when calling list_subscriptions." if osp_home_region.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_subscriptions." if compartment_id.nil?

  if opts[:sort_by] && !%w[INVOICE_NO REF_NO STATUS TYPE INVOICE_DATE DUE_DATE PAYM_REF TOTAL_AMOUNT BALANCE_DUE].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of INVOICE_NO, REF_NO, STATUS, TYPE, INVOICE_DATE, DUE_DATE, PAYM_REF, TOTAL_AMOUNT, BALANCE_DUE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/subscriptions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:ospHomeRegion] = osp_home_region
  query_params[:compartmentId] = compartment_id
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SubscriptionServiceClient#list_subscriptions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OspGateway::Models::SubscriptionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 94

def logger
  @api_client.config.logger
end

#pay_subscription(osp_home_region, subscription_id, compartment_id, pay_subscription_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use pay_subscription API.

Pay a subscription

Parameters:

  • osp_home_region (String) —

    The home region's public name of the logged in user.

  • subscription_id (String) —

    Subscription id(OCID).

  • compartment_id (String) —

    The OCID of the compartment.

  • pay_subscription_details (OCI::OspGateway::Models::PaySubscriptionDetails) —

    subscription payment request.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 352

def pay_subscription(osp_home_region, subscription_id, compartment_id, pay_subscription_details, opts = {})
  logger.debug 'Calling operation SubscriptionServiceClient#pay_subscription.' if logger

  raise "Missing the required parameter 'osp_home_region' when calling pay_subscription." if osp_home_region.nil?
  raise "Missing the required parameter 'subscription_id' when calling pay_subscription." if subscription_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling pay_subscription." if compartment_id.nil?
  raise "Missing the required parameter 'pay_subscription_details' when calling pay_subscription." if pay_subscription_details.nil?
  raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id)

  path = '/subscriptions/{subscriptionId}/actions/pay'.sub('{subscriptionId}', subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:ospHomeRegion] = osp_home_region
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(pay_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SubscriptionServiceClient#pay_subscription') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OspGateway::Models::PaySubscriptionReceipt'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_subscription(subscription_id, osp_home_region, compartment_id, update_subscription_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_subscription API.

Update plan of the subscription.

Parameters:

  • subscription_id (String) —

    Subscription id(OCID).

  • osp_home_region (String) —

    The home region's public name of the logged in user.

  • compartment_id (String) —

    The OCID of the compartment.

  • update_subscription_details (OCI::OspGateway::Models::UpdateSubscriptionDetails) —

    Subscription update request.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/oci/osp_gateway/subscription_service_client.rb', line 427

def update_subscription(subscription_id, osp_home_region, compartment_id, update_subscription_details, opts = {})
  logger.debug 'Calling operation SubscriptionServiceClient#update_subscription.' if logger

  raise "Missing the required parameter 'subscription_id' when calling update_subscription." if subscription_id.nil?
  raise "Missing the required parameter 'osp_home_region' when calling update_subscription." if osp_home_region.nil?
  raise "Missing the required parameter 'compartment_id' when calling update_subscription." if compartment_id.nil?
  raise "Missing the required parameter 'update_subscription_details' when calling update_subscription." if update_subscription_details.nil?
  raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id)

  path = '/subscriptions/{subscriptionId}'.sub('{subscriptionId}', subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:ospHomeRegion] = osp_home_region
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SubscriptionServiceClient#update_subscription') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OspGateway::Models::Subscription'
    )
  end
  # rubocop:enable Metrics/BlockLength
end