Search documentation of polar_express

# PolarExpress.Services.CustomerPortal.SeatsService (polar_express v0.1.5)

Copy Markdown View Source

Seats

Seats API operations.

## Summary

### Functions

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

Assign Seat

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

List Claimed Subscriptions

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

See `PolarExpress.Params.CustomerPortal.SeatsAssignSeatParams` for parameter details.

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

    @spec list_claimed_subscriptions(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}

List Claimed Subscriptions

List all subscriptions where the authenticated customer has claimed a seat.

Scopes: `customer_portal:read` `customer_portal:write`

See `PolarExpress.Params.CustomerPortal.SeatsListClaimedSubscriptionsParams` 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_portal:read` `customer_portal:write`

See `PolarExpress.Params.CustomerPortal.SeatsListSeatsParams` 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

See `PolarExpress.Params.CustomerPortal.SeatsResendInvitationParams` 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

See `PolarExpress.Params.CustomerPortal.SeatsRevokeSeatParams` for parameter details.