Class: Stripe::Radar::ValueListService

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

Defined Under Namespace

Classes: CreateParams, DeleteParams, ListParams, RetrieveParams, UpdateParams

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.



111
112
113
114
115
116
117
118
119
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 111

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.



122
123
124
125
126
127
128
129
130
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 122

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.



133
134
135
136
137
138
139
140
141
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 133

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.



144
145
146
147
148
149
150
151
152
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 144

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.



155
156
157
158
159
160
161
162
163
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 155

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