RewardsClient

class oci.usage.RewardsClient(config, **kwargs)

A description of the UsageApi API.

Methods

__init__(config, **kwargs) Creates a new service client
create_redeemable_user(…) Add list of redeemable user email ids for a subscription Id
delete_redeemable_user(email_id, tenancy_id, …) Delete list of redeemable user email ids for a subscription Id
list_products(tenancy_id, subscription_id, …) This API provides usage period specific product and its usage details.
list_redeemable_users(tenancy_id, …) Provides emailids of redeemable users for the given subscriptionId
list_rewards(tenancy_id, subscription_id, …) This API returns list of rewards for a subscription Id
__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, a dict can be passed. You can validate_config the dict using validate_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 convenience DEFAULT_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.
  • 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.
create_redeemable_user(create_redeemable_user_details, tenancy_id, subscription_id, **kwargs)

Add list of redeemable user email ids for a subscription Id

Parameters:
  • create_redeemable_user_details (oci.usage.models.CreateRedeemableUserDetails) – (required) CreateRedeemableUserDetails inforamtion.
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • subscription_id (str) – (required) The subscriptionId for which rewards information is requested for.
  • user_id (str) – (optional) The user Id of the person whose email we cc
  • opc_request_id (str) – (optional) 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.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 type RedeemableUserCollection

Return type:

Response

Example:

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

delete_redeemable_user(email_id, tenancy_id, subscription_id, **kwargs)

Delete list of redeemable user email ids for a subscription Id

Parameters:
  • email_id (str) – (required) The EmailId that needs to be deleted
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • subscription_id (str) – (required) The subscriptionId for which rewards information is requested for.
  • opc_request_id (str) – (optional) 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 type None

Return type:

Response

Example:

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

list_products(tenancy_id, subscription_id, usage_period_key, **kwargs)

This API provides usage period specific product and its usage details.

Parameters:
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • subscription_id (str) – (required) The subscriptionId for which rewards information is requested for.
  • usage_period_key (str) – (required) The SPM Identifier for the usage period.
  • opc_request_id (str) – (optional) 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) The value of the ‘opc-next-page’ response header from the previous call.
  • limit (int) – (optional) The maximum number of items to return in the paginated response.
  • sort_order (str) –

    (optional) The sort order to use, can be ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by, supports one sort Order.

    Allowed values are: “TIMECREATED”, “TIMESTART”

  • producttype (str) –

    (optional) The field to specify the type of product.

    Allowed values are: “ALL”, “ELIGIBLE”, “INELIGIBLE”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 type ProductCollection

Return type:

Response

Example:

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

list_redeemable_users(tenancy_id, subscription_id, **kwargs)

Provides emailids of redeemable users for the given subscriptionId

Parameters:
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • subscription_id (str) – (required) The subscriptionId for which rewards information is requested for.
  • opc_request_id (str) – (optional) 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) The value of the ‘opc-next-page’ response header from the previous call.
  • limit (int) – (optional) The maximum number of items to return in the paginated response.
  • sort_order (str) –

    (optional) The sort order to use, can be ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by, supports one sort Order.

    Allowed values are: “TIMECREATED”, “TIMESTART”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 type RedeemableUserCollection

Return type:

Response

Example:

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

list_rewards(tenancy_id, subscription_id, **kwargs)

This API returns list of rewards for a subscription Id

Parameters:
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • subscription_id (str) – (required) The subscriptionId for which rewards information is requested for.
  • opc_request_id (str) – (optional) 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 type RewardCollection

Return type:

Response

Example:

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