Polarex.Seats (Polarex v0.3.1)

Copy Markdown View Source

Provides API endpoints related to seats

Summary

Functions

customer_portal_seats_assign_seat(body, opts \\ [])

Assign Seat

customer_portal_seats_list_claimed_subscriptions(opts \\ [])

List Claimed Subscriptions

customer_portal_seats_list_seats(opts \\ [])

List Seats

customer_portal_seats_resend_invitation(seat_id, opts \\ [])

Resend Invitation

customer_portal_seats_revoke_seat(seat_id, opts \\ [])

Revoke Seat

Functions

customer_portal_seats_assign_seat(body, opts \\ [])

@spec customer_portal_seats_assign_seat(
  body :: Polarex.SeatAssign.t(),
  opts :: keyword()
) ::
  {:ok, Polarex.CustomerSeat.t()} | {:error, Polarex.HTTPValidationError.t()}

Assign Seat

Request Body

Content Types: application/json

customer_portal_seats_list_claimed_subscriptions(opts \\ [])

@spec customer_portal_seats_list_claimed_subscriptions(opts :: keyword()) ::
  {:ok, Polarex.ListResourceCustomerSubscription.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Claimed Subscriptions

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

Scopes: customer_portal:read customer_portal:write

Options

  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.

customer_portal_seats_list_seats(opts \\ [])

@spec customer_portal_seats_list_seats(opts :: keyword()) ::
  {:ok, Polarex.SeatsList.t()} | {:error, Polarex.HTTPValidationError.t()}

List Seats

Scopes: customer_portal:read customer_portal:write

Options

  • subscription_id: Subscription ID
  • order_id: Order ID

customer_portal_seats_resend_invitation(seat_id, opts \\ [])

@spec customer_portal_seats_resend_invitation(
  seat_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, Polarex.CustomerSeat.t()} | {:error, Polarex.HTTPValidationError.t()}

Resend Invitation

customer_portal_seats_revoke_seat(seat_id, opts \\ [])

@spec customer_portal_seats_revoke_seat(seat_id :: String.t(), opts :: keyword()) ::
  {:ok, Polarex.CustomerSeat.t()} | {:error, Polarex.HTTPValidationError.t()}

Revoke Seat