Class: OpenapiClient::SubscribeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/subscribe_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscribeApi

Returns a new instance of SubscribeApi.



19
20
21
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_subscription(subscription_id, opts = {}) ⇒ SubscriptionResponse

Gets a specific subscription using a subscription Id passed as in the path

Parameters:

  • subscription_id (String) —

    Unique identifier of a particular subscription (UUID Version 4)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 26

def get_subscription(subscription_id, opts = {})
  data, _status_code, _headers = get_subscription_with_http_info(subscription_id, opts)
  data
end

#get_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(SubscriptionResponse, Integer, Hash)>

Gets a specific subscription using a subscription Id passed as in the path

Parameters:

  • subscription_id (String) —

    Unique identifier of a particular subscription (UUID Version 4)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SubscriptionResponse, Integer, Hash)>) —

    SubscriptionResponse data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 35

def get_subscription_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribeApi.get_subscription ...'
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscribeApi.get_subscription"
  end
  # resource path
  local_var_path = '/subscriptions/{subscription_id}'.sub('{' + 'subscription_id' + '}', subscription_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'SubscriptionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribeApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_subscriptions(opts = {}) ⇒ Array<ActiveSubscription>

gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Can be used to limit the amount of results returned from a query (Pagination)

  • :offset (Integer) —

    The number of items to offset the start of the list from (Pagination)

Returns:



87
88
89
90
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 87

def list_subscriptions(opts = {})
  data, _status_code, _headers = list_subscriptions_with_http_info(opts)
  data
end

#list_subscriptions_with_http_info(opts = {}) ⇒ Array<(Array<ActiveSubscription>, Integer, Hash)>

gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Can be used to limit the amount of results returned from a query (Pagination)

  • :offset (Integer) —

    The number of items to offset the start of the list from (Pagination)

Returns:

  • (Array<(Array<ActiveSubscription>, Integer, Hash)>) —

    Array<ActiveSubscription> data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 97

def list_subscriptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribeApi.list_subscriptions ...'
  end
  # resource path
  local_var_path = '/subscriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<ActiveSubscription>' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribeApi#list_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subscribe(request_body, opts = {}) ⇒ Array<SubscriptionResponse>

Allows the user to subscribe to a particular location and receive updates on e-commerce spending in their chosen area. The user can pay for the subscription on a daily basis. The user is charged for every report they receive until their subscription is cancelled

Parameters:

  • request_body (Hash<String, SubscriptionObject>) —

    Request body required to create a particular subscription

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 146

def subscribe(request_body, opts = {})
  data, _status_code, _headers = subscribe_with_http_info(request_body, opts)
  data
end

#subscribe_with_http_info(request_body, opts = {}) ⇒ Array<(Array<SubscriptionResponse>, Integer, Hash)>

Allows the user to subscribe to a particular location and receive updates on e-commerce spending in their chosen area. The user can pay for the subscription on a daily basis. The user is charged for every report they receive until their subscription is cancelled

Parameters:

  • request_body (Hash<String, SubscriptionObject>) —

    Request body required to create a particular subscription

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<SubscriptionResponse>, Integer, Hash)>) —

    Array<SubscriptionResponse> data, response status code and response headers



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 155

def subscribe_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribeApi.subscribe ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling SubscribeApi.subscribe"
  end
  # resource path
  local_var_path = '/subscriptions'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(request_body) 

  # return_type
  return_type = opts[:return_type] || 'Array<SubscriptionResponse>' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribeApi#subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unsubscribe(subscription_id, opts = {}) ⇒ UnsubscribedResponse

Un-subscribes from a specified subcription

Parameters:

  • subscription_id (String) —

    Unique identifier of a particular subscription (Version 4 UUID)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



208
209
210
211
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 208

def unsubscribe(subscription_id, opts = {})
  data, _status_code, _headers = unsubscribe_with_http_info(subscription_id, opts)
  data
end

#unsubscribe_with_http_info(subscription_id, opts = {}) ⇒ Array<(UnsubscribedResponse, Integer, Hash)>

Un-subscribes from a specified subcription

Parameters:

  • subscription_id (String) —

    Unique identifier of a particular subscription (Version 4 UUID)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UnsubscribedResponse, Integer, Hash)>) —

    UnsubscribedResponse data, response status code and response headers



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 217

def unsubscribe_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribeApi.unsubscribe ...'
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscribeApi.unsubscribe"
  end
  # resource path
  local_var_path = '/subscriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subscription_id'] = subscription_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'UnsubscribedResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribeApi#unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_subscription(subscription_id, subscription_object, opts = {}) ⇒ SubscriptionResponse

Updates an active subscription

Parameters:

  • subscription_id (String) —

    Unique identifier of a particular subscription (UUID Version 4)

  • subscription_object (SubscriptionObject) —

    Request body required to update a particular subscription

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



270
271
272
273
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 270

def update_subscription(subscription_id, subscription_object, opts = {})
  data, _status_code, _headers = update_subscription_with_http_info(subscription_id, subscription_object, opts)
  data
end

#update_subscription_with_http_info(subscription_id, subscription_object, opts = {}) ⇒ Array<(SubscriptionResponse, Integer, Hash)>

Updates an active subscription

Parameters:

  • subscription_id (String) —

    Unique identifier of a particular subscription (UUID Version 4)

  • subscription_object (SubscriptionObject) —

    Request body required to update a particular subscription

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SubscriptionResponse, Integer, Hash)>) —

    SubscriptionResponse data, response status code and response headers



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/openapi_client/api/subscribe_api.rb', line 280

def update_subscription_with_http_info(subscription_id, subscription_object, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribeApi.update_subscription ...'
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscribeApi.update_subscription"
  end
  # verify the required parameter 'subscription_object' is set
  if @api_client.config.client_side_validation && subscription_object.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_object' when calling SubscribeApi.update_subscription"
  end
  # resource path
  local_var_path = '/subscriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subscription_id'] = subscription_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(subscription_object) 

  # return_type
  return_type = opts[:return_type] || 'SubscriptionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribeApi#update_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end