/// <summary>
/// Updates an open [Order](#type-order) by adding, replacing, or deleting
/// fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
/// An UpdateOrder request requires the following:
/// - The `order_id` in the endpoint path, identifying the order to update.
/// - The latest `version` of the order to update.
/// - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects)
/// containing only the fields to update and the version the update is
/// being applied to.
/// - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)
/// identifying fields to clear.
/// To pay for an order, please refer to the [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders) guide.
/// </summary>
/// <param name="orderId">Required parameter: The ID of the order to update.</param>
/// <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.UpdateOrderResponse response from the API call</return>
public Models.UpdateOrderResponse UpdateOrder(string orderId, Models.UpdateOrderRequest body)
{
Task <Models.UpdateOrderResponse> t = UpdateOrderAsync(orderId, body);
ApiHelper.RunTaskSynchronously(t);
return(t.Result);
}
/// <summary>
/// Updates an open [order]($m/Order) by adding, replacing, or deleting.
/// fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated..
/// An `UpdateOrder` request requires the following:.
/// - The `order_id` in the endpoint path, identifying the order to update..
/// - The latest `version` of the order to update..
/// - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects).
/// containing only the fields to update and the version to which the update is.
/// being applied..
/// - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation).
/// identifying the fields to clear..
/// To pay for an order, see .
/// [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)..
/// </summary>
/// <param name="orderId">Required parameter: The ID of the order to update..</param>
/// <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.UpdateOrderResponse response from the API call.</returns>
public async Task <Models.UpdateOrderResponse> UpdateOrderAsync(
string orderId,
Models.UpdateOrderRequest 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/orders/{order_id}");
// process optional template parameters.
ApiHelper.AppendUrlWithTemplateParameters(queryBuilder, new Dictionary <string, object>()
{
{ "order_id", orderId },
});
// 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().PutBody(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.UpdateOrderResponse>(response.Body);
responseModel.Context = context;
return(responseModel);
}
/// <summary>
/// Updates an open [Order](#type-order) by adding, replacing, or deleting
/// fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
/// An UpdateOrder request requires the following:
/// - The `order_id` in the endpoint path, identifying the order to update.
/// - The latest `version` of the order to update.
/// - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects)
/// containing only the fields to update and the version the update is
/// being applied to.
/// - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)
/// identifying fields to clear.
/// To pay for an order, please refer to the [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders) guide.
/// </summary>
/// <param name="orderId">Required parameter: The ID of the order to update.</param>
/// <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.UpdateOrderResponse response from the API call</return>
public async Task <Models.UpdateOrderResponse> UpdateOrderAsync(string orderId, Models.UpdateOrderRequest 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/orders/{order_id}");
//process optional template parameters
ApiHelper.AppendUrlWithTemplateParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "order_id", orderId }
});
//validate and preprocess url
string _queryUrl = ApiHelper.CleanUrl(_queryBuilder);
//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().PutBody(_queryUrl, _headers, _body);
if (HttpCallBack != null)
{
HttpCallBack.OnBeforeHttpRequestEventHandler(GetClientInstance(), _request);
}
_request = await authManagers["default"].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.UpdateOrderResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}