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/radar__value_list.ex
defmodule Stripe.Radar.ValueList do
use Stripe.Entity
@moduledoc "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)"
(
defstruct [
:alias,
:created,
:created_by,
:id,
:item_type,
:list_items,
:livemode,
:metadata,
:name,
:object
]
@typedoc "The `radar.value_list` type.\n\n * `alias` The name of the value list for use in rules.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `created_by` The name or email address of the user who created this value list.\n * `id` Unique identifier for the object.\n * `item_type` The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`.\n * `list_items` List of items contained within this value list.\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 * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` The name of the value list.\n * `object` String representing the object's type. Objects of the same type share the same value.\n"
@type t :: %__MODULE__{
alias: binary,
created: integer,
created_by: binary,
id: binary,
item_type: binary,
list_items: term,
livemode: boolean,
metadata: term,
name: binary,
object: binary
}
)
(
@typedoc nil
@type created :: %{
optional(:gt) => integer,
optional(:gte) => integer,
optional(:lt) => integer,
optional(:lte) => integer
}
)
(
nil
@doc "<p>Deletes a <code>ValueList</code> object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.</p>\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/radar/value_lists/{value_list}`\n"
(
@spec delete(value_list :: binary(), opts :: Keyword.t()) ::
{:ok, Stripe.DeletedRadar.ValueList.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def delete(value_list, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/radar/value_lists/{value_list}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "value_list",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "value_list",
properties: [],
title: nil,
type: "string"
}
}
],
[value_list]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_method(:delete)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "<p>Returns a list of <code>ValueList</code> 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/radar/value_lists`\n"
(
@spec list(
params :: %{
optional(:alias) => binary,
optional(:contains) => binary,
optional(:created) => created | integer,
optional(:ending_before) => binary,
optional(:expand) => list(binary),
optional(:limit) => integer,
optional(:starting_after) => binary
},
opts :: Keyword.t()
) ::
{:ok, Stripe.List.t(Stripe.Radar.ValueList.t())}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def list(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/radar/value_lists", [], [])
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 <code>ValueList</code> object.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/radar/value_lists/{value_list}`\n"
(
@spec retrieve(
value_list :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.Radar.ValueList.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def retrieve(value_list, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/radar/value_lists/{value_list}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "value_list",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "value_list",
properties: [],
title: nil,
type: "string"
}
}
],
[value_list]
)
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>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/radar/value_lists`\n"
(
@spec create(
params :: %{
optional(:alias) => binary,
optional(:expand) => list(binary),
optional(:item_type) =>
:card_bin
| :card_fingerprint
| :case_sensitive_string
| :country
| :customer_id
| :email
| :ip_address
| :sepa_debit_fingerprint
| binary
| :us_bank_account_fingerprint,
optional(:metadata) => %{optional(binary) => binary},
optional(:name) => binary
},
opts :: Keyword.t()
) ::
{:ok, Stripe.Radar.ValueList.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def create(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/radar/value_lists", [], [])
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
)
)
(
nil
@doc "<p>Updates a <code>ValueList</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that <code>item_type</code> is immutable.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/radar/value_lists/{value_list}`\n"
(
@spec update(
value_list :: binary(),
params :: %{
optional(:alias) => binary,
optional(:expand) => list(binary),
optional(:metadata) => %{optional(binary) => binary},
optional(:name) => binary
},
opts :: Keyword.t()
) ::
{:ok, Stripe.Radar.ValueList.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def update(value_list, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/radar/value_lists/{value_list}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "value_list",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "value_list",
properties: [],
title: nil,
type: "string"
}
}
],
[value_list]
)
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