FileMaster

Edit File: BookingsApi.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\BulkRetrieveBookingsRequest;
use Square\Models\BulkRetrieveBookingsResponse;
use Square\Models\BulkRetrieveTeamMemberBookingProfilesRequest;
use Square\Models\BulkRetrieveTeamMemberBookingProfilesResponse;
use Square\Models\CancelBookingRequest;
use Square\Models\CancelBookingResponse;
use Square\Models\CreateBookingRequest;
use Square\Models\CreateBookingResponse;
use Square\Models\ListBookingsResponse;
use Square\Models\ListLocationBookingProfilesResponse;
use Square\Models\ListTeamMemberBookingProfilesResponse;
use Square\Models\RetrieveBookingResponse;
use Square\Models\RetrieveBusinessBookingProfileResponse;
use Square\Models\RetrieveLocationBookingProfileResponse;
use Square\Models\RetrieveTeamMemberBookingProfileResponse;
use Square\Models\SearchAvailabilityRequest;
use Square\Models\SearchAvailabilityResponse;
use Square\Models\UpdateBookingRequest;
use Square\Models\UpdateBookingResponse;

class BookingsApi extends BaseApi
{
    /**
     * Retrieve a collection of bookings.
     *
     * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
     * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
     * `APPOINTMENTS_READ` for the OAuth scope.
     *
     * @param int|null $limit The maximum number of results per page to return in a paged response.
     * @param string|null $cursor The pagination cursor from the preceding response to return the
     *        next page of the results. Do not set this when retrieving the first page of the
     *        results.
     * @param string|null $customerId The [customer](entity:Customer) for whom to retrieve bookings.
     *        If this is not set, bookings for all customers are retrieved.
     * @param string|null $teamMemberId The team member for whom to retrieve bookings. If this is
     *        not set, bookings of all members are retrieved.
     * @param string|null $locationId The location for which to retrieve bookings. If this is not
     *        set, all locations' bookings are retrieved.
     * @param string|null $startAtMin The RFC 3339 timestamp specifying the earliest of the start
     *        time. If this is not set, the current time is used.
     * @param string|null $startAtMax The RFC 3339 timestamp specifying the latest of the start
     *        time. If this is not set, the time of 31 days after `start_at_min` is used.
     *
     * @return ApiResponse Response from the API call
     */
    public function listBookings(
        ?int $limit = null,
        ?string $cursor = null,
        ?string $customerId = null,
        ?string $teamMemberId = null,
        ?string $locationId = null,
        ?string $startAtMin = null,
        ?string $startAtMax = null
    ): ApiResponse {
        $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings')
            ->auth('global')
            ->parameters(
                QueryParam::init('limit', $limit),
                QueryParam::init('cursor', $cursor),
                QueryParam::init('customer_id', $customerId),
                QueryParam::init('team_member_id', $teamMemberId),
                QueryParam::init('location_id', $locationId),
                QueryParam::init('start_at_min', $startAtMin),
                QueryParam::init('start_at_max', $startAtMax)
            );

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