/// <summary>
/// Publishes the specified draft invoice.
/// After an invoice is published, Square
/// follows up based on the invoice configuration. For example, Square
/// sends the invoice to the customer's email address, charges the customer's card on file, or does
/// nothing. Square also makes the invoice available on a Square-hosted invoice page.
/// The invoice `status` also changes from `DRAFT` to a status
/// based on the invoice configuration. For example, the status changes to `UNPAID` if
/// Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on file for a portion of the
/// invoice amount).
/// For more information, see
/// [Create and publish an invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#create-and-publish-an-invoice).
/// </summary>
/// <param name="invoiceId">Required parameter: The id of the invoice to publish.</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.PublishInvoiceResponse response from the API call</return>
public Models.PublishInvoiceResponse PublishInvoice(string invoiceId, Models.PublishInvoiceRequest body)
{
Task <Models.PublishInvoiceResponse> t = PublishInvoiceAsync(invoiceId, body);
ApiHelper.RunTaskSynchronously(t);
return(t.Result);
}
/// <summary>
/// Publishes the specified draft invoice. .
/// After an invoice is published, Square .
/// follows up based on the invoice configuration. For example, Square .
/// sends the invoice to the customer's email address, charges the customer's card on file, or does .
/// nothing. Square also makes the invoice available on a Square-hosted invoice page. .
/// The invoice `status` also changes from `DRAFT` to a status .
/// based on the invoice configuration. For example, the status changes to `UNPAID` if .
/// Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on file for a portion of the .
/// invoice amount..
/// </summary>
/// <param name="invoiceId">Required parameter: The ID of the invoice to publish..</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.PublishInvoiceResponse response from the API call.</returns>
public async Task <Models.PublishInvoiceResponse> PublishInvoiceAsync(
string invoiceId,
Models.PublishInvoiceRequest 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/invoices/{invoice_id}/publish");
// process optional template parameters.
ApiHelper.AppendUrlWithTemplateParameters(queryBuilder, new Dictionary <string, object>()
{
{ "invoice_id", invoiceId },
});
// 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.PublishInvoiceResponse>(response.Body);
responseModel.Context = context;
return(responseModel);
}
/// <summary>
/// Publishes the specified draft invoice.
/// After an invoice is published, Square
/// follows up based on the invoice configuration. For example, Square
/// sends the invoice to the customer's email address, charges the customer's card on file, or does
/// nothing. Square also makes the invoice available on a Square-hosted invoice page.
/// The invoice `status` also changes from `DRAFT` to a status
/// based on the invoice configuration. For example, the status changes to `UNPAID` if
/// Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on file for a portion of the
/// invoice amount).
/// For more information, see
/// [Create and publish an invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#create-and-publish-an-invoice).
/// </summary>
/// <param name="invoiceId">Required parameter: The id of the invoice to publish.</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.PublishInvoiceResponse response from the API call</return>
public async Task <Models.PublishInvoiceResponse> PublishInvoiceAsync(string invoiceId, Models.PublishInvoiceRequest 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/invoices/{invoice_id}/publish");
//process optional template parameters
ApiHelper.AppendUrlWithTemplateParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "invoice_id", invoiceId }
});
//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().PostBody(_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.PublishInvoiceResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}