View Source ExOAPI.Stripe.SDK.Radar (exoapi_stripe v0.1.1)

Link to this section Summary

Functions

description: <p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p>

description: <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>

description: <p>Returns a list of early fraud warnings.</p>

description: <p>Retrieves the details of an early fraud warning that has previously been created. </p>

description: <p>Returns a list of <code>ValueListItem</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves a <code>ValueListItem</code> object.</p>

description: <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>

description: <p>Retrieves a <code>ValueList</code> object.</p>

description: <p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p>

description: <p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p>

description: <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>

Link to this section Types

Link to this type

get_radar_early_fraud_warnings_early_fraud_warning_opts()

View Source
@type get_radar_early_fraud_warnings_early_fraud_warning_opts() ::
  {:expand, String.t()}
Link to this type

get_radar_early_fraud_warnings_opts()

View Source
@type get_radar_early_fraud_warnings_opts() ::
  {:starting_after, String.t()}
  | {:payment_intent, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:charge, String.t()}
Link to this type

get_radar_value_list_items_item_opts()

View Source
@type get_radar_value_list_items_item_opts() :: {:expand, String.t()}
Link to this type

get_radar_value_list_items_opts()

View Source
@type get_radar_value_list_items_opts() ::
  {:value, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
Link to this type

get_radar_value_lists_opts()

View Source
@type get_radar_value_lists_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:contains, String.t()}
  | {:alias, String.t()}
Link to this type

get_radar_value_lists_value_list_opts()

View Source
@type get_radar_value_lists_value_list_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

delete_radar_value_list_items_item(client, body, item)

View Source
@spec delete_radar_value_list_items_item(
  client :: ExOAPI.Client.t(),
  body :: map(),
  item :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p>

Link to this function

delete_radar_value_lists_value_list(client, body, value_list)

View Source
@spec delete_radar_value_lists_value_list(
  client :: ExOAPI.Client.t(),
  body :: map(),
  value_list :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <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>

Link to this function

get_radar_early_fraud_warnings(client, opts \\ [])

View Source
@spec get_radar_early_fraud_warnings(client :: ExOAPI.Client.t(), [
  get_radar_early_fraud_warnings_opts()
]) :: {:ok, any()} | {:error, any()}

description: <p>Returns a list of early fraud warnings.</p>

Link to this function

get_radar_early_fraud_warnings_early_fraud_warning(client, early_fraud_warning, opts \\ [])

View Source
@spec get_radar_early_fraud_warnings_early_fraud_warning(
  client :: ExOAPI.Client.t(),
  early_fraud_warning :: String.t(),
  [get_radar_early_fraud_warnings_early_fraud_warning_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves the details of an early fraud warning that has previously been created. </p>

Please refer to the early fraud warning object reference for more details.

Link to this function

get_radar_value_list_items(client, value_list, opts \\ [])

View Source
@spec get_radar_value_list_items(
  client :: ExOAPI.Client.t(),
  value_list :: String.t(),
  [get_radar_value_list_items_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Returns a list of <code>ValueListItem</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

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

View Source
@spec get_radar_value_list_items_item(
  client :: ExOAPI.Client.t(),
  item :: String.t(),
  [get_radar_value_list_items_item_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves a <code>ValueListItem</code> object.</p>

Link to this function

get_radar_value_lists(client, opts \\ [])

View Source
@spec get_radar_value_lists(client :: ExOAPI.Client.t(), [
  get_radar_value_lists_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <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>

Link to this function

get_radar_value_lists_value_list(client, value_list, opts \\ [])

View Source
@spec get_radar_value_lists_value_list(
  client :: ExOAPI.Client.t(),
  value_list :: String.t(),
  [get_radar_value_lists_value_list_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves a <code>ValueList</code> object.</p>

Link to this function

post_radar_value_list_items(client, body)

View Source
@spec post_radar_value_list_items(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p>

Link to this function

post_radar_value_lists(client, body)

View Source
@spec post_radar_value_lists(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p>

Link to this function

post_radar_value_lists_value_list(client, body, value_list)

View Source
@spec post_radar_value_lists_value_list(
  client :: ExOAPI.Client.t(),
  body :: map(),
  value_list :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <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>