stripity_stripe
v3.1.1

View Source Stripe.Terminal.Location (stripity_stripe v3.1.1)

A Location represents a grouping of readers.

Related guide: Fleet management

Link to this section Summary

Types

address()

The full address of the location.

t()

The terminal.location type.

Functions

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

Creates a new Location object.For further details, including which address fields are required in each country, see the Manage locations guide.

delete(location, opts \\ [])

Deletes a Location object.

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

Returns a list of Location objects.

retrieve(location, params \\ %{}, opts \\ [])

Retrieves a Location object.

update(location, params \\ %{}, opts \\ [])

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Link to this section Types

Link to this type

address()

View Source 
@type address() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary()
}

The full address of the location.

Link to this type

t()

View Source 
@type t() :: %Stripe.Terminal.Location{
  address: term(),
  configuration_overrides: binary(),
  display_name: binary(),
  id: binary(),
  livemode: boolean(),
  metadata: term(),
  object: binary()
}

The terminal.location type.

  • address
  • configuration_overrides The ID of a configuration that will be used to customize all readers in this location.
  • display_name The display name of the location.
  • id Unique identifier for the object.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  • object String representing the object's type. Objects of the same type share the same value.

Link to this section Functions

Link to this function

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

View Source 
@spec create(
  params :: %{
    optional(:address) => address(),
    optional(:configuration_overrides) => binary(),
    optional(:display_name) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a new Location object.For further details, including which address fields are required in each country, see the Manage locations guide.

#### Details * Method: `post` * Path: `/v1/terminal/locations`

Link to this function

delete(location, opts \\ [])

View Source 
@spec delete(location :: binary(), opts :: Keyword.t()) ::
  {:ok, Stripe.DeletedTerminal.Location.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Deletes a Location object.

Details

  • Method: delete
  • Path: /v1/terminal/locations/{location}
Link to this function

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

View Source 
@spec list(
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of Location objects.

Details

  • Method: get
  • Path: /v1/terminal/locations
Link to this function

retrieve(location, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  location :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) ::
  {:ok, t() | Stripe.DeletedTerminal.Location.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Retrieves a Location object.

Details

  • Method: get
  • Path: /v1/terminal/locations/{location}
Link to this function

update(location, params \\ %{}, opts \\ [])

View Source 
@spec update(
  location :: binary(),
  params :: %{
    optional(:address) => address(),
    optional(:configuration_overrides) => binary() | binary(),
    optional(:display_name) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, t() | Stripe.DeletedTerminal.Location.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Details

  • Method: post
  • Path: /v1/terminal/locations/{location}