Polarex.CustomerSeats (Polarex v0.2.8)

View Source

Provides API endpoints related to customer seats

Summary

Functions

customer_seats_assign_seat(body, opts \\ [])

Assign Seat

customer_seats_claim_seat(body, opts \\ [])

Claim Seat

customer_seats_get_claim_info(invitation_token, opts \\ [])

Get Claim Info

customer_seats_list_seats(opts \\ [])

List Seats

customer_seats_resend_invitation(seat_id, opts \\ [])

Resend Invitation

customer_seats_revoke_seat(seat_id, opts \\ [])

Revoke Seat

Functions

customer_seats_assign_seat(body, opts \\ [])

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

Assign Seat

Scopes: customer_seats:write

customer_seats_claim_seat(body, opts \\ [])

@spec customer_seats_claim_seat(
  Polarex.SeatClaim.t(),
  keyword()
) ::
  {:ok, Polarex.CustomerSeatClaimResponse.t()}
  | {:error, Polarex.HTTPValidationError.t()}

Claim Seat

customer_seats_get_claim_info(invitation_token, opts \\ [])

@spec customer_seats_get_claim_info(
  String.t(),
  keyword()
) ::
  {:ok, Polarex.SeatClaimInfo.t()} | {:error, Polarex.HTTPValidationError.t()}

Get Claim Info

customer_seats_list_seats(opts \\ [])

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

List Seats

Scopes: customer_seats:write

Options

  • subscription_id
  • order_id

customer_seats_resend_invitation(seat_id, opts \\ [])

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

Resend Invitation

Scopes: customer_seats:write

customer_seats_revoke_seat(seat_id, opts \\ [])

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

Revoke Seat

Scopes: customer_seats:write