Class: ArtikCloud::SubscriptionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/artikcloud/api/subscriptions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionsApi

Returns a new instance of SubscriptionsApi.



18
19
20
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_subscription(subscription_info, opts = {}) ⇒ SubscriptionEnvelope

Create Subscription Create Subscription

Parameters:

  • subscription_info —

    Subscription details

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 27

def create_subscription(subscription_info, opts = {})
  data, _status_code, _headers = create_subscription_with_http_info(subscription_info, opts)
  return data
end

#create_subscription_with_http_info(subscription_info, opts = {}) ⇒ Array<(SubscriptionEnvelope, Fixnum, Hash)>

Create Subscription Create Subscription

Parameters:

  • subscription_info —

    Subscription details

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

    the optional parameters

Returns:

  • (Array<(SubscriptionEnvelope, Fixnum, Hash)>) —

    SubscriptionEnvelope data, response status code and response headers



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
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 37

def create_subscription_with_http_info(subscription_info, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionsApi.create_subscription ..."
  end
  # verify the required parameter 'subscription_info' is set
  fail ArgumentError, "Missing the required parameter 'subscription_info' when calling SubscriptionsApi.create_subscription" if subscription_info.nil?
  # resource path
  local_var_path = "/subscriptions".sub('{format}','json')

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(subscription_info)
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionEnvelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#create_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_subscription(sub_id, opts = {}) ⇒ SubscriptionEnvelope

Delete Subscription Delete Subscription

Parameters:

  • sub_id —

    Subscription ID.

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 78

def delete_subscription(sub_id, opts = {})
  data, _status_code, _headers = delete_subscription_with_http_info(sub_id, opts)
  return data
end

#delete_subscription_with_http_info(sub_id, opts = {}) ⇒ Array<(SubscriptionEnvelope, Fixnum, Hash)>

Delete Subscription Delete Subscription

Parameters:

  • sub_id —

    Subscription ID.

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

    the optional parameters

Returns:

  • (Array<(SubscriptionEnvelope, Fixnum, Hash)>) —

    SubscriptionEnvelope data, response status code and response headers



88
89
90
91
92
93
94
95
96
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
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 88

def delete_subscription_with_http_info(sub_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionsApi.delete_subscription ..."
  end
  # verify the required parameter 'sub_id' is set
  fail ArgumentError, "Missing the required parameter 'sub_id' when calling SubscriptionsApi.delete_subscription" if sub_id.nil?
  # resource path
  local_var_path = "/subscriptions/{subId}".sub('{format}','json').sub('{' + 'subId' + '}', sub_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionEnvelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#delete_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_subscriptions(opts = {}) ⇒ SubscriptionsEnvelope

Get All Subscriptions Get All Subscriptions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :uid (String) —

    User ID

  • :offset (Integer) —

    Offset for pagination.

  • :count (Integer) —

    Desired count of items in the result set.

Returns:



131
132
133
134
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 131

def get_all_subscriptions(opts = {})
  data, _status_code, _headers = get_all_subscriptions_with_http_info(opts)
  return data
end

#get_all_subscriptions_with_http_info(opts = {}) ⇒ Array<(SubscriptionsEnvelope, Fixnum, Hash)>

Get All Subscriptions Get All Subscriptions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :uid (String) —

    User ID

  • :offset (Integer) —

    Offset for pagination.

  • :count (Integer) —

    Desired count of items in the result set.

Returns:

  • (Array<(SubscriptionsEnvelope, Fixnum, Hash)>) —

    SubscriptionsEnvelope data, response status code and response headers



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 143

def get_all_subscriptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionsApi.get_all_subscriptions ..."
  end
  # resource path
  local_var_path = "/subscriptions".sub('{format}','json')

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionsEnvelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#get_all_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messages(notif_id, opts = {}) ⇒ NotifMessagesResponse

Get Messages Get Messages

Parameters:

  • notif_id —

    Notification ID.

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Offset for pagination.

  • :count (Integer) —

    Desired count of items in the result set.

  • :order (String) —

    Sort order of results by ts. Either &#39;asc&#39; or &#39;desc&#39;.

Returns:



188
189
190
191
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 188

def get_messages(notif_id, opts = {})
  data, _status_code, _headers = get_messages_with_http_info(notif_id, opts)
  return data
end

#get_messages_with_http_info(notif_id, opts = {}) ⇒ Array<(NotifMessagesResponse, Fixnum, Hash)>

Get Messages Get Messages

Parameters:

  • notif_id —

    Notification ID.

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Offset for pagination.

  • :count (Integer) —

    Desired count of items in the result set.

  • :order (String) —

    Sort order of results by ts. Either &#39;asc&#39; or &#39;desc&#39;.

Returns:

  • (Array<(NotifMessagesResponse, Fixnum, Hash)>) —

    NotifMessagesResponse data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 201

def get_messages_with_http_info(notif_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionsApi.get_messages ..."
  end
  # verify the required parameter 'notif_id' is set
  fail ArgumentError, "Missing the required parameter 'notif_id' when calling SubscriptionsApi.get_messages" if notif_id.nil?
  # resource path
  local_var_path = "/notifications/{notifId}/messages".sub('{format}','json').sub('{' + 'notifId' + '}', notif_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotifMessagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_subscription(sub_id, opts = {}) ⇒ SubscriptionEnvelope

Get Subscription Get Subscription

Parameters:

  • sub_id —

    Subscription ID.

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 245

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

#get_subscription_with_http_info(sub_id, opts = {}) ⇒ Array<(SubscriptionEnvelope, Fixnum, Hash)>

Get Subscription Get Subscription

Parameters:

  • sub_id —

    Subscription ID.

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

    the optional parameters

Returns:

  • (Array<(SubscriptionEnvelope, Fixnum, Hash)>) —

    SubscriptionEnvelope data, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 255

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionEnvelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_subscription(sub_id, validation_callback_request, opts = {}) ⇒ SubscriptionEnvelope

Validate Subscription Validate Subscription

Parameters:

  • sub_id —

    Subscription ID.

  • validation_callback_request —

    Subscription validation callback request

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 297

def validate_subscription(sub_id, validation_callback_request, opts = {})
  data, _status_code, _headers = validate_subscription_with_http_info(sub_id, validation_callback_request, opts)
  return data
end

#validate_subscription_with_http_info(sub_id, validation_callback_request, opts = {}) ⇒ Array<(SubscriptionEnvelope, Fixnum, Hash)>

Validate Subscription Validate Subscription

Parameters:

  • sub_id —

    Subscription ID.

  • validation_callback_request —

    Subscription validation callback request

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

    the optional parameters

Returns:

  • (Array<(SubscriptionEnvelope, Fixnum, Hash)>) —

    SubscriptionEnvelope data, response status code and response headers



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
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/artikcloud/api/subscriptions_api.rb', line 308

def validate_subscription_with_http_info(sub_id, validation_callback_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionsApi.validate_subscription ..."
  end
  # verify the required parameter 'sub_id' is set
  fail ArgumentError, "Missing the required parameter 'sub_id' when calling SubscriptionsApi.validate_subscription" if sub_id.nil?
  # verify the required parameter 'validation_callback_request' is set
  fail ArgumentError, "Missing the required parameter 'validation_callback_request' when calling SubscriptionsApi.validate_subscription" if validation_callback_request.nil?
  # resource path
  local_var_path = "/subscriptions/{subId}/validate".sub('{format}','json').sub('{' + 'subId' + '}', sub_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(validation_callback_request)
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionEnvelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#validate_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end