FileMaster

Edit File: CustomersApi.php

<?php

declare(strict_types=1);

namespace Square\Apis;

use Core\Request\Parameters\BodyParam;
use Core\Request\Parameters\HeaderParam;
use Core\Request\Parameters\QueryParam;
use Core\Request\Parameters\TemplateParam;
use CoreInterfaces\Core\Request\RequestMethod;
use Square\Http\ApiResponse;
use Square\Models\AddGroupToCustomerResponse;
use Square\Models\BulkCreateCustomersRequest;
use Square\Models\BulkCreateCustomersResponse;
use Square\Models\BulkDeleteCustomersRequest;
use Square\Models\BulkDeleteCustomersResponse;
use Square\Models\BulkRetrieveCustomersRequest;
use Square\Models\BulkRetrieveCustomersResponse;
use Square\Models\BulkUpdateCustomersRequest;
use Square\Models\BulkUpdateCustomersResponse;
use Square\Models\CreateCustomerCardRequest;
use Square\Models\CreateCustomerCardResponse;
use Square\Models\CreateCustomerRequest;
use Square\Models\CreateCustomerResponse;
use Square\Models\DeleteCustomerCardResponse;
use Square\Models\DeleteCustomerResponse;
use Square\Models\ListCustomersResponse;
use Square\Models\RemoveGroupFromCustomerResponse;
use Square\Models\RetrieveCustomerResponse;
use Square\Models\SearchCustomersRequest;
use Square\Models\SearchCustomersResponse;
use Square\Models\UpdateCustomerRequest;
use Square\Models\UpdateCustomerResponse;

class CustomersApi extends BaseApi
{
    /**
     * 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.
     *
     * @param string|null $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).
     * @param int|null $limit The maximum number of results to return in a single page. This limit
     *        is advisory. The response might contain more or fewer results.
     *        If the specified limit is less than 1 or greater than 100, Square returns a `400
     *        VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.
     *
     *        For more information, see [Pagination](https://developer.squareup.com/docs/build-
     *        basics/common-api-patterns/pagination).
     * @param string|null $sortField Indicates how customers should be sorted. The default value is
     *        `DEFAULT`.
     * @param string|null $sortOrder Indicates whether customers should be sorted in ascending
     *        (`ASC`) or
     *        descending (`DESC`) order.
     *
     *        The default value is `ASC`.
     * @param bool|null $count Indicates whether to return the total count of customers in the
     *        `count` field of the response.
     *
     *        The default value is `false`.
     *
     * @return ApiResponse Response from the API call
     */
    public function listCustomers(
        ?string $cursor = null,
        ?int $limit = null,
        ?string $sortField = null,
        ?string $sortOrder = null,
        ?bool $count = false
    ): ApiResponse {
        $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/customers')
            ->auth('global')
            ->parameters(
                QueryParam::init('cursor', $cursor),
                QueryParam::init('limit', $limit),
                QueryParam::init('sort_field', $sortField),
                QueryParam::init('sort_order', $sortOrder),
                QueryParam::init('count', $count)
            );

$_resHandler = $this->responseHandler()->type(ListCustomersResponse::class)->returnApiResponse();