Class: Zernio::WebhookEventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zernio-sdk/api/webhook_events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhookEventsApi

Returns a new instance of WebhookEventsApi.



19
20
21
 
# File 'lib/zernio-sdk/api/webhook_events_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/zernio-sdk/api/webhook_events_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#on_account_ads_initial_sync_completed(webhook_payload_account_ads_initial_sync_completed, opts = {}) ⇒ nil

Ads initial sync completed event Fired once per ads-enabled account when the initial sync (ad-account discovery + 90-day historical ad backfill) completes. The sync block reports whether the backfill succeeded and how many ads were synced.

Parameters:

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 27

def (, opts = {})
  (, opts)
  nil
end

#on_account_ads_initial_sync_completed_with_http_info(webhook_payload_account_ads_initial_sync_completed, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Ads initial sync completed event Fired once per ads-enabled account when the initial sync (ad-account discovery + 90-day historical ad backfill) completes. The `sync` block reports whether the backfill succeeded and how many ads were synced.

Parameters:

Returns:

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

    nil, 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 37

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_account_ads_initial_sync_completed ...'
  end
  # verify the required parameter 'webhook_payload_account_ads_initial_sync_completed' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_account_ads_initial_sync_completed' when calling WebhookEventsApi.on_account_ads_initial_sync_completed"
  end
  # resource path
  local_var_path = '/account.ads.initial_sync_completed'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_account_connected(webhook_payload_account_connected, opts = {}) ⇒ nil

Account connected event Fired when a social account is successfully connected.

Parameters:

Returns:

  • (nil) 


93
94
95
96
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 93

def (, opts = {})
  (, opts)
  nil
end

#on_account_connected_with_http_info(webhook_payload_account_connected, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Account connected event Fired when a social account is successfully connected.

Parameters:

Returns:

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

    nil, response status code and response headers



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
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 103

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_account_disconnected(webhook_payload_account_disconnected, opts = {}) ⇒ nil

Account disconnected event Fired when a connected social account becomes disconnected.

Parameters:

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 159

def (, opts = {})
  (, opts)
  nil
end

#on_account_disconnected_with_http_info(webhook_payload_account_disconnected, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Account disconnected event Fired when a connected social account becomes disconnected.

Parameters:

Returns:

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

    nil, response status code and response headers



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 169

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_ad_status_changed(webhook_payload_ad_status_changed, opts = {}) ⇒ nil

Ad status changed event Fired when a campaign, ad set, or ad on a connected ad platform changes status. Currently emitted only for Meta (metaads). Subscribed to two Meta ad_account webhook fields: - in_process_ad_objects - the ad object finished processing and exited the IN_PROCESS state. status.raw carries Meta's status_name (e.g. ACTIVE, PAUSED, ARCHIVED, DELETED). - with_issues_ad_objects - the ad object entered the WITH_ISSUES state. status.raw is set to WITH_ISSUES and the error block is populated from Meta's error_code / error_summary / error_message. adObject.level mirrors Meta's level and is one of CAMPAIGN, AD_SET, or AD. Creative-level events are not forwarded. Branch on status.raw to handle each transition; use error.code (when present) as the stable discriminator — error.summary and error.message are localized to the ad-account owner's Meta locale. The error block is optional. It's present on most WITH_ISSUES events but can be absent (Meta does not always include diagnostics), and is never present on any other status. Always null-check error before reading error.code. Fan-out: matching is keyed on adObject.platformAdAccountId. When multiple connected Zernio metaads accounts are linked to the same Meta ad account, each receives its own delivery.

Parameters:

Returns:

  • (nil) 


225
226
227
228
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 225

def on_ad_status_changed(webhook_payload_ad_status_changed, opts = {})
  on_ad_status_changed_with_http_info(webhook_payload_ad_status_changed, opts)
  nil
end

#on_ad_status_changed_with_http_info(webhook_payload_ad_status_changed, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Ad status changed event Fired when a campaign, ad set, or ad on a connected ad platform changes status. Currently emitted only for Meta (`metaads`). Subscribed to two Meta `ad_account` webhook fields: - `in_process_ad_objects` - the ad object finished processing and exited the `IN_PROCESS` state. `status.raw` carries Meta's `status_name` (e.g. `ACTIVE`, `PAUSED`, `ARCHIVED`, `DELETED`). - `with_issues_ad_objects` - the ad object entered the `WITH_ISSUES` state. `status.raw` is set to `WITH_ISSUES` and the `error` block is populated from Meta's `error_code` / `error_summary` / `error_message`. `adObject.level` mirrors Meta's `level` and is one of `CAMPAIGN`, `AD_SET`, or `AD`. Creative-level events are not forwarded. Branch on `status.raw` to handle each transition; use `error.code` (when present) as the stable discriminator — `error.summary` and `error.message` are localized to the ad-account owner's Meta locale. The `error` block is optional. It's present on most `WITH_ISSUES` events but can be absent (Meta does not always include diagnostics), and is never present on any other status. Always null-check `error` before reading `error.code`. Fan-out: matching is keyed on `adObject.platformAdAccountId`. When multiple connected Zernio `metaads` accounts are linked to the same Meta ad account, each receives its own delivery.

Parameters:

Returns:

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

    nil, response status code and response headers



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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 235

def on_ad_status_changed_with_http_info(webhook_payload_ad_status_changed, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_ad_status_changed ...'
  end
  # verify the required parameter 'webhook_payload_ad_status_changed' is set
  if @api_client.config.client_side_validation && webhook_payload_ad_status_changed.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_ad_status_changed' when calling WebhookEventsApi.on_ad_status_changed"
  end
  # resource path
  local_var_path = '/ad.status_changed'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_ad_status_changed)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_call_ended(webhook_payload_call_ended, opts = {}) ⇒ nil

Call ended event Fired on call hangup with the duration and a zero-markup billing breakdown (Meta cost, Telnyx cost, recording surcharge, total). Costs are pass-through; no margin is applied.

Parameters:

Returns:

  • (nil) 


291
292
293
294
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 291

def on_call_ended(webhook_payload_call_ended, opts = {})
  on_call_ended_with_http_info(webhook_payload_call_ended, opts)
  nil
end

#on_call_ended_with_http_info(webhook_payload_call_ended, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Call ended event Fired on call hangup with the duration and a zero-markup billing breakdown (Meta cost, Telnyx cost, recording surcharge, total). Costs are pass-through; no margin is applied.

Parameters:

Returns:

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

    nil, response status code and response headers



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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 301

def on_call_ended_with_http_info(webhook_payload_call_ended, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_call_ended ...'
  end
  # verify the required parameter 'webhook_payload_call_ended' is set
  if @api_client.config.client_side_validation && webhook_payload_call_ended.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_call_ended' when calling WebhookEventsApi.on_call_ended"
  end
  # resource path
  local_var_path = '/call.ended'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_call_ended)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_call_failed(webhook_payload_call_failed, opts = {}) ⇒ nil

Call failed event Fired when a call setup or in-progress call fails (Meta rejected the connect, Telnyx returned an error, etc.). Payload carries the upstream error code and message.

Parameters:

Returns:

  • (nil) 


357
358
359
360
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 357

def on_call_failed(webhook_payload_call_failed, opts = {})
  on_call_failed_with_http_info(webhook_payload_call_failed, opts)
  nil
end

#on_call_failed_with_http_info(webhook_payload_call_failed, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Call failed event Fired when a call setup or in-progress call fails (Meta rejected the connect, Telnyx returned an error, etc.). Payload carries the upstream error code and message.

Parameters:

Returns:

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

    nil, response status code and response headers



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 367

def on_call_failed_with_http_info(webhook_payload_call_failed, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_call_failed ...'
  end
  # verify the required parameter 'webhook_payload_call_failed' is set
  if @api_client.config.client_side_validation && webhook_payload_call_failed.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_call_failed' when calling WebhookEventsApi.on_call_failed"
  end
  # resource path
  local_var_path = '/call.failed'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_call_failed)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_call_permission_request(webhook_payload_call_permission_request, opts = {}) ⇒ nil

Call permission request reply event Fired when a consumer replies to a call_permission_request interactive message (or its marketing-template variant). Carries the response (accept / reject), whether the grant is permanent, and the expiration timestamp when it is temporary.

Parameters:

Returns:

  • (nil) 


423
424
425
426
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 423

def on_call_permission_request(webhook_payload_call_permission_request, opts = {})
  on_call_permission_request_with_http_info(webhook_payload_call_permission_request, opts)
  nil
end

#on_call_permission_request_with_http_info(webhook_payload_call_permission_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Call permission request reply event Fired when a consumer replies to a `call_permission_request` interactive message (or its marketing-template variant). Carries the response (`accept` / `reject`), whether the grant is permanent, and the expiration timestamp when it is temporary.

Parameters:

Returns:

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

    nil, response status code and response headers



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 433

def on_call_permission_request_with_http_info(webhook_payload_call_permission_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_call_permission_request ...'
  end
  # verify the required parameter 'webhook_payload_call_permission_request' is set
  if @api_client.config.client_side_validation && webhook_payload_call_permission_request.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_call_permission_request' when calling WebhookEventsApi.on_call_permission_request"
  end
  # resource path
  local_var_path = '/call.permission_request'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_call_permission_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_call_received(webhook_payload_call_received, opts = {}) ⇒ nil

Call received event Fired when a WhatsApp Business Call connects. For inbound (UIC) calls the event fires at the moment our Telnyx trunk bridges the consumer leg to the customer's forward-to destination; for outbound (BIC) calls it fires immediately after Meta accepts the connect. Branch on call.direction to distinguish.

Parameters:

Returns:

  • (nil) 


489
490
491
492
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 489

def on_call_received(webhook_payload_call_received, opts = {})
  on_call_received_with_http_info(webhook_payload_call_received, opts)
  nil
end

#on_call_received_with_http_info(webhook_payload_call_received, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Call received event Fired when a WhatsApp Business Call connects. For inbound (UIC) calls the event fires at the moment our Telnyx trunk bridges the consumer leg to the customer&apos;s forward-to destination; for outbound (BIC) calls it fires immediately after Meta accepts the connect. Branch on `call.direction` to distinguish.

Parameters:

Returns:

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

    nil, response status code and response headers



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 499

def on_call_received_with_http_info(webhook_payload_call_received, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_call_received ...'
  end
  # verify the required parameter 'webhook_payload_call_received' is set
  if @api_client.config.client_side_validation && webhook_payload_call_received.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_call_received' when calling WebhookEventsApi.on_call_received"
  end
  # resource path
  local_var_path = '/call.received'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_call_received)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_comment_received(webhook_payload_comment, opts = {}) ⇒ nil

Comment received event Fired when a new comment is received on a tracked post.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


555
556
557
558
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 555

def on_comment_received(webhook_payload_comment, opts = {})
  on_comment_received_with_http_info(webhook_payload_comment, opts)
  nil
end

#on_comment_received_with_http_info(webhook_payload_comment, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Comment received event Fired when a new comment is received on a tracked post.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 565

def on_comment_received_with_http_info(webhook_payload_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_comment_received ...'
  end
  # verify the required parameter 'webhook_payload_comment' is set
  if @api_client.config.client_side_validation && webhook_payload_comment.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_comment' when calling WebhookEventsApi.on_comment_received"
  end
  # resource path
  local_var_path = '/comment.received'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_comment)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_conversation_started(webhook_payload_conversation_started, opts = {}) ⇒ nil

Conversation started event Fired once when a new conversation begins between one of your connected accounts and a contact, in either direction. Works across every DM platform (Instagram, Messenger/Facebook, Telegram, WhatsApp, Twitter, Reddit, Bluesky). Naturally deduped — a given conversation only fires this event the very first time it appears.

Parameters:

Returns:

  • (nil) 


621
622
623
624
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 621

def on_conversation_started(webhook_payload_conversation_started, opts = {})
  on_conversation_started_with_http_info(webhook_payload_conversation_started, opts)
  nil
end

#on_conversation_started_with_http_info(webhook_payload_conversation_started, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Conversation started event Fired once when a new conversation begins between one of your connected accounts and a contact, in either direction. Works across every DM platform (Instagram, Messenger/Facebook, Telegram, WhatsApp, Twitter, Reddit, Bluesky). Naturally deduped — a given conversation only fires this event the very first time it appears.

Parameters:

Returns:

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

    nil, response status code and response headers



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 631

def on_conversation_started_with_http_info(webhook_payload_conversation_started, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_conversation_started ...'
  end
  # verify the required parameter 'webhook_payload_conversation_started' is set
  if @api_client.config.client_side_validation && webhook_payload_conversation_started.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_conversation_started' when calling WebhookEventsApi.on_conversation_started"
  end
  # resource path
  local_var_path = '/conversation.started'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_conversation_started)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_lead_received(webhook_payload_lead, opts = {}) ⇒ nil

Lead received event Fired when a new lead is submitted against a Meta Lead Gen (Instant) Form and ingested via the Page leadgen webhook. lead.fields is the question-key to answer map; lead.formId / lead.adId give provenance. Requires the Ads add-on.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


687
688
689
690
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 687

def on_lead_received(webhook_payload_lead, opts = {})
  on_lead_received_with_http_info(webhook_payload_lead, opts)
  nil
end

#on_lead_received_with_http_info(webhook_payload_lead, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Lead received event Fired when a new lead is submitted against a Meta Lead Gen (Instant) Form and ingested via the Page `leadgen` webhook. `lead.fields` is the question-key to answer map; `lead.formId` / `lead.adId` give provenance. Requires the Ads add-on.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 697

def on_lead_received_with_http_info(webhook_payload_lead, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_lead_received ...'
  end
  # verify the required parameter 'webhook_payload_lead' is set
  if @api_client.config.client_side_validation && webhook_payload_lead.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_lead' when calling WebhookEventsApi.on_lead_received"
  end
  # resource path
  local_var_path = '/lead.received'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_lead)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_deleted(webhook_payload_message_deleted, opts = {}) ⇒ nil

Message deleted event Fired when a sender deletes (unsends) a message. Supported on Instagram (incoming unsend) and WhatsApp (when the business deletes an outgoing message via the Cloud API). The payload retains the pre-delete text and attachments so API consumers can access the original content for moderation or compliance — the Zernio dashboard UI hides it.

Parameters:

Returns:

  • (nil) 


753
754
755
756
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 753

def on_message_deleted(webhook_payload_message_deleted, opts = {})
  on_message_deleted_with_http_info(webhook_payload_message_deleted, opts)
  nil
end

#on_message_deleted_with_http_info(webhook_payload_message_deleted, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message deleted event Fired when a sender deletes (unsends) a message. Supported on Instagram (incoming unsend) and WhatsApp (when the business deletes an outgoing message via the Cloud API). The payload retains the pre-delete text and attachments so API consumers can access the original content for moderation or compliance — the Zernio dashboard UI hides it.

Parameters:

Returns:

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

    nil, response status code and response headers



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 763

def on_message_deleted_with_http_info(webhook_payload_message_deleted, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_deleted ...'
  end
  # verify the required parameter 'webhook_payload_message_deleted' is set
  if @api_client.config.client_side_validation && webhook_payload_message_deleted.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message_deleted' when calling WebhookEventsApi.on_message_deleted"
  end
  # resource path
  local_var_path = '/message.deleted'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message_deleted)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_delivered(webhook_payload_message_delivery_status, opts = {}) ⇒ nil

Message delivered event Fired when an outgoing message is delivered to the recipient. Supported on WhatsApp and Facebook Messenger.

Parameters:

Returns:

  • (nil) 


819
820
821
822
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 819

def on_message_delivered(webhook_payload_message_delivery_status, opts = {})
  on_message_delivered_with_http_info(webhook_payload_message_delivery_status, opts)
  nil
end

#on_message_delivered_with_http_info(webhook_payload_message_delivery_status, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message delivered event Fired when an outgoing message is delivered to the recipient. Supported on WhatsApp and Facebook Messenger.

Parameters:

Returns:

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

    nil, response status code and response headers



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 829

def on_message_delivered_with_http_info(webhook_payload_message_delivery_status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_delivered ...'
  end
  # verify the required parameter 'webhook_payload_message_delivery_status' is set
  if @api_client.config.client_side_validation && webhook_payload_message_delivery_status.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message_delivery_status' when calling WebhookEventsApi.on_message_delivered"
  end
  # resource path
  local_var_path = '/message.delivered'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message_delivery_status)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_edited(webhook_payload_message_edited, opts = {}) ⇒ nil

Message edited event Fired when a sender edits a previously-sent message. Supported on Instagram, Facebook Messenger, and Telegram. The payload includes the full editHistory so consumers can show prior versions.

Parameters:

Returns:

  • (nil) 


885
886
887
888
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 885

def on_message_edited(webhook_payload_message_edited, opts = {})
  on_message_edited_with_http_info(webhook_payload_message_edited, opts)
  nil
end

#on_message_edited_with_http_info(webhook_payload_message_edited, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message edited event Fired when a sender edits a previously-sent message. Supported on Instagram, Facebook Messenger, and Telegram. The payload includes the full editHistory so consumers can show prior versions.

Parameters:

Returns:

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

    nil, response status code and response headers



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 895

def on_message_edited_with_http_info(webhook_payload_message_edited, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_edited ...'
  end
  # verify the required parameter 'webhook_payload_message_edited' is set
  if @api_client.config.client_side_validation && webhook_payload_message_edited.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message_edited' when calling WebhookEventsApi.on_message_edited"
  end
  # resource path
  local_var_path = '/message.edited'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message_edited)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_failed(webhook_payload_message_delivery_status, opts = {}) ⇒ nil

Message delivery failed event Fired when an outgoing message fails to deliver. Currently only emitted for WhatsApp (other platforms don't expose per-message failure via webhook). The payload error object contains code, title, and message from the platform.

Parameters:

Returns:

  • (nil) 


951
952
953
954
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 951

def on_message_failed(webhook_payload_message_delivery_status, opts = {})
  on_message_failed_with_http_info(webhook_payload_message_delivery_status, opts)
  nil
end

#on_message_failed_with_http_info(webhook_payload_message_delivery_status, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message delivery failed event Fired when an outgoing message fails to deliver. Currently only emitted for WhatsApp (other platforms don't expose per-message failure via webhook). The payload error object contains code, title, and message from the platform.

Parameters:

Returns:

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

    nil, response status code and response headers



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 961

def on_message_failed_with_http_info(webhook_payload_message_delivery_status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_failed ...'
  end
  # verify the required parameter 'webhook_payload_message_delivery_status' is set
  if @api_client.config.client_side_validation && webhook_payload_message_delivery_status.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message_delivery_status' when calling WebhookEventsApi.on_message_failed"
  end
  # resource path
  local_var_path = '/message.failed'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message_delivery_status)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_read(webhook_payload_message_delivery_status, opts = {}) ⇒ nil

Message read event Fired when an outgoing message is read by the recipient. Supported on WhatsApp, Facebook Messenger, and Instagram.

Parameters:

Returns:

  • (nil) 


1017
1018
1019
1020
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1017

def on_message_read(webhook_payload_message_delivery_status, opts = {})
  on_message_read_with_http_info(webhook_payload_message_delivery_status, opts)
  nil
end

#on_message_read_with_http_info(webhook_payload_message_delivery_status, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message read event Fired when an outgoing message is read by the recipient. Supported on WhatsApp, Facebook Messenger, and Instagram.

Parameters:

Returns:

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

    nil, response status code and response headers



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1027

def on_message_read_with_http_info(webhook_payload_message_delivery_status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_read ...'
  end
  # verify the required parameter 'webhook_payload_message_delivery_status' is set
  if @api_client.config.client_side_validation && webhook_payload_message_delivery_status.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message_delivery_status' when calling WebhookEventsApi.on_message_read"
  end
  # resource path
  local_var_path = '/message.read'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message_delivery_status)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_received(webhook_payload_message, opts = {}) ⇒ nil

Message received event Fired when a new inbox message is received.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1083
1084
1085
1086
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1083

def on_message_received(webhook_payload_message, opts = {})
  on_message_received_with_http_info(webhook_payload_message, opts)
  nil
end

#on_message_received_with_http_info(webhook_payload_message, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message received event Fired when a new inbox message is received.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1093

def on_message_received_with_http_info(webhook_payload_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_received ...'
  end
  # verify the required parameter 'webhook_payload_message' is set
  if @api_client.config.client_side_validation && webhook_payload_message.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message' when calling WebhookEventsApi.on_message_received"
  end
  # resource path
  local_var_path = '/message.received'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_message_sent(webhook_payload_message_sent, opts = {}) ⇒ nil

Message sent event Fired when a message is sent via the API.

Parameters:

Returns:

  • (nil) 


1149
1150
1151
1152
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1149

def on_message_sent(webhook_payload_message_sent, opts = {})
  on_message_sent_with_http_info(webhook_payload_message_sent, opts)
  nil
end

#on_message_sent_with_http_info(webhook_payload_message_sent, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Message sent event Fired when a message is sent via the API.

Parameters:

Returns:

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

    nil, response status code and response headers



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1159

def on_message_sent_with_http_info(webhook_payload_message_sent, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_message_sent ...'
  end
  # verify the required parameter 'webhook_payload_message_sent' is set
  if @api_client.config.client_side_validation && webhook_payload_message_sent.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_message_sent' when calling WebhookEventsApi.on_message_sent"
  end
  # resource path
  local_var_path = '/message.sent'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_message_sent)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_cancelled(webhook_payload_post, opts = {}) ⇒ nil

Post cancelled event Fired when a post publishing job is cancelled.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1215
1216
1217
1218
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1215

def on_post_cancelled(webhook_payload_post, opts = {})
  on_post_cancelled_with_http_info(webhook_payload_post, opts)
  nil
end

#on_post_cancelled_with_http_info(webhook_payload_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post cancelled event Fired when a post publishing job is cancelled.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1225

def on_post_cancelled_with_http_info(webhook_payload_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_cancelled ...'
  end
  # verify the required parameter 'webhook_payload_post' is set
  if @api_client.config.client_side_validation && webhook_payload_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post' when calling WebhookEventsApi.on_post_cancelled"
  end
  # resource path
  local_var_path = '/post.cancelled'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_external_created(webhook_payload_external_post, opts = {}) ⇒ nil

External post created event Fired when Zernio's background sync detects a natively-authored post (created outside Zernio, e.g. a Google Business Profile localPost made in the Google UI) for the first time. Poll-driven (~hourly), not real-time. post.source is always "external".

Parameters:

Returns:

  • (nil) 


1281
1282
1283
1284
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1281

def on_post_external_created(webhook_payload_external_post, opts = {})
  on_post_external_created_with_http_info(webhook_payload_external_post, opts)
  nil
end

#on_post_external_created_with_http_info(webhook_payload_external_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

External post created event Fired when Zernio's background sync detects a natively-authored post (created outside Zernio, e.g. a Google Business Profile localPost made in the Google UI) for the first time. Poll-driven (~hourly), not real-time. `post.source` is always &quot;external&quot;.

Parameters:

Returns:

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

    nil, response status code and response headers



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1291

def on_post_external_created_with_http_info(webhook_payload_external_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_external_created ...'
  end
  # verify the required parameter 'webhook_payload_external_post' is set
  if @api_client.config.client_side_validation && webhook_payload_external_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_external_post' when calling WebhookEventsApi.on_post_external_created"
  end
  # resource path
  local_var_path = '/post.external.created'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_external_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_external_deleted(webhook_payload_external_post, opts = {}) ⇒ nil

External post deleted event Fired when a tracked native post is detected as removed from the platform. post.deletedAt carries the detection time. Coverage is bounded to the most recent posts the platform listing returns.

Parameters:

Returns:

  • (nil) 


1347
1348
1349
1350
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1347

def on_post_external_deleted(webhook_payload_external_post, opts = {})
  on_post_external_deleted_with_http_info(webhook_payload_external_post, opts)
  nil
end

#on_post_external_deleted_with_http_info(webhook_payload_external_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

External post deleted event Fired when a tracked native post is detected as removed from the platform. `post.deletedAt` carries the detection time. Coverage is bounded to the most recent posts the platform listing returns.

Parameters:

Returns:

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

    nil, response status code and response headers



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1357

def on_post_external_deleted_with_http_info(webhook_payload_external_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_external_deleted ...'
  end
  # verify the required parameter 'webhook_payload_external_post' is set
  if @api_client.config.client_side_validation && webhook_payload_external_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_external_post' when calling WebhookEventsApi.on_post_external_deleted"
  end
  # resource path
  local_var_path = '/post.external.deleted'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_external_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_external_updated(webhook_payload_external_post, opts = {}) ⇒ nil

External post updated event Fired when a tracked native post's text or media changed on the platform. Detected by comparing text/media structure and, where available, the platform's own edit timestamp; a media-URL-only refresh does not fire this.

Parameters:

Returns:

  • (nil) 


1413
1414
1415
1416
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1413

def on_post_external_updated(webhook_payload_external_post, opts = {})
  on_post_external_updated_with_http_info(webhook_payload_external_post, opts)
  nil
end

#on_post_external_updated_with_http_info(webhook_payload_external_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

External post updated event Fired when a tracked native post's text or media changed on the platform. Detected by comparing text/media structure and, where available, the platform's own edit timestamp; a media-URL-only refresh does not fire this.

Parameters:

Returns:

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

    nil, response status code and response headers



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1423

def on_post_external_updated_with_http_info(webhook_payload_external_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_external_updated ...'
  end
  # verify the required parameter 'webhook_payload_external_post' is set
  if @api_client.config.client_side_validation && webhook_payload_external_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_external_post' when calling WebhookEventsApi.on_post_external_updated"
  end
  # resource path
  local_var_path = '/post.external.updated'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_external_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_failed(webhook_payload_post, opts = {}) ⇒ nil

Post failed event Fired when a post fails to publish on all target platforms.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1479
1480
1481
1482
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1479

def on_post_failed(webhook_payload_post, opts = {})
  on_post_failed_with_http_info(webhook_payload_post, opts)
  nil
end

#on_post_failed_with_http_info(webhook_payload_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post failed event Fired when a post fails to publish on all target platforms.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1489

def on_post_failed_with_http_info(webhook_payload_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_failed ...'
  end
  # verify the required parameter 'webhook_payload_post' is set
  if @api_client.config.client_side_validation && webhook_payload_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post' when calling WebhookEventsApi.on_post_failed"
  end
  # resource path
  local_var_path = '/post.failed'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_partial(webhook_payload_post, opts = {}) ⇒ nil

Post partial event Fired when a post publishes on some platforms and fails on others.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1545
1546
1547
1548
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1545

def on_post_partial(webhook_payload_post, opts = {})
  on_post_partial_with_http_info(webhook_payload_post, opts)
  nil
end

#on_post_partial_with_http_info(webhook_payload_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post partial event Fired when a post publishes on some platforms and fails on others.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1555

def on_post_partial_with_http_info(webhook_payload_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_partial ...'
  end
  # verify the required parameter 'webhook_payload_post' is set
  if @api_client.config.client_side_validation && webhook_payload_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post' when calling WebhookEventsApi.on_post_partial"
  end
  # resource path
  local_var_path = '/post.partial'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_platform_failed(webhook_payload_post_platform, opts = {}) ⇒ nil

Post platform failed event Fired once per platform target inside a post as that platform fails permanently. Temporary/retryable failures do NOT fire this event — only permanent ones, so retry loops stay quiet. The envelope event (post.failed / post.partial) fires separately AFTER all platforms have terminated.

Parameters:

Returns:

  • (nil) 


1611
1612
1613
1614
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1611

def on_post_platform_failed(webhook_payload_post_platform, opts = {})
  on_post_platform_failed_with_http_info(webhook_payload_post_platform, opts)
  nil
end

#on_post_platform_failed_with_http_info(webhook_payload_post_platform, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post platform failed event Fired once per platform target inside a post as that platform fails permanently. Temporary/retryable failures do NOT fire this event — only permanent ones, so retry loops stay quiet. The envelope event (`post.failed` / `post.partial`) fires separately AFTER all platforms have terminated.

Parameters:

Returns:

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

    nil, response status code and response headers



1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1621

def on_post_platform_failed_with_http_info(webhook_payload_post_platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_platform_failed ...'
  end
  # verify the required parameter 'webhook_payload_post_platform' is set
  if @api_client.config.client_side_validation && webhook_payload_post_platform.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post_platform' when calling WebhookEventsApi.on_post_platform_failed"
  end
  # resource path
  local_var_path = '/post.platform.failed'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post_platform)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_platform_published(webhook_payload_post_platform, opts = {}) ⇒ nil

Post platform published event Fired once per platform target inside a post as that platform finishes publishing successfully. Does NOT wait for the post-level rollup — consumers building incremental UIs get notified immediately, even when other platforms on the same post are still processing. The envelope event (post.published / post.partial) fires separately AFTER all platforms have terminated.

Parameters:

Returns:

  • (nil) 


1677
1678
1679
1680
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1677

def on_post_platform_published(webhook_payload_post_platform, opts = {})
  on_post_platform_published_with_http_info(webhook_payload_post_platform, opts)
  nil
end

#on_post_platform_published_with_http_info(webhook_payload_post_platform, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post platform published event Fired once per platform target inside a post as that platform finishes publishing successfully. Does NOT wait for the post-level rollup — consumers building incremental UIs get notified immediately, even when other platforms on the same post are still processing. The envelope event (`post.published` / `post.partial`) fires separately AFTER all platforms have terminated.

Parameters:

Returns:

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

    nil, response status code and response headers



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1687

def on_post_platform_published_with_http_info(webhook_payload_post_platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_platform_published ...'
  end
  # verify the required parameter 'webhook_payload_post_platform' is set
  if @api_client.config.client_side_validation && webhook_payload_post_platform.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post_platform' when calling WebhookEventsApi.on_post_platform_published"
  end
  # resource path
  local_var_path = '/post.platform.published'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post_platform)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_published(webhook_payload_post, opts = {}) ⇒ nil

Post published event Fired when a post is successfully published.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1743
1744
1745
1746
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1743

def on_post_published(webhook_payload_post, opts = {})
  on_post_published_with_http_info(webhook_payload_post, opts)
  nil
end

#on_post_published_with_http_info(webhook_payload_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post published event Fired when a post is successfully published.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1753

def on_post_published_with_http_info(webhook_payload_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_published ...'
  end
  # verify the required parameter 'webhook_payload_post' is set
  if @api_client.config.client_side_validation && webhook_payload_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post' when calling WebhookEventsApi.on_post_published"
  end
  # resource path
  local_var_path = '/post.published'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_recycled(webhook_payload_post, opts = {}) ⇒ nil

Post recycled event Fired when a post is recycled (cloned and re-scheduled for publishing).

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1809
1810
1811
1812
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1809

def on_post_recycled(webhook_payload_post, opts = {})
  on_post_recycled_with_http_info(webhook_payload_post, opts)
  nil
end

#on_post_recycled_with_http_info(webhook_payload_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post recycled event Fired when a post is recycled (cloned and re-scheduled for publishing).

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1819

def on_post_recycled_with_http_info(webhook_payload_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_recycled ...'
  end
  # verify the required parameter 'webhook_payload_post' is set
  if @api_client.config.client_side_validation && webhook_payload_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post' when calling WebhookEventsApi.on_post_recycled"
  end
  # resource path
  local_var_path = '/post.recycled'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_scheduled(webhook_payload_post, opts = {}) ⇒ nil

Post scheduled event Fired when a post is created and scheduled for publishing.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1875
1876
1877
1878
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1875

def on_post_scheduled(webhook_payload_post, opts = {})
  on_post_scheduled_with_http_info(webhook_payload_post, opts)
  nil
end

#on_post_scheduled_with_http_info(webhook_payload_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post scheduled event Fired when a post is created and scheduled for publishing.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1885

def on_post_scheduled_with_http_info(webhook_payload_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_scheduled ...'
  end
  # verify the required parameter 'webhook_payload_post' is set
  if @api_client.config.client_side_validation && webhook_payload_post.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post' when calling WebhookEventsApi.on_post_scheduled"
  end
  # resource path
  local_var_path = '/post.scheduled'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_post_tik_tok_url_resolved(webhook_payload_post_platform, opts = {}) ⇒ nil

TikTok post URL resolved event Fired when an already-published TikTok platform entry gets its public URL backfilled. TikTok exposes the numeric video id asynchronously (often minutes after PUBLISH_COMPLETE), so the terminal events can carry an empty publishedUrl for TikTok. This event delivers platform.publishedUrl and the resolved platform.platformPostId once available. At most once per platform target; never fires for drafts or private posts (no public URL exists). Payload shape is identical to post.platform.published.

Parameters:

Returns:

  • (nil) 


1941
1942
1943
1944
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1941

def on_post_tik_tok_url_resolved(webhook_payload_post_platform, opts = {})
  on_post_tik_tok_url_resolved_with_http_info(webhook_payload_post_platform, opts)
  nil
end

#on_post_tik_tok_url_resolved_with_http_info(webhook_payload_post_platform, opts = {}) ⇒ Array<(nil, Integer, Hash)>

TikTok post URL resolved event Fired when an already-published TikTok platform entry gets its public URL backfilled. TikTok exposes the numeric video id asynchronously (often minutes after PUBLISH_COMPLETE), so the terminal events can carry an empty `publishedUrl` for TikTok. This event delivers `platform.publishedUrl` and the resolved `platform.platformPostId` once available. At most once per platform target; never fires for drafts or private posts (no public URL exists). Payload shape is identical to `post.platform.published`.

Parameters:

Returns:

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

    nil, response status code and response headers



1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 1951

def on_post_tik_tok_url_resolved_with_http_info(webhook_payload_post_platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_post_tik_tok_url_resolved ...'
  end
  # verify the required parameter 'webhook_payload_post_platform' is set
  if @api_client.config.client_side_validation && webhook_payload_post_platform.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_post_platform' when calling WebhookEventsApi.on_post_tik_tok_url_resolved"
  end
  # resource path
  local_var_path = '/post.tiktok.url_resolved'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_post_platform)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_reaction_received(webhook_payload_reaction, opts = {}) ⇒ nil

Reaction received event Fired when a participant adds or removes an emoji reaction on a message. Supported on WhatsApp and Telegram. Distinct from message.received so a reaction (e.g. a thumbs-up) is not mistaken for an inbound message. The reaction.action field is added or removed. On WhatsApp removals the platform does not report which emoji was removed, so reaction.emoji may be an empty string. Requires the Inbox add-on.

Parameters:

Returns:

  • (nil) 


2007
2008
2009
2010
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2007

def on_reaction_received(webhook_payload_reaction, opts = {})
  on_reaction_received_with_http_info(webhook_payload_reaction, opts)
  nil
end

#on_reaction_received_with_http_info(webhook_payload_reaction, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reaction received event Fired when a participant adds or removes an emoji reaction on a message. Supported on WhatsApp and Telegram. Distinct from message.received so a reaction (e.g. a thumbs-up) is not mistaken for an inbound message. The `reaction.action` field is `added` or `removed`. On WhatsApp removals the platform does not report which emoji was removed, so `reaction.emoji` may be an empty string. Requires the Inbox add-on.

Parameters:

Returns:

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

    nil, response status code and response headers



2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2017

def on_reaction_received_with_http_info(webhook_payload_reaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_reaction_received ...'
  end
  # verify the required parameter 'webhook_payload_reaction' is set
  if @api_client.config.client_side_validation && webhook_payload_reaction.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_reaction' when calling WebhookEventsApi.on_reaction_received"
  end
  # resource path
  local_var_path = '/reaction.received'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_reaction)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_review_new(webhook_payload_review_new, opts = {}) ⇒ nil

Review new event Fired when a new review is posted on a connected account. Currently supported for Google Business Profile (real-time via Pub/Sub). Requires the Inbox add-on.

Parameters:

Returns:

  • (nil) 


2073
2074
2075
2076
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2073

def on_review_new(webhook_payload_review_new, opts = {})
  on_review_new_with_http_info(webhook_payload_review_new, opts)
  nil
end

#on_review_new_with_http_info(webhook_payload_review_new, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Review new event Fired when a new review is posted on a connected account. Currently supported for Google Business Profile (real-time via Pub/Sub). Requires the Inbox add-on.

Parameters:

Returns:

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

    nil, response status code and response headers



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2083

def on_review_new_with_http_info(webhook_payload_review_new, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_review_new ...'
  end
  # verify the required parameter 'webhook_payload_review_new' is set
  if @api_client.config.client_side_validation && webhook_payload_review_new.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_review_new' when calling WebhookEventsApi.on_review_new"
  end
  # resource path
  local_var_path = '/review.new'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_review_new)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_review_updated(webhook_payload_review_updated, opts = {}) ⇒ nil

Review updated event Fired when a review changes: the reviewer edits their text or rating, or a reply is added (via the API or directly through the Google Business dashboard). Payload shape matches review.new. Requires the Inbox add-on.

Parameters:

Returns:

  • (nil) 


2139
2140
2141
2142
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2139

def on_review_updated(webhook_payload_review_updated, opts = {})
  on_review_updated_with_http_info(webhook_payload_review_updated, opts)
  nil
end

#on_review_updated_with_http_info(webhook_payload_review_updated, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Review updated event Fired when a review changes: the reviewer edits their text or rating, or a reply is added (via the API or directly through the Google Business dashboard). Payload shape matches review.new. Requires the Inbox add-on.

Parameters:

Returns:

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

    nil, response status code and response headers



2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2149

def on_review_updated_with_http_info(webhook_payload_review_updated, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_review_updated ...'
  end
  # verify the required parameter 'webhook_payload_review_updated' is set
  if @api_client.config.client_side_validation && webhook_payload_review_updated.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_review_updated' when calling WebhookEventsApi.on_review_updated"
  end
  # resource path
  local_var_path = '/review.updated'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_review_updated)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_webhook_test(webhook_payload_test, opts = {}) ⇒ nil

Webhook test event Fired when sending a test webhook to verify the endpoint configuration.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2205
2206
2207
2208
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2205

def on_webhook_test(webhook_payload_test, opts = {})
  on_webhook_test_with_http_info(webhook_payload_test, opts)
  nil
end

#on_webhook_test_with_http_info(webhook_payload_test, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Webhook test event Fired when sending a test webhook to verify the endpoint configuration.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2215

def on_webhook_test_with_http_info(webhook_payload_test, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_webhook_test ...'
  end
  # verify the required parameter 'webhook_payload_test' is set
  if @api_client.config.client_side_validation && webhook_payload_test.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_test' when calling WebhookEventsApi.on_webhook_test"
  end
  # resource path
  local_var_path = '/webhook.test'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_test)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_automatic_event(on_whats_app_automatic_event_request, opts = {}) ⇒ nil

WhatsApp automatic event detected Fired when Meta's automatic event identification (opt-in during Embedded Signup; not available for EU/UK/JP businesses) detects a lead or purchase in a Click-to-WhatsApp conversation. Branch on eventName (LeadSubmitted | Purchase). Carries the ctwa_clid even on coexistence numbers where the inbound referral omits it (this webhook is the only surface that delivers it there); the clid is also written back onto the conversation, so POST /v1/whatsapp/conversions becomes usable for the thread.

Parameters:

Returns:

  • (nil) 


2271
2272
2273
2274
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2271

def on_whats_app_automatic_event(on_whats_app_automatic_event_request, opts = {})
  on_whats_app_automatic_event_with_http_info(on_whats_app_automatic_event_request, opts)
  nil
end

#on_whats_app_automatic_event_with_http_info(on_whats_app_automatic_event_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp automatic event detected Fired when Meta's automatic event identification (opt-in during Embedded Signup; not available for EU/UK/JP businesses) detects a lead or purchase in a Click-to-WhatsApp conversation. Branch on `eventName` (`LeadSubmitted` | `Purchase`). Carries the `ctwa_clid` even on coexistence numbers where the inbound referral omits it (this webhook is the only surface that delivers it there); the clid is also written back onto the conversation, so POST /v1/whatsapp/conversions becomes usable for the thread.

Parameters:

Returns:

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

    nil, response status code and response headers



2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2281

def on_whats_app_automatic_event_with_http_info(on_whats_app_automatic_event_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_automatic_event ...'
  end
  # verify the required parameter 'on_whats_app_automatic_event_request' is set
  if @api_client.config.client_side_validation && on_whats_app_automatic_event_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_automatic_event_request' when calling WebhookEventsApi.on_whats_app_automatic_event"
  end
  # resource path
  local_var_path = '/whatsapp.automatic_event'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_automatic_event_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_action_required(on_whats_app_number_action_required_request, opts = {}) ⇒ nil

WhatsApp number action required event Fired when the regulator asks for more information on an already-placed regulated number order. The number stays pending (nothing was rejected); the customer can provide the missing information from the dashboard, or via the remediation endpoint. reason carries the regulator's request verbatim when available.

Parameters:

Returns:

  • (nil) 


2337
2338
2339
2340
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2337

def on_whats_app_number_action_required(on_whats_app_number_action_required_request, opts = {})
  on_whats_app_number_action_required_with_http_info(on_whats_app_number_action_required_request, opts)
  nil
end

#on_whats_app_number_action_required_with_http_info(on_whats_app_number_action_required_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number action required event Fired when the regulator asks for more information on an already-placed regulated number order. The number stays pending (nothing was rejected); the customer can provide the missing information from the dashboard, or via the remediation endpoint. `reason` carries the regulator's request verbatim when available.

Parameters:

Returns:

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

    nil, response status code and response headers



2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2347

def on_whats_app_number_action_required_with_http_info(on_whats_app_number_action_required_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_action_required ...'
  end
  # verify the required parameter 'on_whats_app_number_action_required_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_action_required_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_action_required_request' when calling WebhookEventsApi.on_whats_app_number_action_required"
  end
  # resource path
  local_var_path = '/whatsapp.number.action_required'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_action_required_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_activated(on_whats_app_number_activated_request, opts = {}) ⇒ nil

WhatsApp number activated event Fired when a purchased WhatsApp number becomes active and usable — both the synchronous (Tier 1/2) path and the asynchronous regulated (Tier 3/4) path land here. Lets integrators react without polling GET /v1/phone-numbers.

Parameters:

Returns:

  • (nil) 


2403
2404
2405
2406
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2403

def on_whats_app_number_activated(on_whats_app_number_activated_request, opts = {})
  on_whats_app_number_activated_with_http_info(on_whats_app_number_activated_request, opts)
  nil
end

#on_whats_app_number_activated_with_http_info(on_whats_app_number_activated_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number activated event Fired when a purchased WhatsApp number becomes active and usable — both the synchronous (Tier 1/2) path and the asynchronous regulated (Tier 3/4) path land here. Lets integrators react without polling GET /v1/phone-numbers.

Parameters:

Returns:

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

    nil, response status code and response headers



2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2413

def on_whats_app_number_activated_with_http_info(on_whats_app_number_activated_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_activated ...'
  end
  # verify the required parameter 'on_whats_app_number_activated_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_activated_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_activated_request' when calling WebhookEventsApi.on_whats_app_number_activated"
  end
  # resource path
  local_var_path = '/whatsapp.number.activated'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_activated_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_declined(on_whats_app_number_declined_request, opts = {}) ⇒ nil

WhatsApp number declined event Fired when a regulated (Tier 3/4) number order is declined or fails review. The number is never billed. reason carries the reviewer's rejection reason when available.

Parameters:

Returns:

  • (nil) 


2469
2470
2471
2472
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2469

def on_whats_app_number_declined(on_whats_app_number_declined_request, opts = {})
  on_whats_app_number_declined_with_http_info(on_whats_app_number_declined_request, opts)
  nil
end

#on_whats_app_number_declined_with_http_info(on_whats_app_number_declined_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number declined event Fired when a regulated (Tier 3/4) number order is declined or fails review. The number is never billed. `reason` carries the reviewer's rejection reason when available.

Parameters:

Returns:

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

    nil, response status code and response headers



2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2479

def on_whats_app_number_declined_with_http_info(on_whats_app_number_declined_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_declined ...'
  end
  # verify the required parameter 'on_whats_app_number_declined_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_declined_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_declined_request' when calling WebhookEventsApi.on_whats_app_number_declined"
  end
  # resource path
  local_var_path = '/whatsapp.number.declined'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_declined_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_kyc_submitted(on_whats_app_number_kyc_submitted_request, opts = {}) ⇒ nil

WhatsApp number KYC submitted event Fired when an end customer completes a hosted KYC share link (POST /v1/phone-numbers/kyc/share). The number enters review (pending_regulatory) under your account; whatsapp.number.activated or whatsapp.number.declined follows once the provider rules on it.

Parameters:

Returns:

  • (nil) 


2535
2536
2537
2538
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2535

def on_whats_app_number_kyc_submitted(on_whats_app_number_kyc_submitted_request, opts = {})
  on_whats_app_number_kyc_submitted_with_http_info(on_whats_app_number_kyc_submitted_request, opts)
  nil
end

#on_whats_app_number_kyc_submitted_with_http_info(on_whats_app_number_kyc_submitted_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number KYC submitted event Fired when an end customer completes a hosted KYC share link (POST /v1/phone-numbers/kyc/share). The number enters review (pending_regulatory) under your account; `whatsapp.number.activated` or `whatsapp.number.declined` follows once the provider rules on it.

Parameters:

Returns:

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

    nil, response status code and response headers



2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2545

def on_whats_app_number_kyc_submitted_with_http_info(on_whats_app_number_kyc_submitted_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_kyc_submitted ...'
  end
  # verify the required parameter 'on_whats_app_number_kyc_submitted_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_kyc_submitted_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_kyc_submitted_request' when calling WebhookEventsApi.on_whats_app_number_kyc_submitted"
  end
  # resource path
  local_var_path = '/whatsapp.number.kyc_submitted'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_kyc_submitted_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_reactivated(on_whats_app_number_reactivated_request, opts = {}) ⇒ nil

WhatsApp number reactivated event Fired when a suspended number is reactivated (e.g. the payment recovered) and is usable again.

Parameters:

Returns:

  • (nil) 


2601
2602
2603
2604
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2601

def on_whats_app_number_reactivated(on_whats_app_number_reactivated_request, opts = {})
  on_whats_app_number_reactivated_with_http_info(on_whats_app_number_reactivated_request, opts)
  nil
end

#on_whats_app_number_reactivated_with_http_info(on_whats_app_number_reactivated_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number reactivated event Fired when a suspended number is reactivated (e.g. the payment recovered) and is usable again.

Parameters:

Returns:

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

    nil, response status code and response headers



2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2611

def on_whats_app_number_reactivated_with_http_info(on_whats_app_number_reactivated_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_reactivated ...'
  end
  # verify the required parameter 'on_whats_app_number_reactivated_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_reactivated_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_reactivated_request' when calling WebhookEventsApi.on_whats_app_number_reactivated"
  end
  # resource path
  local_var_path = '/whatsapp.number.reactivated'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_reactivated_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_released(on_whats_app_number_released_request, opts = {}) ⇒ nil

WhatsApp number released event Fired when a number is released and is no longer usable (by the user, a billing cleanup, or an admin). Terminal. reason carries the cause (e.g. user_requested, cleanup_suspended).

Parameters:

Returns:

  • (nil) 


2667
2668
2669
2670
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2667

def on_whats_app_number_released(on_whats_app_number_released_request, opts = {})
  on_whats_app_number_released_with_http_info(on_whats_app_number_released_request, opts)
  nil
end

#on_whats_app_number_released_with_http_info(on_whats_app_number_released_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number released event Fired when a number is released and is no longer usable (by the user, a billing cleanup, or an admin). Terminal. `reason` carries the cause (e.g. `user_requested`, `cleanup_suspended`).

Parameters:

Returns:

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

    nil, response status code and response headers



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2677

def on_whats_app_number_released_with_http_info(on_whats_app_number_released_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_released ...'
  end
  # verify the required parameter 'on_whats_app_number_released_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_released_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_released_request' when calling WebhookEventsApi.on_whats_app_number_released"
  end
  # resource path
  local_var_path = '/whatsapp.number.released'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_released_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_suspended(on_whats_app_number_suspended_request, opts = {}) ⇒ nil

WhatsApp number suspended event Fired when an active number is suspended (e.g. a failed payment). The number stops working until the issue is resolved, after which a whatsapp.number.reactivated event is sent. reason carries the cause (e.g. payment_failed, subscription_ended).

Parameters:

Returns:

  • (nil) 


2733
2734
2735
2736
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2733

def on_whats_app_number_suspended(on_whats_app_number_suspended_request, opts = {})
  on_whats_app_number_suspended_with_http_info(on_whats_app_number_suspended_request, opts)
  nil
end

#on_whats_app_number_suspended_with_http_info(on_whats_app_number_suspended_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number suspended event Fired when an active number is suspended (e.g. a failed payment). The number stops working until the issue is resolved, after which a `whatsapp.number.reactivated` event is sent. `reason` carries the cause (e.g. `payment_failed`, `subscription_ended`).

Parameters:

Returns:

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

    nil, response status code and response headers



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2743

def on_whats_app_number_suspended_with_http_info(on_whats_app_number_suspended_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_suspended ...'
  end
  # verify the required parameter 'on_whats_app_number_suspended_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_suspended_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_suspended_request' when calling WebhookEventsApi.on_whats_app_number_suspended"
  end
  # resource path
  local_var_path = '/whatsapp.number.suspended'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_suspended_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_number_verification_required(on_whats_app_number_verification_required_request, opts = {}) ⇒ nil

WhatsApp number verification-required event Fired when a regulated number has an out-of-band identity-verification step (e.g. Onfido). verificationUrl is the link to forward to the number's end user; the order completes once they pass.

Parameters:

Returns:

  • (nil) 


2799
2800
2801
2802
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2799

def on_whats_app_number_verification_required(on_whats_app_number_verification_required_request, opts = {})
  on_whats_app_number_verification_required_with_http_info(on_whats_app_number_verification_required_request, opts)
  nil
end

#on_whats_app_number_verification_required_with_http_info(on_whats_app_number_verification_required_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp number verification-required event Fired when a regulated number has an out-of-band identity-verification step (e.g. Onfido). `verificationUrl` is the link to forward to the number's end user; the order completes once they pass.

Parameters:

Returns:

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

    nil, response status code and response headers



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2809

def on_whats_app_number_verification_required_with_http_info(on_whats_app_number_verification_required_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_number_verification_required ...'
  end
  # verify the required parameter 'on_whats_app_number_verification_required_request' is set
  if @api_client.config.client_side_validation && on_whats_app_number_verification_required_request.nil?
    fail ArgumentError, "Missing the required parameter 'on_whats_app_number_verification_required_request' when calling WebhookEventsApi.on_whats_app_number_verification_required"
  end
  # resource path
  local_var_path = '/whatsapp.number.verification_required'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(on_whats_app_number_verification_required_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#on_whats_app_template_status_updated(webhook_payload_whats_app_template_status_updated, opts = {}) ⇒ nil

WhatsApp template status updated event Fired when Meta finishes (re)reviewing a WhatsApp Business template attached to a connected WABA. Forwarded from Meta's message_template_status_update webhook field on the WhatsApp Business Account. Consumers branch on template.status (APPROVED, REJECTED, PENDING, PAUSED, DISABLED, IN_APPEAL, PENDING_DELETION). Meta does not include the previous status or the template's category in this event.

Parameters:

Returns:

  • (nil) 


2865
2866
2867
2868
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2865

def on_whats_app_template_status_updated(webhook_payload_whats_app_template_status_updated, opts = {})
  on_whats_app_template_status_updated_with_http_info(webhook_payload_whats_app_template_status_updated, opts)
  nil
end

#on_whats_app_template_status_updated_with_http_info(webhook_payload_whats_app_template_status_updated, opts = {}) ⇒ Array<(nil, Integer, Hash)>

WhatsApp template status updated event Fired when Meta finishes (re)reviewing a WhatsApp Business template attached to a connected WABA. Forwarded from Meta's `message_template_status_update` webhook field on the WhatsApp Business Account. Consumers branch on `template.status` (APPROVED, REJECTED, PENDING, PAUSED, DISABLED, IN_APPEAL, PENDING_DELETION). Meta does not include the previous status or the template's category in this event.

Parameters:

Returns:

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

    nil, response status code and response headers



2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
 
# File 'lib/zernio-sdk/api/webhook_events_api.rb', line 2875

def on_whats_app_template_status_updated_with_http_info(webhook_payload_whats_app_template_status_updated, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_whats_app_template_status_updated ...'
  end
  # verify the required parameter 'webhook_payload_whats_app_template_status_updated' is set
  if @api_client.config.client_side_validation && webhook_payload_whats_app_template_status_updated.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_payload_whats_app_template_status_updated' when calling WebhookEventsApi.on_whats_app_template_status_updated"
  end
  # resource path
  local_var_path = '/whatsapp.template.status_updated'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(webhook_payload_whats_app_template_status_updated)

  # return_type
  return_type = opts[:debug_return_type]

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

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