class

Polar::Api::CustomerSeats

Inherits Reference < Object

API client for customer_seats operations

Constants

Log = ::Log.for(self)

Constructors

new(client : Client)

Creates a new CustomerSeats instance

@param client [Client] The Polar API client instance

Source

Instance methods

assign_seat(body : Polar::Models::SeatAssign) : Polar::Models::CustomerSeat

Assign Seat

Scopes: customer_seats:write

Endpoint: POST /v1/customer-seats

Parameters:

  • body (required): Request body as Polar::Models::SeatAssign

Returns: Polar::Models::CustomerSeat

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
claim_seat(body : Polar::Models::SeatClaim) : Polar::Models::CustomerSeatClaimResponse

Claim Seat

Endpoint: POST /v1/customer-seats/claim

Parameters:

  • body (required): Request body as Polar::Models::SeatClaim

Returns: Polar::Models::CustomerSeatClaimResponse

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
get_claim_info(invitation_token : String) : Polar::Models::SeatClaimInfo

Get Claim Info

Endpoint: GET /v1/customer-seats/claim/{invitation_token}

Parameters:

  • invitation_token (required): Path parameter

Returns: Polar::Models::SeatClaimInfo

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
list_seats(subscription_id : String | Nil = nil, order_id : String | Nil = nil) : Polar::Models::SeatsList

List Seats

Scopes: customer_seats:write

Endpoint: GET /v1/customer-seats

Parameters:

  • subscription_id (optional): Query parameter
  • order_id (optional): Query parameter

Returns: Polar::Models::SeatsList

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
resend_invitation(seat_id : String) : Polar::Models::CustomerSeat

Resend Invitation

Scopes: customer_seats:write

Endpoint: POST /v1/customer-seats/{seat_id}/resend

Parameters:

  • seat_id (required): Path parameter

Returns: Polar::Models::CustomerSeat

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
revoke_seat(seat_id : String) : Polar::Models::CustomerSeat

Revoke Seat

Scopes: customer_seats:write

Endpoint: DELETE /v1/customer-seats/{seat_id}

Parameters:

  • seat_id (required): Path parameter

Returns: Polar::Models::CustomerSeat

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source