Current path: home/webdevt/www/demo2/wp-content/plugins/wpforms-lite/vendor_prefixed/square/square/src/Models/
?? Go up: /home/webdevt/www/demo2/wp-content/plugins/wpforms-lite/vendor_prefixed/square/square/src
<?php
declare (strict_types=1);
namespace WPForms\Vendor\Square\Models;
use stdClass;
/**
* Describes a `ListInvoice` request.
*/
class ListInvoicesRequest implements \JsonSerializable
{
/**
* @var string
*/
private $locationId;
/**
* @var array
*/
private $cursor = [];
/**
* @var array
*/
private $limit = [];
/**
* @param string $locationId
*/
public function __construct(string $locationId)
{
$this->locationId = $locationId;
}
/**
* Returns Location Id.
* The ID of the location for which to list invoices.
*/
public function getLocationId() : string
{
return $this->locationId;
}
/**
* Sets Location Id.
* The ID of the location for which to list invoices.
*
* @required
* @maps location_id
*/
public function setLocationId(string $locationId) : void
{
$this->locationId = $locationId;
}
/**
* Returns Cursor.
* A pagination cursor returned by a previous call to this endpoint.
* Provide this cursor to retrieve the next set of results for your original query.
*
* For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-
* patterns/pagination).
*/
public function getCursor() : ?string
{
if (\count($this->cursor) == 0) {
return null;
}
return $this->cursor['value'];
}
/**
* Sets Cursor.
* A pagination cursor returned by a previous call to this endpoint.
* Provide this cursor to retrieve the next set of results for your original query.
*
* For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-
* patterns/pagination).
*
* @maps cursor
*/
public function setCursor(?string $cursor) : void
{
$this->cursor['value'] = $cursor;
}
/**
* Unsets Cursor.
* A pagination cursor returned by a previous call to this endpoint.
* Provide this cursor to retrieve the next set of results for your original query.
*
* For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-
* patterns/pagination).
*/
public function unsetCursor() : void
{
$this->cursor = [];
}
/**
* Returns Limit.
* The maximum number of invoices to return (200 is the maximum `limit`).
* If not provided, the server uses a default limit of 100 invoices.
*/
public function getLimit() : ?int
{
if (\count($this->limit) == 0) {
return null;
}
return $this->limit['value'];
}
/**
* Sets Limit.
* The maximum number of invoices to return (200 is the maximum `limit`).
* If not provided, the server uses a default limit of 100 invoices.
*
* @maps limit
*/
public function setLimit(?int $limit) : void
{
$this->limit['value'] = $limit;
}
/**
* Unsets Limit.
* The maximum number of invoices to return (200 is the maximum `limit`).
* If not provided, the server uses a default limit of 100 invoices.
*/
public function unsetLimit() : void
{
$this->limit = [];
}
/**
* Encode this object to JSON
*
* @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
* are set. (default: false)
*
* @return array|stdClass
*/
#[\ReturnTypeWillChange]
public function jsonSerialize(bool $asArrayWhenEmpty = \false)
{
$json = [];
$json['location_id'] = $this->locationId;
if (!empty($this->cursor)) {
$json['cursor'] = $this->cursor['value'];
}
if (!empty($this->limit)) {
$json['limit'] = $this->limit['value'];
}
$json = \array_filter($json, function ($val) {
return $val !== null;
});
return !$asArrayWhenEmpty && empty($json) ? new stdClass() : $json;
}
}