class Stripe::RadarApi
- Stripe::RadarApi
- Reference
- Object
Defined in:
stripe/api/radar_api.crConstant Summary
-
DELETE_RADAR_VALUE_LIST_ITEMS_ITEM_MAX_LENGTH_FOR_ITEM =
5000
-
DELETE_RADAR_VALUE_LISTS_VALUE_LIST_MAX_LENGTH_FOR_VALUE_LIST =
5000
-
GET_RADAR_EARLY_FRAUD_WARNINGS_EARLY_FRAUD_WARNING_MAX_LENGTH_FOR_EARLY_FRAUD_WARNING =
5000
-
GET_RADAR_EARLY_FRAUD_WARNINGS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_RADAR_EARLY_FRAUD_WARNINGS_MAX_LENGTH_FOR_PAYMENT_INTENT =
5000
-
GET_RADAR_EARLY_FRAUD_WARNINGS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_RADAR_VALUE_LIST_ITEMS_ITEM_MAX_LENGTH_FOR_ITEM =
5000
-
GET_RADAR_VALUE_LIST_ITEMS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_RADAR_VALUE_LIST_ITEMS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_RADAR_VALUE_LIST_ITEMS_MAX_LENGTH_FOR_VALUE =
800
-
GET_RADAR_VALUE_LIST_ITEMS_MAX_LENGTH_FOR_VALUE_LIST =
5000
-
GET_RADAR_VALUE_LISTS_MAX_LENGTH_FOR__ALIAS =
100
-
GET_RADAR_VALUE_LISTS_MAX_LENGTH_FOR_CONTAINS =
800
-
GET_RADAR_VALUE_LISTS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_RADAR_VALUE_LISTS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_RADAR_VALUE_LISTS_VALUE_LIST_MAX_LENGTH_FOR_VALUE_LIST =
5000
-
POST_RADAR_VALUE_LIST_ITEMS_MAX_LENGTH_FOR_VALUE =
800
-
POST_RADAR_VALUE_LIST_ITEMS_MAX_LENGTH_FOR_VALUE_LIST =
5000
-
POST_RADAR_VALUE_LISTS_MAX_LENGTH_FOR__ALIAS =
100
-
POST_RADAR_VALUE_LISTS_MAX_LENGTH_FOR_ITEM_TYPE =
5000
-
POST_RADAR_VALUE_LISTS_MAX_LENGTH_FOR_NAME =
100
-
POST_RADAR_VALUE_LISTS_VALID_VALUES_FOR_ITEM_TYPE =
String.static_array("card_bin", "card_fingerprint", "case_sensitive_string", "country", "customer_id", "email", "ip_address", "sepa_debit_fingerprint", "string", "us_bank_account_fingerprint")
-
POST_RADAR_VALUE_LISTS_VALUE_LIST_MAX_LENGTH_FOR__ALIAS =
100
-
POST_RADAR_VALUE_LISTS_VALUE_LIST_MAX_LENGTH_FOR_NAME =
100
-
POST_RADAR_VALUE_LISTS_VALUE_LIST_MAX_LENGTH_FOR_VALUE_LIST =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_delete_radar_value_list_items_item(*, item : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_radar_value_lists_value_list(*, value_list : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_radar_early_fraud_warnings(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_radar_early_fraud_warnings_early_fraud_warning(*, early_fraud_warning : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_radar_value_list_items(*, value_list : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, value : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_radar_value_list_items_item(*, item : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_radar_value_lists(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, contains : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, _alias : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_radar_value_lists_value_list(*, value_list : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_radar_value_list_items(*, value : String | Nil = nil, value_list : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_radar_value_lists(*, _alias : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, item_type : String | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_radar_value_lists_value_list(*, value_list : String | Nil = nil, _alias : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, name : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_radar_value_list_items_item(*, item : String | Nil = nil) : Stripe::DeletedRadarValueListItem
Deletes a
@required @param item [String?] @return [Stripe::DeletedRadarValueListItem]ValueListItem
object, removing it from its parent value list. -
#delete_radar_value_list_items_item(*, item : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p> @required @param item [String?] @return nil
-
#delete_radar_value_list_items_item_with_http_info(*, item : String | Nil = nil) : Tuple(Stripe::DeletedRadarValueListItem, Int32, Hash(String, Array(String) | String))
<p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p> @required @param item [String?] @return [Tuple(Stripe::DeletedRadarValueListItem, Integer, Hash)] Stripe::DeletedRadarValueListItem, response status code and response headers
-
#delete_radar_value_lists_value_list(*, value_list : String | Nil = nil) : Stripe::DeletedRadarValueList
Deletes a
ValueList
object, also deleting any items contained within the value list. -
#delete_radar_value_lists_value_list(*, value_list : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deletes a <code>ValueList</code> object, also deleting any items contained within the value list.
-
#delete_radar_value_lists_value_list_with_http_info(*, value_list : String | Nil = nil) : Tuple(Stripe::DeletedRadarValueList, Int32, Hash(String, Array(String) | String))
<p>Deletes a <code>ValueList</code> object, also deleting any items contained within the value list.
-
#get_radar_early_fraud_warnings(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::RadarEarlyFraudWarningList
Returns a list of early fraud warnings.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_radar_early_fraud_warnings(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of early fraud warnings.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_radar_early_fraud_warnings_early_fraud_warning(*, early_fraud_warning : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::RadarEarlyFraudWarning
Retrieves the details of an early fraud warning that has previously been created.
-
#get_radar_early_fraud_warnings_early_fraud_warning(*, early_fraud_warning : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the details of an early fraud warning that has previously been created.
-
#get_radar_early_fraud_warnings_early_fraud_warning_with_http_info(*, early_fraud_warning : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::RadarEarlyFraudWarning, Int32, Hash(String, Array(String) | String))
<p>Retrieves the details of an early fraud warning that has previously been created.
-
#get_radar_early_fraud_warnings_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::RadarEarlyFraudWarningList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of early fraud warnings.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_radar_value_list_items(*, value_list : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, value : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::RadarListListItemList
Returns a list of
ValueListItem
objects. -
#get_radar_value_list_items(*, value_list : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, value : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of <code>ValueListItem</code> objects.
-
#get_radar_value_list_items_item(*, item : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::RadarValueListItem
Retrieves a
@required @param item [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.ValueListItem
object. -
#get_radar_value_list_items_item(*, item : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a <code>ValueListItem</code> object.</p> @required @param item [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_radar_value_list_items_item_with_http_info(*, item : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::RadarValueListItem, Int32, Hash(String, Array(String) | String))
<p>Retrieves a <code>ValueListItem</code> object.</p> @required @param item [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_radar_value_list_items_with_http_info(*, value_list : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, value : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::RadarListListItemList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of <code>ValueListItem</code> objects.
-
#get_radar_value_lists(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, contains : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, _alias : String | Nil = nil) : Stripe::RadarListListList
Returns a list of
ValueList
objects. -
#get_radar_value_lists(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, contains : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, _alias : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of <code>ValueList</code> objects.
-
#get_radar_value_lists_value_list(*, value_list : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::RadarValueList
Retrieves a
@required @param value_list [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.ValueList
object. -
#get_radar_value_lists_value_list(*, value_list : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a <code>ValueList</code> object.</p> @required @param value_list [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_radar_value_lists_value_list_with_http_info(*, value_list : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::RadarValueList, Int32, Hash(String, Array(String) | String))
<p>Retrieves a <code>ValueList</code> object.</p> @required @param value_list [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_radar_value_lists_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, contains : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, _alias : String | Nil = nil) : Tuple(Stripe::RadarListListList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of <code>ValueList</code> objects.
-
#post_radar_value_list_items(*, value : String | Nil = nil, value_list : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::RadarValueListItem
Creates a new
@required @param value [String?] The value of the item (whose type must match the type of the parent value list).ValueListItem
object, which is added to the specified parent value list. -
#post_radar_value_list_items(*, value : String | Nil = nil, value_list : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p> @required @param value [String?] The value of the item (whose type must match the type of the parent value list).
-
#post_radar_value_list_items_with_http_info(*, value : String | Nil = nil, value_list : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::RadarValueListItem, Int32, Hash(String, Array(String) | String))
<p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p> @required @param value [String?] The value of the item (whose type must match the type of the parent value list).
-
#post_radar_value_lists(*, _alias : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, item_type : String | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Stripe::RadarValueList
Creates a new
@required @param _alias [String?] The name of the value list for use in rules.ValueList
object, which can then be referenced in rules. -
#post_radar_value_lists(*, _alias : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, item_type : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p> @required @param _alias [String?] The name of the value list for use in rules.
-
#post_radar_value_lists_value_list(*, value_list : String | Nil = nil, _alias : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, name : String | Nil = nil) : Stripe::RadarValueList
Updates a
ValueList
object by setting the values of the parameters passed. -
#post_radar_value_lists_value_list(*, value_list : String | Nil = nil, _alias : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, name : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates a <code>ValueList</code> object by setting the values of the parameters passed.
-
#post_radar_value_lists_value_list_with_http_info(*, value_list : String | Nil = nil, _alias : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, name : String | Nil = nil) : Tuple(Stripe::RadarValueList, Int32, Hash(String, Array(String) | String))
<p>Updates a <code>ValueList</code> object by setting the values of the parameters passed.
-
#post_radar_value_lists_with_http_info(*, _alias : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, item_type : String | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Tuple(Stripe::RadarValueList, Int32, Hash(String, Array(String) | String))
<p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p> @required @param _alias [String?] The name of the value list for use in rules.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Deletes a ValueListItem
object, removing it from its parent value list.
<p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p> @required @param item [String?] @return nil
<p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p> @required @param item [String?] @return [Tuple(Stripe::DeletedRadarValueListItem, Integer, Hash)] Stripe::DeletedRadarValueListItem, response status code and response headers
Deletes a ValueList
object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
<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> @required @param value_list [String?] @return nil
<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> @required @param value_list [String?] @return [Tuple(Stripe::DeletedRadarValueList, Integer, Hash)] Stripe::DeletedRadarValueList, response status code and response headers
Returns a list of early fraud warnings.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param payment_intent [String?] Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. @optional @param charge [String?] Only return early fraud warnings for the charge specified by this charge ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return early fraud warnings that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::RadarEarlyFraudWarningList]<p>Returns a list of early fraud warnings.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param payment_intent [String?] Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
@optional @param charge [String?] Only return early fraud warnings for the charge specified by this charge ID.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return early fraud warnings that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of an early fraud warning that has previously been created.
Please refer to the early fraud warning object reference for more details.
@required @param early_fraud_warning [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::RadarEarlyFraudWarning]<p>Retrieves the details of an early fraud warning that has previously been created. </p> <p>Please refer to the <a href="#early_fraud_warning_object">early fraud warning</a> object reference for more details.</p> @required @param early_fraud_warning [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of an early fraud warning that has previously been created. </p> <p>Please refer to the <a href="#early_fraud_warning_object">early fraud warning</a> object reference for more details.</p> @required @param early_fraud_warning [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::RadarEarlyFraudWarning, Integer, Hash)] Stripe::RadarEarlyFraudWarning, response status code and response headers
<p>Returns a list of early fraud warnings.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param payment_intent [String?] Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
@optional @param charge [String?] Only return early fraud warnings for the charge specified by this charge ID.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return early fraud warnings that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::RadarEarlyFraudWarningList, Integer, Hash)] Stripe::RadarEarlyFraudWarningList, response status code and response headers
Returns a list of ValueListItem
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
<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>
@required @param value_list [String?] Identifier for the parent value list this item belongs to.
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return items that were created during the given date interval.
@optional @param value [String?] Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a ValueListItem
object.
<p>Retrieves a <code>ValueListItem</code> object.</p> @required @param item [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a <code>ValueListItem</code> object.</p> @required @param item [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::RadarValueListItem, Integer, Hash)] Stripe::RadarValueListItem, response status code and response headers
<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>
@required @param value_list [String?] Identifier for the parent value list this item belongs to.
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return items that were created during the given date interval.
@optional @param value [String?] Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::RadarListListItemList, Integer, Hash)] Stripe::RadarListListItemList, response status code and response headers
Returns a list of ValueList
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
<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>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param contains [String?] A value contained within a value list - returns all value lists containing this value.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return value lists that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param _alias [String?] The alias used to reference the value list when writing rules.
@return nil
Retrieves a ValueList
object.
<p>Retrieves a <code>ValueList</code> object.</p> @required @param value_list [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a <code>ValueList</code> object.</p> @required @param value_list [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::RadarValueList, Integer, Hash)] Stripe::RadarValueList, response status code and response headers
<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>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param contains [String?] A value contained within a value list - returns all value lists containing this value.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return value lists that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param _alias [String?] The alias used to reference the value list when writing rules.
@return [Tuple(Stripe::RadarListListList, Integer, Hash)] Stripe::RadarListListList, response status code and response headers
Creates a new ValueListItem
object, which is added to the specified parent value list.
<p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p> @required @param value [String?] The value of the item (whose type must match the type of the parent value list). @required @param value_list [String?] The identifier of the value list which the created item will be added to. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p> @required @param value [String?] The value of the item (whose type must match the type of the parent value list). @required @param value_list [String?] The identifier of the value list which the created item will be added to. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::RadarValueListItem, Integer, Hash)] Stripe::RadarValueListItem, response status code and response headers
Creates a new ValueList
object, which can then be referenced in rules.
<p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p>
@required @param _alias [String?] The name of the value list for use in rules.
@required @param name [String?] The human-readable name of the value list.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param item_type [String?] Type of the items in the value list. One of card_fingerprint
, us_bank_account_fingerprint
, sepa_debit_fingerprint
, card_bin
, email
, ip_address
, country
, string
, case_sensitive_string
, or customer_id
. Use string
if the item type is unknown or mixed.
@optional @param metadata [Hash(String, String)?]
@return nil
Updates a ValueList
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type
is immutable.
<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> @required @param value_list [String?] @optional @param _alias [String?] The name of the value list for use in rules. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param name [String?] The human-readable name of the value list. @return nil
<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> @required @param value_list [String?] @optional @param _alias [String?] The name of the value list for use in rules. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param name [String?] The human-readable name of the value list. @return [Tuple(Stripe::RadarValueList, Integer, Hash)] Stripe::RadarValueList, response status code and response headers
<p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p>
@required @param _alias [String?] The name of the value list for use in rules.
@required @param name [String?] The human-readable name of the value list.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param item_type [String?] Type of the items in the value list. One of card_fingerprint
, us_bank_account_fingerprint
, sepa_debit_fingerprint
, card_bin
, email
, ip_address
, country
, string
, case_sensitive_string
, or customer_id
. Use string
if the item type is unknown or mixed.
@optional @param metadata [Hash(String, String)?]
@return [Tuple(Stripe::RadarValueList, Integer, Hash)] Stripe::RadarValueList, response status code and response headers