Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Models/ListGiftCardsRequest.php
<?php
declare(strict_types=1);
namespace Square\Models;
use stdClass;
/**
* A request to list gift cards. You can optionally specify a filter to retrieve a subset of
* gift cards.
*/
class ListGiftCardsRequest implements \JsonSerializable
{
/**
* @var string|null
*/
private $type;
/**
* @var string|null
*/
private $state;
/**
* @var int|null
*/
private $limit;
/**
* @var string|null
*/
private $cursor;
/**
* @var string|null
*/
private $customerId;
/**
* Returns Type.
*
* If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type.
* Otherwise, the endpoint returns gift cards of all types.
*/
public function getType(): ?string
{
return $this->type;
}
/**
* Sets Type.
*
* If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type.
* Otherwise, the endpoint returns gift cards of all types.
*
* @maps type
*/
public function setType(?string $type): void
{
$this->type = $type;
}
/**
* Returns State.
*
* If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified
* state.
* Otherwise, the endpoint returns the gift cards of all states.
*/
public function getState(): ?string
{
return $this->state;
}
/**
* Sets State.
*
* If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified
* state.
* Otherwise, the endpoint returns the gift cards of all states.
*
* @maps state
*/
public function setState(?string $state): void
{
$this->state = $state;
}
/**
* Returns Limit.
*
* If a limit is provided, the endpoint returns only the specified number of results per page.
* The maximum value is 50. The default value is 30.
* For more information, see [Pagination](https://developer.squareup.com/docs/working-with-
* apis/pagination).
*/
public function getLimit(): ?int
{
return $this->limit;
}
/**
* Sets Limit.
*
* If a limit is provided, the endpoint returns only the specified number of results per page.
* The maximum value is 50. The default value is 30.
* For more information, see [Pagination](https://developer.squareup.com/docs/working-with-
* apis/pagination).
*
* @maps limit
*/
public function setLimit(?int $limit): void
{
$this->limit = $limit;
}
/**
* Returns Cursor.
*
* A pagination cursor returned by a previous call to this endpoint.
* Provide this cursor to retrieve the next set of results for the original query.
* If a cursor is not provided, the endpoint returns the first page of the results.
* For more information, see [Pagination](https://developer.squareup.com/docs/working-with-
* apis/pagination).
*/
public function getCursor(): ?string
{
return $this->cursor;
}
/**
* Sets Cursor.
*
* A pagination cursor returned by a previous call to this endpoint.
* Provide this cursor to retrieve the next set of results for the original query.
* If a cursor is not provided, the endpoint returns the first page of the results.
* For more information, see [Pagination](https://developer.squareup.com/docs/working-with-
* apis/pagination).
*
* @maps cursor
*/
public function setCursor(?string $cursor): void
{
$this->cursor = $cursor;
}
/**
* Returns Customer Id.
*
* If a customer ID is provided, the endpoint returns only the gift cards linked to the specified
* customer.
*/
public function getCustomerId(): ?string
{
return $this->customerId;
}
/**
* Sets Customer Id.
*
* If a customer ID is provided, the endpoint returns only the gift cards linked to the specified
* customer.
*
* @maps customer_id
*/
public function setCustomerId(?string $customerId): void
{
$this->customerId = $customerId;
}
/**
* Encode this object to JSON
*
* @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
* are set. (default: false)
*
* @return mixed
*/
public function jsonSerialize(bool $asArrayWhenEmpty = false)
{
$json = [];
if (isset($this->type)) {
$json['type'] = $this->type;
}
if (isset($this->state)) {
$json['state'] = $this->state;
}
if (isset($this->limit)) {
$json['limit'] = $this->limit;
}
if (isset($this->cursor)) {
$json['cursor'] = $this->cursor;
}
if (isset($this->customerId)) {
$json['customer_id'] = $this->customerId;
}
$json = array_filter($json, function ($val) {
return $val !== null;
});
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
}
}
Mini Shell