/// <summary>
/// Retrieves a specific `Refund` using the `refund_id`.
/// </summary>
/// <param name="refundId">Required parameter: Unique ID for the desired `PaymentRefund`.</param>
/// <return>Returns the Models.GetPaymentRefundResponse response from the API call</return>
public async Task <Models.GetPaymentRefundResponse> GetPaymentRefundAsync(string refundId, 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/refunds/{refund_id}");
//process optional template parameters
ApiHelper.AppendUrlWithTemplateParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "refund_id", refundId }
});
//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" },
{ "Square-Version", config.SquareVersion }
};
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Get(_queryUrl, _headers);
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.GetPaymentRefundResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}
public async Task <Models.RenewTokenResponse> RenewTokenAsync(string clientId, Models.RenewTokenRequest body, string authorization, 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("/oauth2/clients/{client_id}/access-token/renew");
//process optional template parameters
ApiHelper.AppendUrlWithTemplateParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "client_id", clientId }
});
//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" },
{ "Authorization", authorization },
{ "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);
}
//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.RenewTokenResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}
/// <summary>
/// Provides summary information for all of a business's employee roles.
/// </summary>
/// <param name="order">Optional parameter: The order in which employees are listed in the response, based on their created_at field.Default value: ASC</param>
/// <param name="limit">Optional parameter: The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.</param>
/// <param name="batchToken">Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.</param>
/// <return>Returns the List<Models.V1EmployeeRole> response from the API call</return>
public async Task <List <Models.V1EmployeeRole> > ListEmployeeRolesAsync(string order = null, int?limit = null, string batchToken = null, 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("/v1/me/roles");
//prepare specfied query parameters
var _queryParameters = new Dictionary <string, object>()
{
{ "order", order },
{ "limit", limit },
{ "batch_token", batchToken }
};
//append request with appropriate headers and parameters
var _headers = new Dictionary <string, string>()
{
{ "user-agent", userAgent },
{ "accept", "application/json" },
{ "Square-Version", config.SquareVersion }
};
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Get(_queryBuilder.ToString(), _headers, queryParameters: _queryParameters);
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 _responseModels = ApiHelper.JsonDeserialize <List <Models.V1EmployeeRole> >(_response.Body);
_responseModels.ForEach(r => r.Context = _context);
return(_responseModels);
}
/// <summary>
/// Lists customer profiles associated with a Square account.
/// Under normal operating conditions, newly created or updated customer profiles become available
/// for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated
/// profiles can take closer to one minute or longer, especially during network incidents and outages.
/// </summary>
/// <param name="cursor">Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.</param>
/// <param name="sortField">Optional parameter: Indicates how Customers should be sorted. Default: `DEFAULT`.</param>
/// <param name="sortOrder">Optional parameter: Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`.</param>
/// <return>Returns the Models.ListCustomersResponse response from the API call</return>
public async Task <Models.ListCustomersResponse> ListCustomersAsync(string cursor = null, string sortField = null, string sortOrder = null, 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/customers");
//prepare specfied query parameters
var _queryParameters = new Dictionary <string, object>()
{
{ "cursor", cursor },
{ "sort_field", sortField },
{ "sort_order", sortOrder }
};
//append request with appropriate headers and parameters
var _headers = new Dictionary <string, string>()
{
{ "user-agent", userAgent },
{ "accept", "application/json" },
{ "Square-Version", config.SquareVersion }
};
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Get(_queryBuilder.ToString(), _headers, queryParameters: _queryParameters);
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.ListCustomersResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}
/// <summary>
/// Creates a location.
/// For more information about locations, see [Locations API Overview](https://developer.squareup.com/docs/locations-api).
/// </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.CreateLocationResponse response from the API call</return>
public async Task <Models.CreateLocationResponse> CreateLocationAsync(Models.CreateLocationRequest 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/locations");
//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", "2020-05-28" }
};
//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.CreateLocationResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}
/// <summary>
/// TODO: type endpoint description here
/// </summary>
/// <return>Returns the string response from the API call</return>
public async Task <string> GetCustomHeaderSignatureAsync()
{
//the base uri for api requests
string _baseUri = config.GetBaseURI();
//prepare query string for API call
StringBuilder _queryBuilder = new StringBuilder(_baseUri);
_queryBuilder.Append("/auth/customHeaderSignature");
//validate and preprocess url
string _queryUrl = APIHelper.CleanUrl(_queryBuilder);
//append request with appropriate headers and parameters
var _headers = new Dictionary <string, string>()
{
{ "user-agent", "APIMATIC 2.0" }
};
_headers.Add("token", config.Token);
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Get(_queryUrl, _headers);
if (HttpCallBack != null)
{
HttpCallBack.OnBeforeHttpRequestEventHandler(GetClientInstance(), _request);
}
//invoke request and get response
HttpStringResponse _response = (HttpStringResponse) await GetClientInstance().ExecuteAsStringAsync(_request).ConfigureAwait(false);
HttpContext _context = new HttpContext(_request, _response);
if (HttpCallBack != null)
{
HttpCallBack.OnAfterHttpResponseEventHandler(GetClientInstance(), _response);
}
//handle errors defined at the API level
ValidateResponse(_response, _context);
try
{
return(_response.Body);
}
catch (Exception _ex)
{
throw new APIException("Failed to parse the response: " + _ex.Message, _context);
}
}
public async Task <List <Models.V1Merchant> > ListLocationsAsync(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("/v1/me/locations");
//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" },
{ "Square-Version", config.SquareVersion }
};
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Get(_queryUrl, _headers);
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 _responseModels = ApiHelper.JsonDeserialize <List <Models.V1Merchant> >(_response.Body);
_responseModels.ForEach(r => r.Context = _context);
return(_responseModels);
}
public async Task <Models.ListRefundsResponse> ListRefundsAsync(
string locationId,
string beginTime = null,
string endTime = null,
string sortOrder = null,
string cursor = null, 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/locations/{location_id}/refunds");
//process optional template parameters
ApiHelper.AppendUrlWithTemplateParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "location_id", locationId }
});
//process optional query parameters
ApiHelper.AppendUrlWithQueryParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "begin_time", beginTime },
{ "end_time", endTime },
{ "sort_order", sortOrder },
{ "cursor", cursor }
}, ArrayDeserializationFormat, ParameterSeparator);
//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" },
{ "Square-Version", "2020-02-26" }
};
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Get(_queryUrl, _headers);
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.ListRefundsResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}
/// <summary>
/// Uploads a file to use as evidence in a dispute challenge. The endpoint accepts
/// HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG,
/// and TIFF formats.
/// </summary>
/// <param name="disputeId">Required parameter: ID of the dispute you want to upload evidence for.</param>
/// <param name="request">Optional parameter: Defines parameters for a CreateDisputeEvidenceFile request.</param>
/// <param name="imageFile">Optional parameter: Example: </param>
/// <return>Returns the Models.CreateDisputeEvidenceFileResponse response from the API call</return>
public async Task <Models.CreateDisputeEvidenceFileResponse> CreateDisputeEvidenceFileAsync(string disputeId, Models.CreateDisputeEvidenceFileRequest request = null, FileStreamInfo imageFile = null, 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/disputes/{dispute_id}/evidence_file");
//process optional template parameters
ApiHelper.AppendUrlWithTemplateParameters(_queryBuilder, new Dictionary <string, object>()
{
{ "dispute_id", disputeId }
});
//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" },
{ "Square-Version", config.SquareVersion }
};
var requestHeaders = new Dictionary <string, IReadOnlyCollection <string> >(StringComparer.OrdinalIgnoreCase)
{
{ "Content-Type", new [] { "application/json; charset=utf-8" } }
};
var imageFileHeaders = new Dictionary <string, IReadOnlyCollection <string> >(StringComparer.OrdinalIgnoreCase)
{
{ "Content-Type", new [] { string.IsNullOrEmpty(imageFile.ContentType) ? "image/jpeg" : imageFile.ContentType } }
};
//append form/field parameters
var _fields = new List <KeyValuePair <string, Object> >()
{
new KeyValuePair <string, object>("image_file", CreateFileMultipartContent(imageFile, imageFileHeaders))
};
_fields.Add(new KeyValuePair <string, object>("request", CreateJsonEncodedMultipartContent(request, requestHeaders)));
//remove null parameters
_fields = _fields.Where(kvp => kvp.Value != null).ToList();
//prepare the API call request to fetch the response
HttpRequest _request = GetClientInstance().Post(_queryUrl, _headers, _fields);
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.CreateDisputeEvidenceFileResponse>(_response.Body);
_responseModel.Context = _context;
return(_responseModel);
}