Class: FattureInCloud_Ruby_Sdk::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/api/webhooks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhooksApi

Returns a new instance of WebhooksApi.



19
20
21
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_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/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_webhooks_subscription(company_id, opts = {}) ⇒ CreateWebhooksSubscriptionResponse

Create a Webhook Subscription Register some webhooks Subscriptions.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 28

def create_webhooks_subscription(company_id, opts = {})
  data, _status_code, _headers = create_webhooks_subscription_with_http_info(company_id, opts)
  data
end

#create_webhooks_subscription_with_http_info(company_id, opts = {}) ⇒ Array<(CreateWebhooksSubscriptionResponse, Integer, Hash)>

Create a Webhook Subscription Register some webhooks Subscriptions.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:



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
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 39

def create_webhooks_subscription_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhooks_subscription ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling WebhooksApi.create_webhooks_subscription"
  end
  # resource path
  local_var_path = '/c/{company_id}/subscriptions'.sub('{' + 'company_id' + '}', CGI.escape(company_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'CreateWebhooksSubscriptionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"WebhooksApi.create_webhooks_subscription",
    :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: WebhooksApi#create_webhooks_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webhooks_subscription(company_id, subscription_id, opts = {}) ⇒ nil

Delete Webhooks Subscription Delete a webhooks subscription.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • subscription_id (String) —

    The ID of the subscription.

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

    the optional parameters

Returns:

  • (nil) 


98
99
100
101
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 98

def delete_webhooks_subscription(company_id, subscription_id, opts = {})
  delete_webhooks_subscription_with_http_info(company_id, subscription_id, opts)
  nil
end

#delete_webhooks_subscription_with_http_info(company_id, subscription_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Webhooks Subscription Delete a webhooks subscription.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • subscription_id (String) —

    The ID of the subscription.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 109

def delete_webhooks_subscription_with_http_info(company_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhooks_subscription ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling WebhooksApi.delete_webhooks_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 WebhooksApi.delete_webhooks_subscription"
  end
  # resource path
  local_var_path = '/c/{company_id}/subscriptions/{subscription_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"WebhooksApi.delete_webhooks_subscription",
    :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: WebhooksApi#delete_webhooks_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhooks_subscription(company_id, subscription_id, opts = {}) ⇒ GetWebhooksSubscriptionResponse

Get Webhooks Subscription Get a webhooks subscription.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • subscription_id (String) —

    The ID of the subscription.

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

    the optional parameters

Returns:



165
166
167
168
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 165

def get_webhooks_subscription(company_id, subscription_id, opts = {})
  data, _status_code, _headers = get_webhooks_subscription_with_http_info(company_id, subscription_id, opts)
  data
end

#get_webhooks_subscription_with_http_info(company_id, subscription_id, opts = {}) ⇒ Array<(GetWebhooksSubscriptionResponse, Integer, Hash)>

Get Webhooks Subscription Get a webhooks subscription.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • subscription_id (String) —

    The ID of the subscription.

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

    the optional parameters

Returns:



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 176

def get_webhooks_subscription_with_http_info(company_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhooks_subscription ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling WebhooksApi.get_webhooks_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 WebhooksApi.get_webhooks_subscription"
  end
  # resource path
  local_var_path = '/c/{company_id}/subscriptions/{subscription_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetWebhooksSubscriptionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhooks_subscription",
    :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: WebhooksApi#get_webhooks_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_webhooks_subscriptions(company_id, opts = {}) ⇒ ListWebhooksSubscriptionsResponse

List Webhooks Subscriptions List active webhooks subscriptions.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 233

def list_webhooks_subscriptions(company_id, opts = {})
  data, _status_code, _headers = list_webhooks_subscriptions_with_http_info(company_id, opts)
  data
end

#list_webhooks_subscriptions_with_http_info(company_id, opts = {}) ⇒ Array<(ListWebhooksSubscriptionsResponse, Integer, Hash)>

List Webhooks Subscriptions List active webhooks subscriptions.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Returns:



243
244
245
246
247
248
249
250
251
252
253
254
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/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 243

def list_webhooks_subscriptions_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhooks_subscriptions ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling WebhooksApi.list_webhooks_subscriptions"
  end
  # resource path
  local_var_path = '/c/{company_id}/subscriptions'.sub('{' + 'company_id' + '}', CGI.escape(company_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListWebhooksSubscriptionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"WebhooksApi.list_webhooks_subscriptions",
    :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: WebhooksApi#list_webhooks_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_webhooks_subscription(company_id, subscription_id, opts = {}) ⇒ ModifyWebhooksSubscriptionResponse

Modify Webhooks Subscription Edit a webhooks subscription.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • subscription_id (String) —

    The ID of the subscription.

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

    the optional parameters

Options Hash (opts):

Returns:



298
299
300
301
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 298

def modify_webhooks_subscription(company_id, subscription_id, opts = {})
  data, _status_code, _headers = modify_webhooks_subscription_with_http_info(company_id, subscription_id, opts)
  data
end

#modify_webhooks_subscription_with_http_info(company_id, subscription_id, opts = {}) ⇒ Array<(ModifyWebhooksSubscriptionResponse, Integer, Hash)>

Modify Webhooks Subscription Edit a webhooks subscription.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • subscription_id (String) —

    The ID of the subscription.

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

    the optional parameters

Options Hash (opts):

Returns:



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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/fattureincloud_ruby_sdk/api/webhooks_api.rb', line 310

def modify_webhooks_subscription_with_http_info(company_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.modify_webhooks_subscription ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling WebhooksApi.modify_webhooks_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 WebhooksApi.modify_webhooks_subscription"
  end
  # resource path
  local_var_path = '/c/{company_id}/subscriptions/{subscription_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ModifyWebhooksSubscriptionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"WebhooksApi.modify_webhooks_subscription",
    :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: WebhooksApi#modify_webhooks_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end