Class: Stripe::Radar::ValueListService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/radar/value_list_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

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

Creates a new ValueList object, which can then be referenced in rules.



8
9
10
11
12
13
14
15
16
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 8

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/radar/value_lists",
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

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.



19
20
21
22
23
24
25
26
27
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 19

def delete(value_list, params = {}, opts = {})
  request(
    method: :delete,
    path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(value_list) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 30

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/radar/value_lists",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(value_list, params = {}, opts = {}) ⇒ Object

Retrieves a ValueList object.



41
42
43
44
45
46
47
48
49
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 41

def retrieve(value_list, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(value_list) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(value_list, params = {}, opts = {}) ⇒ Object

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.



52
53
54
55
56
57
58
59
60
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 52

def update(value_list, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(value_list) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end