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

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

create(params, opts \\ [])

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

delete(id, opts \\ [])

Specs

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

Delete an account.

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

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.

retrieve(id, opts \\ [])

Specs

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

Retrieve a location 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(: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.