Class: Hubspot::Webhooks::SubscriptionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/webhooks/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.



20
21
22
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 20

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#archive(subscription_id, app_id, opts = {}) ⇒ nil

Delete a subscription Permanently deletes a subscription. This cannot be undone.

Parameters:

  • subscription_id (Integer) —

    The ID of subscription to delete.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 29

def archive(subscription_id, app_id, opts = {})
  archive_with_http_info(subscription_id, app_id, opts)
  nil
end

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

Delete a subscription Permanently deletes a subscription. This cannot be undone.

Parameters:

  • subscription_id (Integer) —

    The ID of subscription to delete.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 40

def archive_with_http_info(subscription_id, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsApi.archive ...'
  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 SubscriptionsApi.archive"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.archive"
  end
  # resource path
  local_var_path = '/webhooks/v3/{appId}/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', CGI.escape(subscription_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] 

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

  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: SubscriptionsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(app_id, subscription_create_request, opts = {}) ⇒ SubscriptionResponse

Subscribe to an event Creates a new webhook subscription for the given app. Each subscription in an app must be unique.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • subscription_create_request (SubscriptionCreateRequest) —

    Details about the new subscription.

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 97

def create(app_id, subscription_create_request, opts = {})
  data, _status_code, _headers = create_with_http_info(app_id, subscription_create_request, opts)
  data
end

#create_with_http_info(app_id, subscription_create_request, opts = {}) ⇒ Array<(SubscriptionResponse, Integer, Hash)>

Subscribe to an event Creates a new webhook subscription for the given app. Each subscription in an app must be unique.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • subscription_create_request (SubscriptionCreateRequest) —

    Details about the new subscription.

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 108

def create_with_http_info(app_id, subscription_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsApi.create ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.create"
  end
  # verify the required parameter 'subscription_create_request' is set
  if @api_client.config.client_side_validation && subscription_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_create_request' when calling SubscriptionsApi.create"
  end
  # resource path
  local_var_path = '/webhooks/v3/{appId}/subscriptions'.sub('{' + 'appId' + '}', CGI.escape(app_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'
  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_create_request) 

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

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

  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: SubscriptionsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all(app_id, opts = {}) ⇒ SubscriptionListResponse

Get subscription details Returns full details for all existing subscriptions for the given app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



166
167
168
169
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 166

def get_all(app_id, opts = {})
  data, _status_code, _headers = get_all_with_http_info(app_id, opts)
  data
end

#get_all_with_http_info(app_id, opts = {}) ⇒ Array<(SubscriptionListResponse, Integer, Hash)>

Get subscription details Returns full details for all existing subscriptions for the given app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    SubscriptionListResponse data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 176

def get_all_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsApi.get_all ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.get_all"
  end
  # resource path
  local_var_path = '/webhooks/v3/{appId}/subscriptions'.sub('{' + 'appId' + '}', CGI.escape(app_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] || 'SubscriptionListResponse' 

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

  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: SubscriptionsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(app_id, subscription_id, opts = {}) ⇒ SubscriptionResponse

Get subscription Returns details about a subscription.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • subscription_id (Integer) —

    The ID of the target subscription.

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

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 229

def get_by_id(app_id, subscription_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(app_id, subscription_id, opts)
  data
end

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

Get subscription Returns details about a subscription.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • subscription_id (Integer) —

    The ID of the target subscription.

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



240
241
242
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/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 240

def get_by_id_with_http_info(app_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsApi.get_by_id ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.get_by_id"
  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 SubscriptionsApi.get_by_id"
  end
  # resource path
  local_var_path = '/webhooks/v3/{appId}/subscriptions/{subscriptionId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscriptionId' + '}', 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[:body] 

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

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

  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: SubscriptionsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(subscription_id, app_id, subscription_patch_request, opts = {}) ⇒ SubscriptionResponse

Update a subscription Updates the details for an existing subscription.

Parameters:

  • subscription_id (Integer) —

    The ID of the subscription to update.

  • app_id (Integer) —

    The ID of the target app.

  • subscription_patch_request (SubscriptionPatchRequest) —

    Updated details for the subscription.

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 298

def update(subscription_id, app_id, subscription_patch_request, opts = {})
  data, _status_code, _headers = update_with_http_info(subscription_id, app_id, subscription_patch_request, opts)
  data
end

#update_batch(app_id, batch_input_subscription_batch_update_request, opts = {}) ⇒ BatchResponseSubscriptionResponse

Batch update subscriptions Activates or deactivates target app subscriptions.

Parameters:

  • app_id (Integer) —

    The app ID of the target app.

  • batch_input_subscription_batch_update_request (BatchInputSubscriptionBatchUpdateRequest) —

    Updated details for the specified subscriptions.

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

    the optional parameters

Returns:



373
374
375
376
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 373

def update_batch(app_id, batch_input_subscription_batch_update_request, opts = {})
  data, _status_code, _headers = update_batch_with_http_info(app_id, batch_input_subscription_batch_update_request, opts)
  data
end

#update_batch_with_http_info(app_id, batch_input_subscription_batch_update_request, opts = {}) ⇒ Array<(BatchResponseSubscriptionResponse, Integer, Hash)>

Batch update subscriptions Activates or deactivates target app subscriptions.

Parameters:

  • app_id (Integer) —

    The app ID of the target app.

  • batch_input_subscription_batch_update_request (BatchInputSubscriptionBatchUpdateRequest) —

    Updated details for the specified subscriptions.

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

    the optional parameters

Returns:



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 384

def update_batch_with_http_info(app_id, batch_input_subscription_batch_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsApi.update_batch ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.update_batch"
  end
  # verify the required parameter 'batch_input_subscription_batch_update_request' is set
  if @api_client.config.client_side_validation && batch_input_subscription_batch_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_subscription_batch_update_request' when calling SubscriptionsApi.update_batch"
  end
  # resource path
  local_var_path = '/webhooks/v3/{appId}/subscriptions/batch/update'.sub('{' + 'appId' + '}', CGI.escape(app_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'
  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(batch_input_subscription_batch_update_request) 

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

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

  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: SubscriptionsApi#update_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a subscription Updates the details for an existing subscription.

Parameters:

  • subscription_id (Integer) —

    The ID of the subscription to update.

  • app_id (Integer) —

    The ID of the target app.

  • subscription_patch_request (SubscriptionPatchRequest) —

    Updated details for the subscription.

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



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/hubspot/codegen/webhooks/api/subscriptions_api.rb', line 310

def update_with_http_info(subscription_id, app_id, subscription_patch_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsApi.update ...'
  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 SubscriptionsApi.update"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.update"
  end
  # verify the required parameter 'subscription_patch_request' is set
  if @api_client.config.client_side_validation && subscription_patch_request.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_patch_request' when calling SubscriptionsApi.update"
  end
  # resource path
  local_var_path = '/webhooks/v3/{appId}/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', CGI.escape(subscription_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_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'
  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_patch_request) 

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

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

  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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end