SubscriptionServiceClient¶
-
class
oci.osp_gateway.
SubscriptionServiceClient
(config, **kwargs)¶ This site describes all the Rest endpoints of OSP Gateway.
Methods
__init__
(config, **kwargs)Creates a new service client authorize_subscription_payment
(…)PSD2 authorization for subscription payment get_subscription
(subscription_id, …)Get the subscription plan. list_subscriptions
(osp_home_region, …)Get the subscription data for the compartment pay_subscription
(osp_home_region, …)Pay a subscription update_subscription
(subscription_id, …)Update plan of the subscription. -
__init__
(config, **kwargs)¶ Creates a new service client
Parameters: - config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
from_file()
method can be used to load configuration from a file. Alternatively, adict
can be passed. You can validate_config the dict usingvalidate_config()
- service_endpoint (str) – (optional)
The endpoint of the service to call using this client. For example
https://iaas.us-ashburn-1.oraclecloud.com
. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. - timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
- signer (
AbstractBaseSigner
) –(optional) The signer to use when signing requests made by the service client. The default is to use a
Signer
based on the values provided in the config parameter.One use case for this parameter is for Instance Principals authentication by passing an instance of
InstancePrincipalsSecurityTokenSigner
as the value for this keyword argument - retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a
retry_strategy
keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.This should be one of the strategies available in the
retry
module. A convenienceDEFAULT_RETRY_STRATEGY
is also available. The specifics of the default retry strategy are described here. - circuit_breaker_strategy (obj) – (optional)
A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level).
This client uses
DEFAULT_CIRCUIT_BREAKER_STRATEGY
as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here. - circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
- client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
- allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
PSD2 authorization for subscription payment
Parameters: - osp_home_region (str) – (required) The home region’s public name of the logged in user.
- subscription_id (str) – (required) Subscription id(OCID).
- compartment_id (str) –
(required) The OCID of the compartment.
- authorize_subscription_payment_details (oci.osp_gateway.models.AuthorizeSubscriptionPaymentDetails) – (required) subscription payment request.
- if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAuthorizeSubscriptionPaymentReceipt
Return type: Example: Click here to see an example of how to use authorize_subscription_payment API.
-
get_subscription
(subscription_id, osp_home_region, compartment_id, **kwargs)¶ Get the subscription plan.
Parameters: - subscription_id (str) – (required) Subscription id(OCID).
- osp_home_region (str) – (required) The home region’s public name of the logged in user.
- compartment_id (str) –
(required) The OCID of the compartment.
- opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeSubscription
Return type: Example: Click here to see an example of how to use get_subscription API.
-
list_subscriptions
(osp_home_region, compartment_id, **kwargs)¶ Get the subscription data for the compartment
Parameters: - osp_home_region (str) – (required) The home region’s public name of the logged in user.
- compartment_id (str) –
(required) The OCID of the compartment.
- opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call.
- limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
- sort_by (str) –
(optional) The field to sort by. Only one field can be selected for sorting.
Allowed values are: “INVOICE_NO”, “REF_NO”, “STATUS”, “TYPE”, “INVOICE_DATE”, “DUE_DATE”, “PAYM_REF”, “TOTAL_AMOUNT”, “BALANCE_DUE”
- sort_order (str) –
(optional) The sort order to use (ascending or descending).
Allowed values are: “ASC”, “DESC”
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeSubscriptionCollection
Return type: Example: Click here to see an example of how to use list_subscriptions API.
-
pay_subscription
(osp_home_region, subscription_id, compartment_id, pay_subscription_details, **kwargs)¶ Pay a subscription
Parameters: - osp_home_region (str) – (required) The home region’s public name of the logged in user.
- subscription_id (str) – (required) Subscription id(OCID).
- compartment_id (str) –
(required) The OCID of the compartment.
- pay_subscription_details (oci.osp_gateway.models.PaySubscriptionDetails) – (required) subscription payment request.
- if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typePaySubscriptionReceipt
Return type: Example: Click here to see an example of how to use pay_subscription API.
-
update_subscription
(subscription_id, osp_home_region, compartment_id, update_subscription_details, **kwargs)¶ Update plan of the subscription.
Parameters: - subscription_id (str) – (required) Subscription id(OCID).
- osp_home_region (str) – (required) The home region’s public name of the logged in user.
- compartment_id (str) –
(required) The OCID of the compartment.
- update_subscription_details (oci.osp_gateway.models.UpdateSubscriptionDetails) – (required) Subscription update request.
- opc_request_id (str) – (optional) 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 (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeSubscription
Return type: Example: Click here to see an example of how to use update_subscription API.
-