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/climate__supplier.ex
defmodule Stripe.Climate.Supplier do
use Stripe.Entity
@moduledoc "A supplier of carbon removal."
(
defstruct [:id, :info_url, :livemode, :locations, :name, :object, :removal_pathway]
@typedoc "The `climate.supplier` type.\n\n * `id` Unique identifier for the object.\n * `info_url` Link to a webpage to learn more about the supplier.\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 * `locations` The locations in which this supplier operates.\n * `name` Name of this carbon removal supplier.\n * `object` String representing the object’s type. Objects of the same type share the same value.\n * `removal_pathway` The scientific pathway used for carbon removal.\n"
@type t :: %__MODULE__{
id: binary,
info_url: binary,
livemode: boolean,
locations: term,
name: binary,
object: binary,
removal_pathway: binary
}
)
(
nil
@doc "<p>Lists all available Climate supplier objects.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/suppliers`\n"
(
@spec list(
params :: %{
optional(:ending_before) => binary,
optional(:expand) => list(binary),
optional(:limit) => integer,
optional(:starting_after) => binary
},
opts :: Keyword.t()
) ::
{:ok, Stripe.List.t(Stripe.Climate.Supplier.t())}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def list(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/suppliers", [], [])
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 Climate supplier object.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/suppliers/{supplier}`\n"
(
@spec retrieve(
supplier :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.Climate.Supplier.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def retrieve(supplier, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/climate/suppliers/{supplier}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "supplier",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "supplier",
properties: [],
title: nil,
type: "string"
}
}
],
[supplier]
)
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