Stripe.Terminal.Location (stripity_stripe v2.17.2) View Source
A Location represents a grouping of readers.
You can:
Link to this section Summary
Functions
Create a new Location
Delete an account.
List all locations.
Retrieve a location with a specified id
.
Update a location.
Link to this section Types
Specs
t() :: %Stripe.Terminal.Location{ address: Stripe.Types.address(), display_name: String.t(), id: Stripe.id(), livemode: boolean(), metadata: Stripe.Types.metadata(), object: String.t() }
Link to this section Functions
Specs
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ :address => Stripe.Types.address(), :display_name => String.t(), optional(:metadata) => Stripe.Types.metadata() } | %{}
Create a new Location
Specs
delete(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Delete an account.
Specs
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id() }
List all locations.
Specs
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a location with a specified id
.
Specs
update(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:default_currency) => Stripe.Types.address(), optional(:display_name) => String.t(), optional(:metadata) => Stripe.Types.metadata() }
Update a location.
Takes the id
and a map of changes.