README.md

CustomerSeats

Overview

Available Operations

• listSeats - List Seats
• assignSeat - Assign Seat
• revokeSeat - Revoke Seat
• resendInvitation - Resend Invitation
• getClaimInfo - Get Claim Info
• claimSeat - Claim Seat

listSeats

Scopes: customer_seats:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->customerSeats->listSeats(

);

if ($response->seatsList !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
subscriptionId	?string	➖	N/A
orderId	?string	➖	N/A

Response

?Operations\CustomerSeatsListSeatsResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

assignSeat

Scopes: customer_seats:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\SeatAssign();

$response = $sdk->customerSeats->assignSeat(
    request: $request
);

if ($response->customerSeat !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
$request	Components\SeatAssign	✔️	The request object to use for the request.

Response

?Operations\CustomerSeatsAssignSeatResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

revokeSeat

Scopes: customer_seats:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->customerSeats->revokeSeat(
    seatId: '<value>'
);

if ($response->customerSeat !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
seatId	string	✔️	N/A

Response

?Operations\CustomerSeatsRevokeSeatResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

resendInvitation

Scopes: customer_seats:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->customerSeats->resendInvitation(
    seatId: '<value>'
);

if ($response->customerSeat !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
seatId	string	✔️	N/A

Response

?Operations\CustomerSeatsResendInvitationResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

getClaimInfo

Get Claim Info

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()->build();



$response = $sdk->customerSeats->getClaimInfo(
    invitationToken: '<value>'
);

if ($response->seatClaimInfo !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
invitationToken	string	✔️	N/A

Response

?Operations\CustomerSeatsGetClaimInfoResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

claimSeat

Claim Seat

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()->build();

$request = new Components\SeatClaim(
    invitationToken: '<value>',
);

$response = $sdk->customerSeats->claimSeat(
    request: $request
);

if ($response->customerSeatClaimResponse !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
$request	Components\SeatClaim	✔️	The request object to use for the request.

Response

?Operations\CustomerSeatsClaimSeatResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*