Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Models/SearchSubscriptionsRequest.php
<?php
declare(strict_types=1);
namespace Square\Models;
use stdClass;
/**
* Defines input parameters in a request to the
* [SearchSubscriptions]($e/Subscriptions/SearchSubscriptions) endpoint.
*/
class SearchSubscriptionsRequest implements \JsonSerializable
{
/**
* @var string|null
*/
private $cursor;
/**
* @var int|null
*/
private $limit;
/**
* @var SearchSubscriptionsQuery|null
*/
private $query;
/**
* @var string[]|null
*/
private $mInclude;
/**
* Returns Cursor.
*
* When the total number of resulting subscriptions exceeds the limit of a paged response,
* specify the cursor returned from a preceding response here to fetch the next set of results.
* If the cursor is unset, the response contains the last 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.
*
* When the total number of resulting subscriptions exceeds the limit of a paged response,
* specify the cursor returned from a preceding response here to fetch the next set of results.
* If the cursor is unset, the response contains the last 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 Limit.
*
* The upper limit on the number of subscriptions to return
* in a paged response.
*/
public function getLimit(): ?int
{
return $this->limit;
}
/**
* Sets Limit.
*
* The upper limit on the number of subscriptions to return
* in a paged response.
*
* @maps limit
*/
public function setLimit(?int $limit): void
{
$this->limit = $limit;
}
/**
* Returns Query.
*
* Represents a query, consisting of specified query expressions, used to search for subscriptions.
*/
public function getQuery(): ?SearchSubscriptionsQuery
{
return $this->query;
}
/**
* Sets Query.
*
* Represents a query, consisting of specified query expressions, used to search for subscriptions.
*
* @maps query
*/
public function setQuery(?SearchSubscriptionsQuery $query): void
{
$this->query = $query;
}
/**
* Returns M Include.
*
* A query parameter to specify related information to be included in the response.
*
* The supported query parameter values are:
*
* - `actions`: to include scheduled actions on the targeted subscriptions.
*
* @return string[]|null
*/
public function getMInclude(): ?array
{
return $this->mInclude;
}
/**
* Sets M Include.
*
* A query parameter to specify related information to be included in the response.
*
* The supported query parameter values are:
*
* - `actions`: to include scheduled actions on the targeted subscriptions.
*
* @maps include
*
* @param string[]|null $mInclude
*/
public function setMInclude(?array $mInclude): void
{
$this->mInclude = $mInclude;
}
/**
* 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->cursor)) {
$json['cursor'] = $this->cursor;
}
if (isset($this->limit)) {
$json['limit'] = $this->limit;
}
if (isset($this->query)) {
$json['query'] = $this->query;
}
if (isset($this->mInclude)) {
$json['include'] = $this->mInclude;
}
$json = array_filter($json, function ($val) {
return $val !== null;
});
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
}
}
Mini Shell