Class OfferClient

Service client instance for Offer.

Inheritance

object

ClientBase

RegionalClientBase

OfferClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MarketplaceprivateofferService

Assembly: OCI.DotNetSDK.Marketplaceprivateoffer.dll

Syntax

public class OfferClient : RegionalClientBase, IDisposable

Constructors

OfferClient(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 OfferClient(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 OfferPaginators Paginators { get; }

Property Value

Type	Description
OfferPaginators

Waiters

Declaration

public OfferWaiters Waiters { get; }

Property Value

Type	Description
OfferWaiters

Methods

CreateOffer(CreateOfferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Offer.

Declaration

public Task<CreateOfferResponse> CreateOffer(CreateOfferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOfferRequest	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<CreateOfferResponse>	A response object containing details about the completed operation

Examples

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

DeleteOffer(DeleteOfferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an Offer resource by identifier

Declaration

public Task<DeleteOfferResponse> DeleteOffer(DeleteOfferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOfferRequest	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<DeleteOfferResponse>	A response object containing details about the completed operation

Examples

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

GetOffer(GetOfferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an Offer by identifier

Declaration

public Task<GetOfferResponse> GetOffer(GetOfferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOfferRequest	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<GetOfferResponse>	A response object containing details about the completed operation

Examples

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

GetOfferInternalDetail(GetOfferInternalDetailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an Offer internal details by identifier

Declaration

public Task<GetOfferInternalDetailResponse> GetOfferInternalDetail(GetOfferInternalDetailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOfferInternalDetailRequest	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<GetOfferInternalDetailResponse>	A response object containing details about the completed operation

Examples

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

ListOffers(ListOffersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Offers. Requires either the BuyerCompartmentId or the SellerCompartmentId params. If neither or both are provided, then the API will return a 400.

Declaration

public Task<ListOffersResponse> ListOffers(ListOffersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOffersRequest	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<ListOffersResponse>	A response object containing details about the completed operation

Examples

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

SendOffer(SendOfferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Sends an Offer to be reviewed and accepted by the buyer. Validation will be run on the offer first to verify the offer is valid and contains all required fields.

Declaration

public Task<SendOfferResponse> SendOffer(SendOfferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SendOfferRequest	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<SendOfferResponse>	A response object containing details about the completed operation

Examples

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

UpdateOffer(UpdateOfferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Offer

Declaration

public Task<UpdateOfferResponse> UpdateOffer(UpdateOfferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOfferRequest	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<UpdateOfferResponse>	A response object containing details about the completed operation

Examples

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

WithdrawOffer(WithdrawOfferRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Withdraws an Offer and sends it back into DRAFT state. Offers can only be withdrawn before they are accepted by the buyer.

Declaration

public Task<WithdrawOfferResponse> WithdrawOffer(WithdrawOfferRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
WithdrawOfferRequest	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<WithdrawOfferResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable