Stripe.Terminal.Reader (stripity_stripe v2.17.3) View Source

t() :: %Stripe.Terminal.Reader{
  device_sw_version: String.t(),
  device_type: String.t(),
  id: Stripe.id(),
  ip_address: String.t(),
  label: String.t(),
  livemode: boolean(),
  location: String.t(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  serial_number: String.t(),
  status: String.t()
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         :registration_code => String.t(),
         optional(:label) => String.t(),
         optional(:location) => Stripe.id(),
         optional(:metadata) => Stripe.Types.metadata()
       }
       | %{}

Create a new reader

delete(id, opts \\ [])

Specs

delete(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Delete an reader.

list(params \\ %{}, opts \\ [])

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       optional(:device_type) => String.t(),
       optional(:location) => t() | Stripe.id(),
       optional(:status) => String.t(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all readers.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a reader with a specified id.

update(id, params, opts \\ [])

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:label) => String.t(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Update a reader.

Takes the id and a map of changes.