Packages
stripity_stripe
3.3.2
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__physical_bundle.ex
defmodule Stripe.Issuing.PhysicalBundle do
use Stripe.Entity
@moduledoc "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card."
(
defstruct [:features, :id, :livemode, :name, :object, :status, :type]
@typedoc "The `issuing.physical_bundle` type.\n\n * `features` \n * `id` Unique identifier for the object.\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 * `name` Friendly display name.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` Whether this physical bundle can be used to create cards.\n * `type` Whether this physical bundle is a standard Stripe offering or custom-made for you.\n"
@type t :: %__MODULE__{
features: term,
id: binary,
livemode: boolean,
name: binary,
object: binary,
status: binary,
type: binary
}
)
(
nil
@doc "<p>Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/physical_bundles`\n"
(
@spec list(
params :: %{
optional(:ending_before) => binary,
optional(:expand) => list(binary),
optional(:limit) => integer,
optional(:starting_after) => binary,
optional(:status) => :active | :inactive | :review,
optional(:type) => :custom | :standard
},
opts :: Keyword.t()
) ::
{:ok, Stripe.List.t(Stripe.Issuing.PhysicalBundle.t())}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def list(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/physical_bundles", [], [])
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 a physical bundle object.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/physical_bundles/{physical_bundle}`\n"
(
@spec retrieve(
physical_bundle :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.Issuing.PhysicalBundle.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def retrieve(physical_bundle, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/issuing/physical_bundles/{physical_bundle}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "physical_bundle",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "physical_bundle",
properties: [],
title: nil,
type: "string"
}
}
],
[physical_bundle]
)
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
)
)
end