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 a OffersDto object.

public OfferDto Offer(string offerId)

It builds an HTTP GET request to the OfferUri endpoint, sends the request to the API, and returns the response as an OfferDto object.

public LogsDto OfferLogs(string offerId)

This function returns a list of logs for a given 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 with the value of the _requestUriBase field, a forward slash, and the word "offers".

private Uri OffersUri( OffersUriParameterBuilder offersUriParameterBuilder)

It takes a OffersUriParameterBuilder object and returns a Uri object.

private Uri OfferUri(string offerId)

It returns a URI for the offer with the given ID.

private Uri OfferLogsUri(string offerId)

It returns a URI for the offer logs endpoint.

private Uri OfferLogsUri(string offerId, OffersUriParameterBuilder offersUriParameterBuilder)

It takes an offerId and an OffersUriParameterBuilder and returns a Uri.

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 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)

It builds an HTTP GET request to the OfferUri endpoint, sends the request to the API, and returns the response as an OfferDto object.

Parameters

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

Returns

A single offer

public LogsDto OfferLogs(string offerId)

This function returns a list of logs for a given 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 list of logs for the offer.

private readonly string _requestUriBase

private Uri OffersUri()

It returns a new Uri object with the value of the _requestUriBase field, a forward slash, and the word "offers".

private Uri OffersUri( OffersUriParameterBuilder offersUriParameterBuilder)

It takes a OffersUriParameterBuilder object and returns a Uri object.

Parameters

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

private Uri OfferUri(string offerId)

It returns a URI for the offer with the given ID.

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 takes an offerId and an OffersUriParameterBuilder and returns a Uri.

Parameters

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

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

Last updated