OffersApi

Summary

MembersDescriptions

public OffersDto Offers()

This function will make a GET request to the Offers endpoint and return the response as a OffersDto object.

public OffersDto Offers( OffersUriParameterBuilder offersUriParameterBuilder)

It takes a OffersUriParameterBuilder object as a parameter, builds a HttpRequestMessage object, sends it to the API, and returns the response as a OffersDto object.

public OfferDto Offer(string offerId)

This function will return an OfferDto object if the API call is successful. Otherwise, it will throw an exception.

public LogsDto OfferLogs(string offerId)

This function will return a list of logs for a specific offer.

public LogsDto OfferLogs(string offerId, OffersUriParameterBuilder schemasUriParameterBuilder)

This function returns a list of logs for a specific offer.

private readonly string _requestUriBase

private Uri OffersUri()

It returns a new Uri object that is built from the _requestUriBase field and the /offers path

private Uri OffersUri( OffersUriParameterBuilder offersUriParameterBuilder)

It takes a OffersUriParameterBuilder object as a parameter and returns a Uri object.

private Uri OfferUri(string offerId)

It takes an offer ID and returns a URI.

private Uri OfferLogsUri(string offerId)

It returns a URI for the offer logs endpoint

private Uri OfferLogsUri(string offerId, OffersUriParameterBuilder offersUriParameterBuilder)

It returns a URI for the offer logs endpoint.

Members

public OffersDto Offers()

This function will make a GET request to the Offers endpoint and return the response as a OffersDto object.

Returns

A list of offers

public OffersDto Offers( OffersUriParameterBuilder offersUriParameterBuilder)

It takes a OffersUriParameterBuilder object as a parameter, builds a HttpRequestMessage object, sends it to the API, and returns the response as a OffersDto object.

Parameters

  • OffersUriParameterBuilder This is a class that contains all the parameters that can be passed to the API.

Returns

A list of offers.

public OfferDto Offer(string offerId)

This function will return an OfferDto object if the API call is successful. Otherwise, it will throw an exception.

Parameters

  • offerId The id of the offer you want to retrieve.

Returns

A single offer

public LogsDto OfferLogs(string offerId)

This function will return a list of logs for a specific offer.

Parameters

  • offerId The offer ID of the offer you want to get the logs for.

Returns

A list of logs for the offer.

public LogsDto OfferLogs(string offerId, OffersUriParameterBuilder schemasUriParameterBuilder)

This function returns a list of logs for a specific offer.

Parameters

  • offerId The offer id of the offer you want to get the logs for.

  • OffersUriParameterBuilder This is a class that contains all the parameters that can be passed to the API.

Returns

A LogsDto object

private readonly string _requestUriBase

private Uri OffersUri()

It returns a new Uri object that is built from the _requestUriBase field and the

/offers path

private Uri OffersUri( OffersUriParameterBuilder offersUriParameterBuilder)

It takes a OffersUriParameterBuilder object as a parameter and returns a Uri object.

Parameters

  • OffersUriParameterBuilder A class that builds the query string parameters for the request.

private Uri OfferUri(string offerId)

It takes an offer ID and returns a URI.

Parameters

  • offerId The offer ID of the offer you want to get.

private Uri OfferLogsUri(string offerId)

It returns a URI for the offer logs endpoint

Parameters

  • offerId The ID of the offer you want to get logs for.

private Uri OfferLogsUri(string offerId, OffersUriParameterBuilder offersUriParameterBuilder)

It returns a URI for the offer logs endpoint.

Parameters

  • offerId The offer ID

  • OffersUriParameterBuilder This is a class that builds the query string parameters for the request.

Last updated