Class: Stripe::Radar::ValueListItem

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete
Defined in:
lib/stripe/resources/radar/value_list_item.rb

Overview

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](stripe.com/docs/radar/lists#managing-list-items)

Constant Summary collapse

OBJECT_NAME = 
"radar.value_list_item"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Delete

included

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

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



20
21
22
23
24
25
26
27
 
# File 'lib/stripe/resources/radar/value_list_item.rb', line 20

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/radar/value_list_items",
    params: params,
    opts: opts
  )
end

.delete(id, params = {}, opts = {}) ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/stripe/resources/radar/value_list_item.rb', line 30

def self.delete(id, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/radar/value_list_items/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.list(filters = {}, opts = {}) ⇒ Object

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



50
51
52
53
54
55
56
57
 
# File 'lib/stripe/resources/radar/value_list_item.rb', line 50

def self.list(filters = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/radar/value_list_items",
    params: filters,
    opts: opts
  )
end

.object_name ⇒ Object 



15
16
17
 
# File 'lib/stripe/resources/radar/value_list_item.rb', line 15

def self.object_name
  "radar.value_list_item"
end

Instance Method Details

#delete(params = {}, opts = {}) ⇒ Object

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



40
41
42
43
44
45
46
47
 
# File 'lib/stripe/resources/radar/value_list_item.rb', line 40

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/radar/value_list_items/%<item>s", { item: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end