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.



127
128
129
130
131
132
133
134
135
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 127

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.



138
139
140
141
142
143
144
145
146
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 138

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.



149
150
151
152
153
154
155
156
157
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 149

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.



160
161
162
163
164
165
166
167
168
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 160

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.



171
172
173
174
175
176
177
178
179
 
# File 'lib/stripe/services/radar/value_list_service.rb', line 171

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