FileMaster

Edit File: SearchCatalogItemsRequest.php

<?php

declare(strict_types=1);

namespace Square\Models;

use stdClass;

/**
 * Defines the request body for the [SearchCatalogItems]($e/Catalog/SearchCatalogItems) endpoint.
 */
class SearchCatalogItemsRequest implements \JsonSerializable
{
    /**
     * @var string|null
     */
    private $textFilter;

/**
     * @var string[]|null
     */
    private $categoryIds;

/**
     * @var string[]|null
     */
    private $stockLevels;

/**
     * @var string[]|null
     */
    private $enabledLocationIds;

/**
     * @var string|null
     */
    private $cursor;

/**
     * @var int|null
     */
    private $limit;

/**
     * @var string|null
     */
    private $sortOrder;

/**
     * @var string[]|null
     */
    private $productTypes;

/**
     * @var CustomAttributeFilter[]|null
     */
    private $customAttributeFilters;

/**
     * @var string|null
     */
    private $archivedState;

/**
     * Returns Text Filter.
     * The text filter expression to return items or item variations containing specified text in
     * the `name`, `description`, or `abbreviation` attribute value of an item, or in
     * the `name`, `sku`, or `upc` attribute value of an item variation.
     */
    public function getTextFilter(): ?string
    {
        return $this->textFilter;
    }

/**
     * Sets Text Filter.
     * The text filter expression to return items or item variations containing specified text in
     * the `name`, `description`, or `abbreviation` attribute value of an item, or in
     * the `name`, `sku`, or `upc` attribute value of an item variation.
     *
     * @maps text_filter
     */
    public function setTextFilter(?string $textFilter): void
    {
        $this->textFilter = $textFilter;
    }

/**
     * Returns Category Ids.
     * The category id query expression to return items containing the specified category IDs.
     *
     * @return string[]|null
     */
    public function getCategoryIds(): ?array
    {
        return $this->categoryIds;
    }

/**
     * Sets Category Ids.
     * The category id query expression to return items containing the specified category IDs.
     *
     * @maps category_ids
     *
     * @param string[]|null $categoryIds
     */
    public function setCategoryIds(?array $categoryIds): void
    {
        $this->categoryIds = $categoryIds;
    }

/**
     * Returns Stock Levels.
     * The stock-level query expression to return item variations with the specified stock levels.
     * See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible
     * values
     *
     * @return string[]|null
     */
    public function getStockLevels(): ?array
    {
        return $this->stockLevels;
    }

/**
     * Sets Stock Levels.
     * The stock-level query expression to return item variations with the specified stock levels.
     * See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible
     * values
     *
     * @maps stock_levels
     *
     * @param string[]|null $stockLevels
     */
    public function setStockLevels(?array $stockLevels): void
    {
        $this->stockLevels = $stockLevels;
    }

/**
     * Returns Enabled Location Ids.
     * The enabled-location query expression to return items and item variations having specified enabled
     * locations.
     *
     * @return string[]|null
     */
    public function getEnabledLocationIds(): ?array
    {
        return $this->enabledLocationIds;
    }

/**
     * Sets Enabled Location Ids.
     * The enabled-location query expression to return items and item variations having specified enabled
     * locations.
     *
     * @maps enabled_location_ids
     *
     * @param string[]|null $enabledLocationIds
     */
    public function setEnabledLocationIds(?array $enabledLocationIds): void
    {
        $this->enabledLocationIds = $enabledLocationIds;
    }

/**
     * Returns Cursor.
     * The pagination token, returned in the previous response, used to fetch the next batch of pending
     * results.
     */
    public function getCursor(): ?string
    {
        return $this->cursor;
    }

/**
     * Sets Cursor.
     * The pagination token, returned in the previous response, used to fetch the next batch of pending
     * results.
     *
     * @maps cursor
     */
    public function setCursor(?string $cursor): void
    {
        $this->cursor = $cursor;
    }

/**
     * Returns Limit.
     * The maximum number of results to return per page. The default value is 100.
     */
    public function getLimit(): ?int
    {
        return $this->limit;
    }

/**
     * Sets Limit.
     * The maximum number of results to return per page. The default value is 100.
     *
     * @maps limit
     */
    public function setLimit(?int $limit): void
    {
        $this->limit = $limit;
    }

/**
     * Returns Sort Order.
     * The order (e.g., chronological or alphabetical) in which results from a request are returned.
     */
    public function getSortOrder(): ?string
    {
        return $this->sortOrder;
    }

/**
     * Sets Sort Order.
     * The order (e.g., chronological or alphabetical) in which results from a request are returned.
     *
     * @maps sort_order
     */
    public function setSortOrder(?string $sortOrder): void
    {
        $this->sortOrder = $sortOrder;
    }

/**
     * Returns Product Types.
     * The product types query expression to return items or item variations having the specified product
     * types.
     *
     * @return string[]|null
     */
    public function getProductTypes(): ?array
    {
        return $this->productTypes;
    }

/**
     * Sets Product Types.
     * The product types query expression to return items or item variations having the specified product
     * types.
     *
     * @maps product_types
     *
     * @param string[]|null $productTypes
     */
    public function setProductTypes(?array $productTypes): void
    {
        $this->productTypes = $productTypes;
    }

/**
     * Returns Custom Attribute Filters.
     * The customer-attribute filter to return items or item variations matching the specified
     * custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in
     * a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.
     *
     * @return CustomAttributeFilter[]|null
     */
    public function getCustomAttributeFilters(): ?array
    {
        return $this->customAttributeFilters;
    }

/**
     * Sets Custom Attribute Filters.
     * The customer-attribute filter to return items or item variations matching the specified
     * custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in
     * a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.
     *
     * @maps custom_attribute_filters
     *
     * @param CustomAttributeFilter[]|null $customAttributeFilters
     */
    public function setCustomAttributeFilters(?array $customAttributeFilters): void
    {
        $this->customAttributeFilters = $customAttributeFilters;
    }

/**
     * Returns Archived State.
     * Defines the values for the `archived_state` query expression
     * used in [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
     * to return the archived, not archived or either type of catalog items.
     */
    public function getArchivedState(): ?string
    {
        return $this->archivedState;
    }

/**
     * Sets Archived State.
     * Defines the values for the `archived_state` query expression
     * used in [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
     * to return the archived, not archived or either type of catalog items.
     *
     * @maps archived_state
     */
    public function setArchivedState(?string $archivedState): void
    {
        $this->archivedState = $archivedState;
    }

/**
     * 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] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1)
    public function jsonSerialize(bool $asArrayWhenEmpty = false)
    {
        $json = [];
        if (isset($this->textFilter)) {
            $json['text_filter']              = $this->textFilter;
        }
        if (isset($this->categoryIds)) {
            $json['category_ids']             = $this->categoryIds;
        }
        if (isset($this->stockLevels)) {
            $json['stock_levels']             = $this->stockLevels;
        }
        if (isset($this->enabledLocationIds)) {
            $json['enabled_location_ids']     = $this->enabledLocationIds;
        }
        if (isset($this->cursor)) {
            $json['cursor']                   = $this->cursor;
        }
        if (isset($this->limit)) {
            $json['limit']                    = $this->limit;
        }
        if (isset($this->sortOrder)) {
            $json['sort_order']               = $this->sortOrder;
        }
        if (isset($this->productTypes)) {
            $json['product_types']            = $this->productTypes;
        }
        if (isset($this->customAttributeFilters)) {
            $json['custom_attribute_filters'] = $this->customAttributeFilters;
        }
        if (isset($this->archivedState)) {
            $json['archived_state']           = $this->archivedState;
        }
        $json = array_filter($json, function ($val) {
            return $val !== null;
        });

return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
    }
}

Back