Search documentation of polar_express

# PolarExpress.Services.CustomerSeatsService (polar_express v0.1.5)

Copy Markdown View Source

Customer-seats

CustomerSeats API operations.

## Summary

### Functions

assign_seat(client, params \\ %{}, opts \\ [])

Assign Seat

claim_seat(client, params \\ %{}, opts \\ [])

Claim Seat

get_claim_info(client, invitation_token, params \\ %{}, opts \\ [])

Get Claim Info

list_seats(client, params \\ %{}, opts \\ [])

List Seats

resend_invitation(client, seat_id, params \\ %{}, opts \\ [])

Resend Invitation

revoke_seat(client, seat_id, params \\ %{}, opts \\ [])

Revoke Seat

## Functions

# assign_seat(client, params \\ %{}, opts \\ [])

    @spec assign_seat(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CustomerSeat.t()}
      | {:error, PolarExpress.Error.t()}

Assign Seat

Scopes: `customer_seats:write`

See `PolarExpress.Params.CustomerSeatsAssignSeatParams` for parameter details.

# claim_seat(client, params \\ %{}, opts \\ [])

    @spec claim_seat(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CustomerSeatClaimResponse.t()}
      | {:error, PolarExpress.Error.t()}

Claim Seat

See `PolarExpress.Params.CustomerSeatsClaimSeatParams` for parameter details.

# get_claim_info(client, invitation_token, params \\ %{}, opts \\ [])

    @spec get_claim_info(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.SeatClaimInfo.t()}
      | {:error, PolarExpress.Error.t()}

Get Claim Info

See `PolarExpress.Params.CustomerSeatsGetClaimInfoParams` for parameter details.

# list_seats(client, params \\ %{}, opts \\ [])

    @spec list_seats(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.SeatsList.t()} | {:error, PolarExpress.Error.t()}

List Seats

Scopes: `customer_seats:write`

See `PolarExpress.Params.CustomerSeatsListSeatsParams` for parameter details.

# resend_invitation(client, seat_id, params \\ %{}, opts \\ [])

    @spec resend_invitation(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CustomerSeat.t()}
      | {:error, PolarExpress.Error.t()}

Resend Invitation

Scopes: `customer_seats:write`

See `PolarExpress.Params.CustomerSeatsResendInvitationParams` for parameter details.

# revoke_seat(client, seat_id, params \\ %{}, opts \\ [])

    @spec revoke_seat(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CustomerSeat.t()}
      | {:error, PolarExpress.Error.t()}

Revoke Seat

Scopes: `customer_seats:write`

See `PolarExpress.Params.CustomerSeatsRevokeSeatParams` for parameter details.