/// <summary>
/// Searches for subscriptions.
/// Results are ordered chronologically by subscription creation date. If
/// the request specifies more than one location ID,
/// the endpoint orders the result
/// by location ID, and then by creation date within each location. If no locations are given
/// in the query, all locations are searched.
/// You can also optionally specify `customer_ids` to search by customer.
/// If left unset, all customers
/// associated with the specified locations are returned.
/// If the request specifies customer IDs, the endpoint orders results
/// first by location, within location by customer ID, and within
/// customer by subscription creation date.
/// For more information, see
/// [Retrieve subscriptions](https://developer.squareup.com/docs/docs/subscriptions-api/overview#retrieve-subscriptions).
/// </summary>
/// <param name="body">Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
/// <return>Returns the Models.SearchSubscriptionsResponse response from the API call</return>
public Models.SearchSubscriptionsResponse SearchSubscriptions(Models.SearchSubscriptionsRequest body)
{
Task <Models.SearchSubscriptionsResponse> t = SearchSubscriptionsAsync(body);
ApiHelper.RunTaskSynchronously(t);
return(t.Result);
}
/// <summary>
/// Searches for subscriptions..
/// Results are ordered chronologically by subscription creation date. If.
/// the request specifies more than one location ID,.
/// the endpoint orders the result.
/// by location ID, and then by creation date within each location. If no locations are given.
/// in the query, all locations are searched..
/// You can also optionally specify `customer_ids` to search by customer..
/// If left unset, all customers.
/// associated with the specified locations are returned..
/// If the request specifies customer IDs, the endpoint orders results.
/// first by location, within location by customer ID, and within.
/// customer by subscription creation date..
/// For more information, see.
/// [Retrieve subscriptions](https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions)..
/// </summary>
/// <param name="body">Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details..</param>
/// <param name="cancellationToken"> cancellationToken. </param>
/// <returns>Returns the Models.SearchSubscriptionsResponse response from the API call.</returns>
public async Task <Models.SearchSubscriptionsResponse> SearchSubscriptionsAsync(
Models.SearchSubscriptionsRequest body,
CancellationToken cancellationToken = default)
{
// the base uri for api requests.
string baseUri = this.Config.GetBaseUri();
// prepare query string for API call.
StringBuilder queryBuilder = new StringBuilder(baseUri);
queryBuilder.Append("/v2/subscriptions/search");
// append request with appropriate headers and parameters
var headers = new Dictionary <string, string>()
{
{ "user-agent", this.UserAgent },
{ "accept", "application/json" },
{ "content-type", "application/json; charset=utf-8" },
{ "Square-Version", this.Config.SquareVersion },
};
// append body params.
var bodyText = ApiHelper.JsonSerialize(body);
// prepare the API call request to fetch the response.
HttpRequest httpRequest = this.GetClientInstance().PostBody(queryBuilder.ToString(), headers, bodyText);
if (this.HttpCallBack != null)
{
this.HttpCallBack.OnBeforeHttpRequestEventHandler(this.GetClientInstance(), httpRequest);
}
httpRequest = await this.AuthManagers["global"].ApplyAsync(httpRequest).ConfigureAwait(false);
// invoke request and get response.
HttpStringResponse response = await this.GetClientInstance().ExecuteAsStringAsync(httpRequest, cancellationToken).ConfigureAwait(false);
HttpContext context = new HttpContext(httpRequest, response);
if (this.HttpCallBack != null)
{
this.HttpCallBack.OnAfterHttpResponseEventHandler(this.GetClientInstance(), response);
}
// handle errors defined at the API level.
this.ValidateResponse(response, context);
var responseModel = ApiHelper.JsonDeserialize <Models.SearchSubscriptionsResponse>(response.Body);
responseModel.Context = context;
return(responseModel);
}
/// <summary>
/// Searches for subscriptions.
/// Results are ordered chronologically by subscription creation date. If
/// the request specifies more than one location ID,
/// the endpoint orders the result
/// by location ID, and then by creation date within each location. If no locations are given
/// in the query, all locations are searched.
/// You can also optionally specify `customer_ids` to search by customer.
/// If left unset, all customers
/// associated with the specified locations are returned.
/// If the request specifies customer IDs, the endpoint orders results
/// first by location, within location by customer ID, and within
/// customer by subscription creation date.
/// For more information, see
/// [Retrieve subscriptions](https://developer.squareup.com/docs/docs/subscriptions-api/overview#retrieve-subscriptions).
/// </summary>
/// <param name="body">Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
/// <return>Returns the Models.SearchSubscriptionsResponse response from the API call</return>
public async Task <Models.SearchSubscriptionsResponse> SearchSubscriptionsAsync(Models.SearchSubscriptionsRequest body, CancellationToken cancellationToken = default)
{
//the base uri for api requests
string _baseUri = config.GetBaseUri();
//prepare query string for API call
StringBuilder _queryBuilder = new StringBuilder(_baseUri);
_queryBuilder.Append("/v2/subscriptions/search");
//append request with appropriate headers and parameters
var _headers = new Dictionary <string, string>()
{
{ "user-agent", userAgent },
{ "accept", "application/json" },
{ "content-type", "application/json; charset=utf-8" },
{ "Square-Version", config.SquareVersion }
};
//append body params
var _body = ApiHelper.JsonSerialize(body);
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().PostBody(_queryBuilder.ToString(), _headers, _body);
if (HttpCallBack != null)
{
HttpCallBack.OnBeforeHttpRequestEventHandler(GetClientInstance(), _request);
}
_request = await authManagers["global"].ApplyAsync(_request).ConfigureAwait(false);
//invoke request and get response
HttpStringResponse _response = await GetClientInstance().ExecuteAsStringAsync(_request, cancellationToken).ConfigureAwait(false);
HttpContext _context = new HttpContext(_request, _response);
if (HttpCallBack != null)
{
HttpCallBack.OnAfterHttpResponseEventHandler(GetClientInstance(), _response);
}
//handle errors defined at the API level
base.ValidateResponse(_response, _context);
var _responseModel = ApiHelper.JsonDeserialize <Models.SearchSubscriptionsResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}
