Class RewardsClient
Service client instance for Rewards.
Implements
Inherited Members
Namespace: Oci.UsageService
Assembly: OCI.DotNetSDK.Usage.dll
Syntax
public class RewardsClient : RegionalClientBase, IDisposable
Constructors
RewardsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public RewardsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public RewardsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
RewardsPaginators |
Methods
CreateRedeemableUser(CreateRedeemableUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds the list of redeemable user summary for a subscription ID.
Declaration
public Task<CreateRedeemableUserResponse> CreateRedeemableUser(CreateRedeemableUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRedeemableUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRedeemableUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRedeemableUser API.
DeleteRedeemableUser(DeleteRedeemableUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the list of redeemable user email ID for a subscription ID.
Declaration
public Task<DeleteRedeemableUserResponse> DeleteRedeemableUser(DeleteRedeemableUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRedeemableUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteRedeemableUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRedeemableUser API.
ListProducts(ListProductsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Provides product information that is specific to a reward usage period and its usage details.
Declaration
public Task<ListProductsResponse> ListProducts(ListProductsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProductsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListProductsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProducts API.
ListRedeemableUsers(ListRedeemableUsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Provides the list of user summary that can redeem rewards for the given subscription ID.
Declaration
public Task<ListRedeemableUsersResponse> ListRedeemableUsers(ListRedeemableUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRedeemableUsersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRedeemableUsersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRedeemableUsers API.
ListRedemptions(ListRedemptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of redemption for the subscription ID.
Declaration
public Task<ListRedemptionsResponse> ListRedemptions(ListRedemptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRedemptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRedemptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRedemptions API.
ListRewards(ListRewardsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of rewards for a subscription ID.
Declaration
public Task<ListRewardsResponse> ListRewards(ListRewardsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRewardsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRewardsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRewards API.