Packages
stripity_stripe
3.3.1
3.3.2
3.3.1
3.2.0
3.1.1
3.1.0
3.0.0
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.1
2.15.0
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.3
2.2.2
2.2.1
2.2.0
2.1.0
2.0.1
2.0.0
2.0.0-alpha.11
2.0.0-alpha.10
2.0.0-alpha.9
2.0.0-alpha.8
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.6.2
1.6.1
1.6.0
1.4.0
1.3.0
1.2.0
1.1.0
0.5.0
0.4.0
0.3.0
0.2.0
A Stripe client for Elixir.
Current section
Files
Jump to
Current section
Files
lib/generated/issuing__token.ex
defmodule Stripe.Issuing.Token do
use Stripe.Entity
@moduledoc "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe."
(
defstruct [
:card,
:created,
:device_fingerprint,
:id,
:last4,
:livemode,
:network,
:network_data,
:network_updated_at,
:object,
:status,
:wallet_provider
]
@typedoc "The `issuing.token` type.\n\n * `card` Card associated with this token.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `device_fingerprint` The hashed ID derived from the device ID from the card network associated with the token.\n * `id` Unique identifier for the object.\n * `last4` The last four digits of the token.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `network` The token service provider / card network associated with the token.\n * `network_data` \n * `network_updated_at` Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The usage state of the token.\n * `wallet_provider` The digital wallet for this token, if one was used.\n"
@type t :: %__MODULE__{
card: binary | Stripe.Issuing.Card.t(),
created: integer,
device_fingerprint: binary | nil,
id: binary,
last4: binary,
livemode: boolean,
network: binary,
network_data: term,
network_updated_at: integer,
object: binary,
status: binary,
wallet_provider: binary
}
)
(
@typedoc nil
@type created :: %{
optional(:gt) => integer,
optional(:gte) => integer,
optional(:lt) => integer,
optional(:lte) => integer
}
)
(
nil
@doc "<p>Lists all Issuing <code>Token</code> objects for a given card.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/tokens`\n"
(
@spec list(
params :: %{
optional(:card) => binary,
optional(:created) => created | integer,
optional(:ending_before) => binary,
optional(:expand) => list(binary),
optional(:limit) => integer,
optional(:starting_after) => binary,
optional(:status) => :active | :deleted | :requested | :suspended
},
opts :: Keyword.t()
) ::
{:ok, Stripe.List.t(Stripe.Issuing.Token.t())}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def list(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/tokens", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "<p>Retrieves an Issuing <code>Token</code> object.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/tokens/{token}`\n"
(
@spec retrieve(
token :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.Issuing.Token.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def retrieve(token, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/issuing/tokens/{token}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "token",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "token",
properties: [],
title: nil,
type: "string"
}
}
],
[token]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "<p>Attempts to update the specified Issuing <code>Token</code> object to the status specified.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/tokens/{token}`\n"
(
@spec update(
token :: binary(),
params :: %{
optional(:expand) => list(binary),
optional(:status) => :active | :deleted | :suspended
},
opts :: Keyword.t()
) ::
{:ok, Stripe.Issuing.Token.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def update(token, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/issuing/tokens/{token}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "token",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "token",
properties: [],
title: nil,
type: "string"
}
}
],
[token]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
end