Striped v0.5.0

View Source Stripe.Radar.ValueListItem (Striped v0.5.0) (generated)

Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.

Related guide: Managing List Items.

Link to this section Summary

Types

created()
t()

The radar.value_list_item type.

Functions

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

Creates a new ValueListItem object, which is added to the specified parent value list.

delete(client, item, opts \\ [])

Deletes a ValueListItem object, removing it from its parent value list.

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

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

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

Retrieves a ValueListItem object.

Link to this section Types

Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

t()

View Source 
@type t() :: %Stripe.Radar.ValueListItem{
  created: integer(),
  created_by: binary(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  value: binary(),
  value_list: binary()
}

The radar.value_list_item type.

  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • created_by The name or email address of the user who added this item to the value list.
  • 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.
  • object String representing the object's type. Objects of the same type share the same value.
  • value The value of the item.
  • value_list The identifier of the value list this item belongs to.

Link to this section Functions

Link to this function

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

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

Creates a new ValueListItem object, which is added to the specified parent value list.

Details

  • Method: post
  • Path: /v1/radar/value_list_items
Link to this function

delete(client, item, opts \\ [])

View Source 
@spec delete(client :: Stripe.t(), item :: binary(), opts :: Keyword.t()) ::
  {:ok, Stripe.DeletedRadar.ValueListItem.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Deletes a ValueListItem object, removing it from its parent value list.

Details

  • Method: delete
  • Path: /v1/radar/value_list_items/{item}
Link to this function

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

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

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Details

  • Method: get
  • Path: /v1/radar/value_list_items
Link to this function

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

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

Retrieves a ValueListItem object.

Details

  • Method: get
  • Path: /v1/radar/value_list_items/{item}