Class: Zernio::BusinessAgentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BusinessAgentApi

Returns a new instance of BusinessAgentApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_business_agent_allowlist_entry(account_id, add_business_agent_allowlist_entry_request, opts = {}) ⇒ BusinessAgentAllowlistEntry

Allowlist a consumer One E.164 number per call. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



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

def add_business_agent_allowlist_entry(, add_business_agent_allowlist_entry_request, opts = {})
  data, _status_code, _headers = add_business_agent_allowlist_entry_with_http_info(, add_business_agent_allowlist_entry_request, opts)
  data
end

#add_business_agent_allowlist_entry_with_http_info(account_id, add_business_agent_allowlist_entry_request, opts = {}) ⇒ Array<(BusinessAgentAllowlistEntry, Integer, Hash)>

Allowlist a consumer One E.164 number per call. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentAllowlistEntry data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 39

def add_business_agent_allowlist_entry_with_http_info(, add_business_agent_allowlist_entry_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.add_business_agent_allowlist_entry ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.add_business_agent_allowlist_entry"
  end
  # verify the required parameter 'add_business_agent_allowlist_entry_request' is set
  if @api_client.config.client_side_validation && add_business_agent_allowlist_entry_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_business_agent_allowlist_entry_request' when calling BusinessAgentApi.add_business_agent_allowlist_entry"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/allowlist'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(add_business_agent_allowlist_entry_request)

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

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

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

#add_business_agent_website(account_id, business_agent_website_input, opts = {}) ⇒ BusinessAgentWebsite

Add a website to crawl Meta crawls the site into the agent knowledge and recrawls it periodically; check crawl_status and crawl_error on read. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 102

def add_business_agent_website(, business_agent_website_input, opts = {})
  data, _status_code, _headers = add_business_agent_website_with_http_info(, business_agent_website_input, opts)
  data
end

#add_business_agent_website_with_http_info(account_id, business_agent_website_input, opts = {}) ⇒ Array<(BusinessAgentWebsite, Integer, Hash)>

Add a website to crawl Meta crawls the site into the agent knowledge and recrawls it periodically; check `crawl_status` and `crawl_error` on read. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentWebsite data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 113

def add_business_agent_website_with_http_info(, business_agent_website_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.add_business_agent_website ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.add_business_agent_website"
  end
  # verify the required parameter 'business_agent_website_input' is set
  if @api_client.config.client_side_validation && business_agent_website_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_website_input' when calling BusinessAgentApi.add_business_agent_website"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/websites'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_website_input)

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

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

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

#create_business_agent_connector(account_id, business_agent_connector_input, opts = {}) ⇒ BusinessAgentConnector

Create a connector Base URL plus how to authenticate (OAuth client credentials, API key or none). Names are unique per number. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 176

def create_business_agent_connector(, business_agent_connector_input, opts = {})
  data, _status_code, _headers = create_business_agent_connector_with_http_info(, business_agent_connector_input, opts)
  data
end

#create_business_agent_connector_tool(account_id, connector_id, business_agent_connector_tool_input, opts = {}) ⇒ BusinessAgentConnectorTool

Create a connector tool One operation on the connector, with the request definition Meta uses to build the outbound call from the conversation. Type the body params explicitly. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • business_agent_connector_tool_input (BusinessAgentConnectorToolInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



251
252
253
254
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 251

def create_business_agent_connector_tool(, connector_id, business_agent_connector_tool_input, opts = {})
  data, _status_code, _headers = create_business_agent_connector_tool_with_http_info(, connector_id, business_agent_connector_tool_input, opts)
  data
end

#create_business_agent_connector_tool_with_http_info(account_id, connector_id, business_agent_connector_tool_input, opts = {}) ⇒ Array<(BusinessAgentConnectorTool, Integer, Hash)>

Create a connector tool One operation on the connector, with the request definition Meta uses to build the outbound call from the conversation. Type the body params explicitly. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • business_agent_connector_tool_input (BusinessAgentConnectorToolInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentConnectorTool data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 263

def create_business_agent_connector_tool_with_http_info(, connector_id, business_agent_connector_tool_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.create_business_agent_connector_tool ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.create_business_agent_connector_tool"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.create_business_agent_connector_tool"
  end
  # verify the required parameter 'business_agent_connector_tool_input' is set
  if @api_client.config.client_side_validation && business_agent_connector_tool_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_connector_tool_input' when calling BusinessAgentApi.create_business_agent_connector_tool"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_connector_tool_input)

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

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

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

#create_business_agent_connector_with_http_info(account_id, business_agent_connector_input, opts = {}) ⇒ Array<(BusinessAgentConnector, Integer, Hash)>

Create a connector Base URL plus how to authenticate (OAuth client credentials, API key or none). Names are unique per number. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentConnector data, response status code and response headers



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 187

def create_business_agent_connector_with_http_info(, business_agent_connector_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.create_business_agent_connector ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.create_business_agent_connector"
  end
  # verify the required parameter 'business_agent_connector_input' is set
  if @api_client.config.client_side_validation && business_agent_connector_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_connector_input' when calling BusinessAgentApi.create_business_agent_connector"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_connector_input)

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

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

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

#create_business_agent_faq(account_id, business_agent_faq_input, opts = {}) ⇒ BusinessAgentFaq

Create a FAQ One specific question per entry; beyond a few hundred entries retrieval quality drops. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



330
331
332
333
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 330

def create_business_agent_faq(, business_agent_faq_input, opts = {})
  data, _status_code, _headers = create_business_agent_faq_with_http_info(, business_agent_faq_input, opts)
  data
end

#create_business_agent_faq_with_http_info(account_id, business_agent_faq_input, opts = {}) ⇒ Array<(BusinessAgentFaq, Integer, Hash)>

Create a FAQ One specific question per entry; beyond a few hundred entries retrieval quality drops. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentFaq data, response status code and response headers



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 341

def create_business_agent_faq_with_http_info(, business_agent_faq_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.create_business_agent_faq ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.create_business_agent_faq"
  end
  # verify the required parameter 'business_agent_faq_input' is set
  if @api_client.config.client_side_validation && business_agent_faq_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_faq_input' when calling BusinessAgentApi.create_business_agent_faq"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/faqs'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_faq_input)

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

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

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

#create_business_agent_skill(account_id, business_agent_skill_input, opts = {}) ⇒ BusinessAgentSkill

Create a skill Behavioral instructions in the brand voice. Reads back pending_review until Meta content review passes it. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



404
405
406
407
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 404

def create_business_agent_skill(, business_agent_skill_input, opts = {})
  data, _status_code, _headers = create_business_agent_skill_with_http_info(, business_agent_skill_input, opts)
  data
end

#create_business_agent_skill_with_http_info(account_id, business_agent_skill_input, opts = {}) ⇒ Array<(BusinessAgentSkill, Integer, Hash)>

Create a skill Behavioral instructions in the brand voice. Reads back `pending_review` until Meta content review passes it. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentSkill data, response status code and response headers



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 415

def create_business_agent_skill_with_http_info(, business_agent_skill_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.create_business_agent_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.create_business_agent_skill"
  end
  # verify the required parameter 'business_agent_skill_input' is set
  if @api_client.config.client_side_validation && business_agent_skill_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_skill_input' when calling BusinessAgentApi.create_business_agent_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/skills'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_skill_input)

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

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

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

#create_business_agent_ui_skill(account_id, business_agent_ui_skill_input, opts = {}) ⇒ BusinessAgentUiSkill

Create a UI skill Tells the agent when to send a rich component (CTA URL button, image, carousel, list, reply buttons, location, Flow) and what to put in it. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



478
479
480
481
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 478

def create_business_agent_ui_skill(, business_agent_ui_skill_input, opts = {})
  data, _status_code, _headers = create_business_agent_ui_skill_with_http_info(, business_agent_ui_skill_input, opts)
  data
end

#create_business_agent_ui_skill_with_http_info(account_id, business_agent_ui_skill_input, opts = {}) ⇒ Array<(BusinessAgentUiSkill, Integer, Hash)>

Create a UI skill Tells the agent when to send a rich component (CTA URL button, image, carousel, list, reply buttons, location, Flow) and what to put in it. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentUiSkill data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 489

def create_business_agent_ui_skill_with_http_info(, business_agent_ui_skill_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.create_business_agent_ui_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.create_business_agent_ui_skill"
  end
  # verify the required parameter 'business_agent_ui_skill_input' is set
  if @api_client.config.client_side_validation && business_agent_ui_skill_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_ui_skill_input' when calling BusinessAgentApi.create_business_agent_ui_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/ui-skills'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_ui_skill_input)

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

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

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

#delete_business_agent_connector(account_id, connector_id, opts = {}) ⇒ InlineObject

Delete a connector

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



551
552
553
554
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 551

def delete_business_agent_connector(, connector_id, opts = {})
  data, _status_code, _headers = delete_business_agent_connector_with_http_info(, connector_id, opts)
  data
end

#delete_business_agent_connector_tool(account_id, connector_id, tool_id, opts = {}) ⇒ InlineObject

Delete a connector tool

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



619
620
621
622
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 619

def delete_business_agent_connector_tool(, connector_id, tool_id, opts = {})
  data, _status_code, _headers = delete_business_agent_connector_tool_with_http_info(, connector_id, tool_id, opts)
  data
end

#delete_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Delete a connector tool

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



630
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
681
682
683
684
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 630

def delete_business_agent_connector_tool_with_http_info(, connector_id, tool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_connector_tool ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_connector_tool"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.delete_business_agent_connector_tool"
  end
  # verify the required parameter 'tool_id' is set
  if @api_client.config.client_side_validation && tool_id.nil?
    fail ArgumentError, "Missing the required parameter 'tool_id' when calling BusinessAgentApi.delete_business_agent_connector_tool"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s)).sub('{' + 'toolId' + '}', CGI.escape(tool_id.to_s))

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

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

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

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

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

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

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

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

#delete_business_agent_connector_with_http_info(account_id, connector_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Delete a connector

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



561
562
563
564
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 561

def delete_business_agent_connector_with_http_info(, connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_connector ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_connector"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.delete_business_agent_connector"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

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

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

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

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

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

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

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

#delete_business_agent_faq(account_id, faq_id, opts = {}) ⇒ InlineObject

Delete a FAQ

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



691
692
693
694
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 691

def delete_business_agent_faq(, faq_id, opts = {})
  data, _status_code, _headers = delete_business_agent_faq_with_http_info(, faq_id, opts)
  data
end

#delete_business_agent_faq_with_http_info(account_id, faq_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Delete a FAQ

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



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
747
748
749
750
751
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 701

def delete_business_agent_faq_with_http_info(, faq_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_faq ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_faq"
  end
  # verify the required parameter 'faq_id' is set
  if @api_client.config.client_side_validation && faq_id.nil?
    fail ArgumentError, "Missing the required parameter 'faq_id' when calling BusinessAgentApi.delete_business_agent_faq"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/faqs/{faqId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'faqId' + '}', CGI.escape(faq_id.to_s))

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

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

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

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

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

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

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

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

#delete_business_agent_file(account_id, file_id, opts = {}) ⇒ InlineObject

Delete a knowledge file

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



758
759
760
761
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 758

def delete_business_agent_file(, file_id, opts = {})
  data, _status_code, _headers = delete_business_agent_file_with_http_info(, file_id, opts)
  data
end

#delete_business_agent_file_with_http_info(account_id, file_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Delete a knowledge file

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



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
813
814
815
816
817
818
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 768

def delete_business_agent_file_with_http_info(, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_file ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_file"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling BusinessAgentApi.delete_business_agent_file"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/files/{fileId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))

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

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

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

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

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

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

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

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

#delete_business_agent_skill(account_id, skill_id, opts = {}) ⇒ InlineObject

Delete a skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



825
826
827
828
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 825

def delete_business_agent_skill(, skill_id, opts = {})
  data, _status_code, _headers = delete_business_agent_skill_with_http_info(, skill_id, opts)
  data
end

#delete_business_agent_skill_with_http_info(account_id, skill_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Delete a skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



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
879
880
881
882
883
884
885
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 835

def delete_business_agent_skill_with_http_info(, skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_skill"
  end
  # verify the required parameter 'skill_id' is set
  if @api_client.config.client_side_validation && skill_id.nil?
    fail ArgumentError, "Missing the required parameter 'skill_id' when calling BusinessAgentApi.delete_business_agent_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/skills/{skillId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'skillId' + '}', CGI.escape(skill_id.to_s))

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

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

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

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

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

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

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

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

#delete_business_agent_ui_skill(account_id, ui_skill_id, opts = {}) ⇒ InlineObject

Delete a UI skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



892
893
894
895
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 892

def delete_business_agent_ui_skill(, ui_skill_id, opts = {})
  data, _status_code, _headers = delete_business_agent_ui_skill_with_http_info(, ui_skill_id, opts)
  data
end

#delete_business_agent_ui_skill_with_http_info(account_id, ui_skill_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Delete a UI skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



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
945
946
947
948
949
950
951
952
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 902

def delete_business_agent_ui_skill_with_http_info(, ui_skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_ui_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_ui_skill"
  end
  # verify the required parameter 'ui_skill_id' is set
  if @api_client.config.client_side_validation && ui_skill_id.nil?
    fail ArgumentError, "Missing the required parameter 'ui_skill_id' when calling BusinessAgentApi.delete_business_agent_ui_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'uiSkillId' + '}', CGI.escape(ui_skill_id.to_s))

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

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

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

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

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

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

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

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

#delete_business_agent_website(account_id, website_id, opts = {}) ⇒ InlineObject

Remove a crawled website

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



959
960
961
962
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 959

def delete_business_agent_website(, website_id, opts = {})
  data, _status_code, _headers = delete_business_agent_website_with_http_info(, website_id, opts)
  data
end

#delete_business_agent_website_with_http_info(account_id, website_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Remove a crawled website

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



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
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 969

def delete_business_agent_website_with_http_info(, website_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.delete_business_agent_website ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.delete_business_agent_website"
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling BusinessAgentApi.delete_business_agent_website"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/websites/{websiteId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'websiteId' + '}', CGI.escape(website_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_budget(account_id, opts = {}) ⇒ GetBusinessAgentBudget200Response

Get usage budgets Caps over rolling windows for the Business Manager that owns the number. An empty list means unlimited.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1026
1027
1028
1029
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1026

def get_business_agent_budget(, opts = {})
  data, _status_code, _headers = get_business_agent_budget_with_http_info(, opts)
  data
end

#get_business_agent_budget_with_http_info(account_id, opts = {}) ⇒ Array<(GetBusinessAgentBudget200Response, Integer, Hash)>

Get usage budgets Caps over rolling windows for the Business Manager that owns the number. An empty list means unlimited.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



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
1077
1078
1079
1080
1081
1082
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1036

def get_business_agent_budget_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_budget ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_budget"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/budget'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_business_information(account_id, opts = {}) ⇒ BusinessAgentBusinessInformation

Get business information Payment methods, return policy, how to buy, shipping, description and contact details the agent answers from. Empty values until configured.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1089
1090
1091
1092
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1089

def get_business_agent_business_information(, opts = {})
  data, _status_code, _headers = get_business_agent_business_information_with_http_info(, opts)
  data
end

#get_business_agent_business_information_with_http_info(account_id, opts = {}) ⇒ Array<(BusinessAgentBusinessInformation, Integer, Hash)>

Get business information Payment methods, return policy, how to buy, shipping, description and contact details the agent answers from. Empty values until configured.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



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
1143
1144
1145
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1099

def get_business_agent_business_information_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_business_information ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_business_information"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/business-information'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_connector(account_id, connector_id, opts = {}) ⇒ BusinessAgentConnector

Get a connector

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1152
1153
1154
1155
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1152

def get_business_agent_connector(, connector_id, opts = {})
  data, _status_code, _headers = get_business_agent_connector_with_http_info(, connector_id, opts)
  data
end

#get_business_agent_connector_logs(account_id, connector_id, opts = {}) ⇒ GetBusinessAgentConnectorLogs200Response

Get connector failure logs Third-party failures over the last 7 days (window at most 7 days, default the last 24 hours). Each entry carries failure_code_name and error_message.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :start_time (Integer) —

    Unix seconds.

  • :end_time (Integer) —

    Unix seconds.

  • :limit (Integer)
  • :tool_id (String)
  • :include_stats (Boolean) —

    Add success rate and latency percentiles.

  • :summary_only (Boolean) —

    Aggregate failure patterns instead of entries.

  • :top_n (Integer)

Returns:



1227
1228
1229
1230
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1227

def get_business_agent_connector_logs(, connector_id, opts = {})
  data, _status_code, _headers = get_business_agent_connector_logs_with_http_info(, connector_id, opts)
  data
end

#get_business_agent_connector_logs_with_http_info(account_id, connector_id, opts = {}) ⇒ Array<(GetBusinessAgentConnectorLogs200Response, Integer, Hash)>

Get connector failure logs Third-party failures over the last 7 days (window at most 7 days, default the last 24 hours). Each entry carries `failure_code_name` and `error_message`.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :start_time (Integer) —

    Unix seconds.

  • :end_time (Integer) —

    Unix seconds.

  • :limit (Integer)
  • :tool_id (String)
  • :include_stats (Boolean) —

    Add success rate and latency percentiles.

  • :summary_only (Boolean) —

    Aggregate failure patterns instead of entries.

  • :top_n (Integer)

Returns:



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
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1245

def get_business_agent_connector_logs_with_http_info(, connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_connector_logs ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_connector_logs"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.get_business_agent_connector_logs"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BusinessAgentApi.get_business_agent_connector_logs, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BusinessAgentApi.get_business_agent_connector_logs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'top_n'].nil? && opts[:'top_n'] > 50
    fail ArgumentError, 'invalid value for "opts[:"top_n"]" when calling BusinessAgentApi.get_business_agent_connector_logs, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'top_n'].nil? && opts[:'top_n'] < 1
    fail ArgumentError, 'invalid value for "opts[:"top_n"]" when calling BusinessAgentApi.get_business_agent_connector_logs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/logs'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startTime'] = opts[:'start_time'] if !opts[:'start_time'].nil?
  query_params[:'endTime'] = opts[:'end_time'] if !opts[:'end_time'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'toolId'] = opts[:'tool_id'] if !opts[:'tool_id'].nil?
  query_params[:'includeStats'] = opts[:'include_stats'] if !opts[:'include_stats'].nil?
  query_params[:'summaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
  query_params[:'topN'] = opts[:'top_n'] if !opts[:'top_n'].nil?

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

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

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

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

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

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

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

#get_business_agent_connector_tool(account_id, connector_id, tool_id, opts = {}) ⇒ BusinessAgentConnectorTool

Get a connector tool

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1326
1327
1328
1329
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1326

def get_business_agent_connector_tool(, connector_id, tool_id, opts = {})
  data, _status_code, _headers = get_business_agent_connector_tool_with_http_info(, connector_id, tool_id, opts)
  data
end

#get_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, opts = {}) ⇒ Array<(BusinessAgentConnectorTool, Integer, Hash)>

Get a connector tool

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentConnectorTool data, response status code and response headers



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1337

def get_business_agent_connector_tool_with_http_info(, connector_id, tool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_connector_tool ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_connector_tool"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.get_business_agent_connector_tool"
  end
  # verify the required parameter 'tool_id' is set
  if @api_client.config.client_side_validation && tool_id.nil?
    fail ArgumentError, "Missing the required parameter 'tool_id' when calling BusinessAgentApi.get_business_agent_connector_tool"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s)).sub('{' + 'toolId' + '}', CGI.escape(tool_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_connector_with_http_info(account_id, connector_id, opts = {}) ⇒ Array<(BusinessAgentConnector, Integer, Hash)>

Get a connector

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentConnector data, response status code and response headers



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
1209
1210
1211
1212
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1162

def get_business_agent_connector_with_http_info(, connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_connector ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_connector"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.get_business_agent_connector"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_event(account_id, event_id, opts = {}) ⇒ BusinessAgentEventStatus

Get a business event status

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1398
1399
1400
1401
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1398

def get_business_agent_event(, event_id, opts = {})
  data, _status_code, _headers = get_business_agent_event_with_http_info(, event_id, opts)
  data
end

#get_business_agent_event_with_http_info(account_id, event_id, opts = {}) ⇒ Array<(BusinessAgentEventStatus, Integer, Hash)>

Get a business event status

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentEventStatus data, response status code and response headers



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1408

def get_business_agent_event_with_http_info(, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_event ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_event"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling BusinessAgentApi.get_business_agent_event"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/events/{eventId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"BusinessAgentApi.get_business_agent_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessAgentApi#get_business_agent_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_business_agent_faq(account_id, faq_id, opts = {}) ⇒ BusinessAgentFaq

Get a FAQ

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1465
1466
1467
1468
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1465

def get_business_agent_faq(, faq_id, opts = {})
  data, _status_code, _headers = get_business_agent_faq_with_http_info(, faq_id, opts)
  data
end

#get_business_agent_faq_with_http_info(account_id, faq_id, opts = {}) ⇒ Array<(BusinessAgentFaq, Integer, Hash)>

Get a FAQ

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentFaq data, response status code and response headers



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1475

def get_business_agent_faq_with_http_info(, faq_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_faq ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_faq"
  end
  # verify the required parameter 'faq_id' is set
  if @api_client.config.client_side_validation && faq_id.nil?
    fail ArgumentError, "Missing the required parameter 'faq_id' when calling BusinessAgentApi.get_business_agent_faq"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/faqs/{faqId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'faqId' + '}', CGI.escape(faq_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_file(account_id, file_id, opts = {}) ⇒ BusinessAgentKnowledgeFile

Get a knowledge file

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1532
1533
1534
1535
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1532

def get_business_agent_file(, file_id, opts = {})
  data, _status_code, _headers = get_business_agent_file_with_http_info(, file_id, opts)
  data
end

#get_business_agent_file_with_http_info(account_id, file_id, opts = {}) ⇒ Array<(BusinessAgentKnowledgeFile, Integer, Hash)>

Get a knowledge file

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentKnowledgeFile data, response status code and response headers



1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1542

def get_business_agent_file_with_http_info(, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_file ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_file"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling BusinessAgentApi.get_business_agent_file"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/files/{fileId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_skill(account_id, skill_id, opts = {}) ⇒ BusinessAgentSkill

Get a skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1599
1600
1601
1602
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1599

def get_business_agent_skill(, skill_id, opts = {})
  data, _status_code, _headers = get_business_agent_skill_with_http_info(, skill_id, opts)
  data
end

#get_business_agent_skill_with_http_info(account_id, skill_id, opts = {}) ⇒ Array<(BusinessAgentSkill, Integer, Hash)>

Get a skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentSkill data, response status code and response headers



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1609

def get_business_agent_skill_with_http_info(, skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_skill"
  end
  # verify the required parameter 'skill_id' is set
  if @api_client.config.client_side_validation && skill_id.nil?
    fail ArgumentError, "Missing the required parameter 'skill_id' when calling BusinessAgentApi.get_business_agent_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/skills/{skillId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'skillId' + '}', CGI.escape(skill_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_status(account_id, opts = {}) ⇒ BusinessAgentStatus

Get agent setup status One read that says where the merchant is: whether the number is eligible, whether the Meta Business Agent terms are accepted, whether an agent exists, whether it is on, and its settings. manualSteps lists what Zernio can verify is still pending (accepting the terms in WhatsApp Manager); unverifiedSteps lists what Meta exposes no state for (the payment method in Billing Hub). Never fails for those pre-setup states; it reports them as flags.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1666
1667
1668
1669
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1666

def get_business_agent_status(, opts = {})
  data, _status_code, _headers = get_business_agent_status_with_http_info(, opts)
  data
end

#get_business_agent_status_with_http_info(account_id, opts = {}) ⇒ Array<(BusinessAgentStatus, Integer, Hash)>

Get agent setup status One read that says where the merchant is: whether the number is eligible, whether the Meta Business Agent terms are accepted, whether an agent exists, whether it is on, and its settings. `manualSteps` lists what Zernio can verify is still pending (accepting the terms in WhatsApp Manager); `unverifiedSteps` lists what Meta exposes no state for (the payment method in Billing Hub). Never fails for those pre-setup states; it reports them as flags.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentStatus data, response status code and response headers



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1676

def get_business_agent_status_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_status ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_status"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_ui_skill(account_id, ui_skill_id, opts = {}) ⇒ BusinessAgentUiSkill

Get a UI skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1729
1730
1731
1732
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1729

def get_business_agent_ui_skill(, ui_skill_id, opts = {})
  data, _status_code, _headers = get_business_agent_ui_skill_with_http_info(, ui_skill_id, opts)
  data
end

#get_business_agent_ui_skill_with_http_info(account_id, ui_skill_id, opts = {}) ⇒ Array<(BusinessAgentUiSkill, Integer, Hash)>

Get a UI skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentUiSkill data, response status code and response headers



1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1739

def get_business_agent_ui_skill_with_http_info(, ui_skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_ui_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_ui_skill"
  end
  # verify the required parameter 'ui_skill_id' is set
  if @api_client.config.client_side_validation && ui_skill_id.nil?
    fail ArgumentError, "Missing the required parameter 'ui_skill_id' when calling BusinessAgentApi.get_business_agent_ui_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'uiSkillId' + '}', CGI.escape(ui_skill_id.to_s))

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

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

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

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

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

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

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

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

#get_business_agent_website(account_id, website_id, opts = {}) ⇒ BusinessAgentWebsite

Get a crawled website

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1796
1797
1798
1799
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1796

def get_business_agent_website(, website_id, opts = {})
  data, _status_code, _headers = get_business_agent_website_with_http_info(, website_id, opts)
  data
end

#get_business_agent_website_with_http_info(account_id, website_id, opts = {}) ⇒ Array<(BusinessAgentWebsite, Integer, Hash)>

Get a crawled website

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentWebsite data, response status code and response headers



1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1806

def get_business_agent_website_with_http_info(, website_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.get_business_agent_website ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.get_business_agent_website"
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling BusinessAgentApi.get_business_agent_website"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/websites/{websiteId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'websiteId' + '}', CGI.escape(website_id.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_allowlist(account_id, opts = {}) ⇒ ListBusinessAgentAllowlist200Response

List allowlisted consumers Consumers the agent answers while ai_audience is ALLOWLISTED_ONLY.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1863
1864
1865
1866
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1863

def list_business_agent_allowlist(, opts = {})
  data, _status_code, _headers = list_business_agent_allowlist_with_http_info(, opts)
  data
end

#list_business_agent_allowlist_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentAllowlist200Response, Integer, Hash)>

List allowlisted consumers Consumers the agent answers while `ai_audience` is ALLOWLISTED_ONLY.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1873

def list_business_agent_allowlist_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_allowlist ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_allowlist"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/allowlist'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_connector_tools(account_id, connector_id, opts = {}) ⇒ ListBusinessAgentConnectorTools200Response

List connector tools

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1926
1927
1928
1929
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1926

def list_business_agent_connector_tools(, connector_id, opts = {})
  data, _status_code, _headers = list_business_agent_connector_tools_with_http_info(, connector_id, opts)
  data
end

#list_business_agent_connector_tools_with_http_info(account_id, connector_id, opts = {}) ⇒ Array<(ListBusinessAgentConnectorTools200Response, Integer, Hash)>

List connector tools

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1936

def list_business_agent_connector_tools_with_http_info(, connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_connector_tools ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_connector_tools"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.list_business_agent_connector_tools"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_connectors(account_id, opts = {}) ⇒ ListBusinessAgentConnectors200Response

List connectors External APIs the agent may call. connection_status says whether Meta can currently reach each one.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



1993
1994
1995
1996
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 1993

def list_business_agent_connectors(, opts = {})
  data, _status_code, _headers = list_business_agent_connectors_with_http_info(, opts)
  data
end

#list_business_agent_connectors_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentConnectors200Response, Integer, Hash)>

List connectors External APIs the agent may call. `connection_status` says whether Meta can currently reach each one.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2003

def list_business_agent_connectors_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_connectors ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_connectors"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_faqs(account_id, opts = {}) ⇒ ListBusinessAgentFaqs200Response

List FAQs

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2055
2056
2057
2058
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2055

def list_business_agent_faqs(, opts = {})
  data, _status_code, _headers = list_business_agent_faqs_with_http_info(, opts)
  data
end

#list_business_agent_faqs_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentFaqs200Response, Integer, Hash)>

List FAQs

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2064

def list_business_agent_faqs_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_faqs ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_faqs"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/faqs'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_files(account_id, opts = {}) ⇒ ListBusinessAgentFiles200Response

List knowledge files

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2116
2117
2118
2119
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2116

def list_business_agent_files(, opts = {})
  data, _status_code, _headers = list_business_agent_files_with_http_info(, opts)
  data
end

#list_business_agent_files_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentFiles200Response, Integer, Hash)>

List knowledge files

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2125

def list_business_agent_files_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_files ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_files"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/files'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_settings(account_id, opts = {}) ⇒ ListBusinessAgentSettings200Response

List agent settings Settings of every agent configured on the number (normally one). Pass agentId to read one.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :agent_id (String)

Returns:



2179
2180
2181
2182
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2179

def list_business_agent_settings(, opts = {})
  data, _status_code, _headers = list_business_agent_settings_with_http_info(, opts)
  data
end

#list_business_agent_settings_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentSettings200Response, Integer, Hash)>

List agent settings Settings of every agent configured on the number (normally one). Pass `agentId` to read one.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :agent_id (String)

Returns:



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2190

def list_business_agent_settings_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_settings ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_settings"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/settings'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_skills(account_id, opts = {}) ⇒ ListBusinessAgentSkills200Response

List skills

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2243
2244
2245
2246
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2243

def list_business_agent_skills(, opts = {})
  data, _status_code, _headers = list_business_agent_skills_with_http_info(, opts)
  data
end

#list_business_agent_skills_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentSkills200Response, Integer, Hash)>

List skills

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2252

def list_business_agent_skills_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_skills ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_skills"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/skills'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_ui_skills(account_id, opts = {}) ⇒ ListBusinessAgentUiSkills200Response

List UI skills Cursor paged; follow paging.cursors.after until paging.next is absent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :before (String)
  • :after (String)
  • :limit (Integer)

Returns:



2308
2309
2310
2311
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2308

def list_business_agent_ui_skills(, opts = {})
  data, _status_code, _headers = list_business_agent_ui_skills_with_http_info(, opts)
  data
end

#list_business_agent_ui_skills_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentUiSkills200Response, Integer, Hash)>

List UI skills Cursor paged; follow `paging.cursors.after` until `paging.next` is absent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :before (String)
  • :after (String)
  • :limit (Integer)

Returns:



2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2321

def list_business_agent_ui_skills_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_ui_skills ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_ui_skills"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BusinessAgentApi.list_business_agent_ui_skills, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BusinessAgentApi.list_business_agent_ui_skills, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/ui-skills'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#list_business_agent_websites(account_id, opts = {}) ⇒ ListBusinessAgentWebsites200Response

List crawled websites

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2384
2385
2386
2387
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2384

def list_business_agent_websites(, opts = {})
  data, _status_code, _headers = list_business_agent_websites_with_http_info(, opts)
  data
end

#list_business_agent_websites_with_http_info(account_id, opts = {}) ⇒ Array<(ListBusinessAgentWebsites200Response, Integer, Hash)>

List crawled websites

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2393

def list_business_agent_websites_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.list_business_agent_websites ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.list_business_agent_websites"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/websites'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#onboard_business_agent(account_id, opts = {}) ⇒ OnboardBusinessAgent201Response

Create the agent Creates the Meta Business Agent on the number and schedules Meta's data preparation. Requires the terms to be accepted; eligibility is checked first and an ineligible number answers 403 business_agent_not_eligible. Not idempotent: call it once, then configure knowledge and skills, then enable it through the settings. Configuration calls made in the first minute can still answer business_agent_not_found while Meta prepares the workspace.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2446
2447
2448
2449
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2446

def onboard_business_agent(, opts = {})
  data, _status_code, _headers = onboard_business_agent_with_http_info(, opts)
  data
end

#onboard_business_agent_with_http_info(account_id, opts = {}) ⇒ Array<(OnboardBusinessAgent201Response, Integer, Hash)>

Create the agent Creates the Meta Business Agent on the number and schedules Meta's data preparation. Requires the terms to be accepted; eligibility is checked first and an ineligible number answers 403 `business_agent_not_eligible`. Not idempotent: call it once, then configure knowledge and skills, then enable it through the settings. Configuration calls made in the first minute can still answer `business_agent_not_found` while Meta prepares the workspace.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2456

def onboard_business_agent_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.onboard_business_agent ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.onboard_business_agent"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/onboard'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

#read_business_agent_evals(account_id, opts = {}) ⇒ Hash<String, Object>

Read evaluation data Without query parameters, lists the evaluation scenarios (eval_cases). With jobId, polls a run started with POST. With summaryIds, returns the aggregated insight reports. With evalIds, returns per-conversation evaluation details. One of the three at a time.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :job_id (String)
  • :summary_ids (String) —

    Comma-separated summary ids.

  • :eval_ids (String) —

    Comma-separated evaluation ids.

Returns:

  • (Hash<String, Object>) 


2512
2513
2514
2515
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2512

def read_business_agent_evals(, opts = {})
  data, _status_code, _headers = read_business_agent_evals_with_http_info(, opts)
  data
end

#read_business_agent_evals_with_http_info(account_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Read evaluation data Without query parameters, lists the evaluation scenarios (`eval_cases`). With `jobId`, polls a run started with POST. With `summaryIds`, returns the aggregated insight reports. With `evalIds`, returns per-conversation evaluation details. One of the three at a time.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :job_id (String)
  • :summary_ids (String) —

    Comma-separated summary ids.

  • :eval_ids (String) —

    Comma-separated evaluation ids.

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2525

def read_business_agent_evals_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.read_business_agent_evals ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.read_business_agent_evals"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/evals'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'jobId'] = opts[:'job_id'] if !opts[:'job_id'].nil?
  query_params[:'summaryIds'] = opts[:'summary_ids'] if !opts[:'summary_ids'].nil?
  query_params[:'evalIds'] = opts[:'eval_ids'] if !opts[:'eval_ids'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

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

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

#refresh_business_agent_connector_tools(account_id, connector_id, opts = {}) ⇒ BusinessAgentConnector

Refresh MCP connector tools Re-discovers the tools of an MCP connector. A failed discovery keeps the previous tool set and reports an ERROR sync status inside a 200.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2582
2583
2584
2585
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2582

def refresh_business_agent_connector_tools(, connector_id, opts = {})
  data, _status_code, _headers = refresh_business_agent_connector_tools_with_http_info(, connector_id, opts)
  data
end

#refresh_business_agent_connector_tools_with_http_info(account_id, connector_id, opts = {}) ⇒ Array<(BusinessAgentConnector, Integer, Hash)>

Refresh MCP connector tools Re-discovers the tools of an MCP connector. A failed discovery keeps the previous tool set and reports an ERROR sync status inside a 200.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentConnector data, response status code and response headers



2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2593

def refresh_business_agent_connector_tools_with_http_info(, connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.refresh_business_agent_connector_tools ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.refresh_business_agent_connector_tools"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.refresh_business_agent_connector_tools"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/refresh-tools'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

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

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

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

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

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

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

#remove_business_agent_allowlist_entry(account_id, entry_id, opts = {}) ⇒ InlineObject

Remove an allowlisted consumer

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2650
2651
2652
2653
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2650

def remove_business_agent_allowlist_entry(, entry_id, opts = {})
  data, _status_code, _headers = remove_business_agent_allowlist_entry_with_http_info(, entry_id, opts)
  data
end

#remove_business_agent_allowlist_entry_with_http_info(account_id, entry_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Remove an allowlisted consumer

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2660

def remove_business_agent_allowlist_entry_with_http_info(, entry_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.remove_business_agent_allowlist_entry ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.remove_business_agent_allowlist_entry"
  end
  # verify the required parameter 'entry_id' is set
  if @api_client.config.client_side_validation && entry_id.nil?
    fail ArgumentError, "Missing the required parameter 'entry_id' when calling BusinessAgentApi.remove_business_agent_allowlist_entry"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/allowlist/{entryId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'entryId' + '}', CGI.escape(entry_id.to_s))

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

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

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

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

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

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

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

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

#replace_business_agent_budget(account_id, get_business_agent_budget200_response, opts = {}) ⇒ GetBusinessAgentBudget200Response

Replace usage budgets The full desired set: budgets left out are removed, an empty list returns to unlimited. Pass budget_id to edit one in place. When a cap is hit the agent finishes its turn, stops answering and hands the thread to a human until the window rolls over.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2718
2719
2720
2721
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2718

def replace_business_agent_budget(, get_business_agent_budget200_response, opts = {})
  data, _status_code, _headers = replace_business_agent_budget_with_http_info(, get_business_agent_budget200_response, opts)
  data
end

#replace_business_agent_budget_with_http_info(account_id, get_business_agent_budget200_response, opts = {}) ⇒ Array<(GetBusinessAgentBudget200Response, Integer, Hash)>

Replace usage budgets The full desired set: budgets left out are removed, an empty list returns to unlimited. Pass `budget_id` to edit one in place. When a cap is hit the agent finishes its turn, stops answering and hands the thread to a human until the window rolls over.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2729

def replace_business_agent_budget_with_http_info(, get_business_agent_budget200_response, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.replace_business_agent_budget ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.replace_business_agent_budget"
  end
  # verify the required parameter 'get_business_agent_budget200_response' is set
  if @api_client.config.client_side_validation && get_business_agent_budget200_response.nil?
    fail ArgumentError, "Missing the required parameter 'get_business_agent_budget200_response' when calling BusinessAgentApi.replace_business_agent_budget"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/budget'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(get_business_agent_budget200_response)

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

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

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

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

#replace_business_agent_business_information(account_id, business_agent_business_information, opts = {}) ⇒ BusinessAgentBusinessInformation

Replace business information Full replacement: every field you send overwrites the stored value; fields you omit are cleared.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2792
2793
2794
2795
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2792

def replace_business_agent_business_information(, business_agent_business_information, opts = {})
  data, _status_code, _headers = replace_business_agent_business_information_with_http_info(, business_agent_business_information, opts)
  data
end

#replace_business_agent_business_information_with_http_info(account_id, business_agent_business_information, opts = {}) ⇒ Array<(BusinessAgentBusinessInformation, Integer, Hash)>

Replace business information Full replacement: every field you send overwrites the stored value; fields you omit are cleared.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



2803
2804
2805
2806
2807
2808
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/business_agent_api.rb', line 2803

def replace_business_agent_business_information_with_http_info(, business_agent_business_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.replace_business_agent_business_information ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.replace_business_agent_business_information"
  end
  # verify the required parameter 'business_agent_business_information' is set
  if @api_client.config.client_side_validation && business_agent_business_information.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_business_information' when calling BusinessAgentApi.replace_business_agent_business_information"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/business-information'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_business_information)

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

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

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

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

#reset_business_agent_business_information(account_id, opts = {}) ⇒ InlineObject

Reset business information

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



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

def reset_business_agent_business_information(, opts = {})
  data, _status_code, _headers = reset_business_agent_business_information_with_http_info(, opts)
  data
end

#reset_business_agent_business_information_with_http_info(account_id, opts = {}) ⇒ Array<(InlineObject, Integer, Hash)>

Reset business information

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    InlineObject data, response status code and response headers



2873
2874
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
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2873

def reset_business_agent_business_information_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.reset_business_agent_business_information ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.reset_business_agent_business_information"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/business-information'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#run_business_agent_connector_tool(account_id, connector_id, tool_id, run_business_agent_connector_tool_request, opts = {}) ⇒ RunBusinessAgentConnectorTool200Response

Run a connector tool once Executes the tool against the merchant API and returns the raw upstream result, to check a connector before the agent relies on it.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • run_business_agent_connector_tool_request (RunBusinessAgentConnectorToolRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2929
2930
2931
2932
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2929

def run_business_agent_connector_tool(, connector_id, tool_id, run_business_agent_connector_tool_request, opts = {})
  data, _status_code, _headers = run_business_agent_connector_tool_with_http_info(, connector_id, tool_id, run_business_agent_connector_tool_request, opts)
  data
end

#run_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, run_business_agent_connector_tool_request, opts = {}) ⇒ Array<(RunBusinessAgentConnectorTool200Response, Integer, Hash)>

Run a connector tool once Executes the tool against the merchant API and returns the raw upstream result, to check a connector before the agent relies on it.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • run_business_agent_connector_tool_request (RunBusinessAgentConnectorToolRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 2942

def run_business_agent_connector_tool_with_http_info(, connector_id, tool_id, run_business_agent_connector_tool_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.run_business_agent_connector_tool ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.run_business_agent_connector_tool"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.run_business_agent_connector_tool"
  end
  # verify the required parameter 'tool_id' is set
  if @api_client.config.client_side_validation && tool_id.nil?
    fail ArgumentError, "Missing the required parameter 'tool_id' when calling BusinessAgentApi.run_business_agent_connector_tool"
  end
  # verify the required parameter 'run_business_agent_connector_tool_request' is set
  if @api_client.config.client_side_validation && run_business_agent_connector_tool_request.nil?
    fail ArgumentError, "Missing the required parameter 'run_business_agent_connector_tool_request' when calling BusinessAgentApi.run_business_agent_connector_tool"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}/run'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s)).sub('{' + 'toolId' + '}', CGI.escape(tool_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(run_business_agent_connector_tool_request)

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

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

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

#send_business_agent_event(account_id, send_business_agent_event_request, opts = {}) ⇒ SendBusinessAgentEvent202Response

Send a business event Tell the agent something happened in your systems (order shipped, document verified) so it messages the consumer about it. The consumer must already have a conversation with the number. Answers 202 with the event id; poll it for the outcome.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3013
3014
3015
3016
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3013

def send_business_agent_event(, send_business_agent_event_request, opts = {})
  data, _status_code, _headers = send_business_agent_event_with_http_info(, send_business_agent_event_request, opts)
  data
end

#send_business_agent_event_with_http_info(account_id, send_business_agent_event_request, opts = {}) ⇒ Array<(SendBusinessAgentEvent202Response, Integer, Hash)>

Send a business event Tell the agent something happened in your systems (order shipped, document verified) so it messages the consumer about it. The consumer must already have a conversation with the number. Answers 202 with the event id; poll it for the outcome.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3024

def send_business_agent_event_with_http_info(, send_business_agent_event_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.send_business_agent_event ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.send_business_agent_event"
  end
  # verify the required parameter 'send_business_agent_event_request' is set
  if @api_client.config.client_side_validation && send_business_agent_event_request.nil?
    fail ArgumentError, "Missing the required parameter 'send_business_agent_event_request' when calling BusinessAgentApi.send_business_agent_event"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/events'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(send_business_agent_event_request)

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

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

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

#send_business_agent_test_message(account_id, send_business_agent_test_message_request, opts = {}) ⇒ BusinessAgentTestMessageResponse

Send a test message Runs the message through the full agent pipeline in Meta sandbox with no WhatsApp user and no token billing. Pass back conversationId to continue a thread. Meta rate-limits it per number per hour.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3087
3088
3089
3090
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3087

def send_business_agent_test_message(, send_business_agent_test_message_request, opts = {})
  data, _status_code, _headers = send_business_agent_test_message_with_http_info(, send_business_agent_test_message_request, opts)
  data
end

#send_business_agent_test_message_with_http_info(account_id, send_business_agent_test_message_request, opts = {}) ⇒ Array<(BusinessAgentTestMessageResponse, Integer, Hash)>

Send a test message Runs the message through the full agent pipeline in Meta sandbox with no WhatsApp user and no token billing. Pass back `conversationId` to continue a thread. Meta rate-limits it per number per hour.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3098

def send_business_agent_test_message_with_http_info(, send_business_agent_test_message_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.send_business_agent_test_message ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.send_business_agent_test_message"
  end
  # verify the required parameter 'send_business_agent_test_message_request' is set
  if @api_client.config.client_side_validation && send_business_agent_test_message_request.nil?
    fail ArgumentError, "Missing the required parameter 'send_business_agent_test_message_request' when calling BusinessAgentApi.send_business_agent_test_message"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/test-messages'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(send_business_agent_test_message_request)

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

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

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

#set_business_agent_connector_credentials(account_id, connector_id, set_business_agent_connector_credentials_request, opts = {}) ⇒ BusinessAgentConnector

Set connector credentials Set or rotate the connector's credentials in place: kind: api_key, kind: oauth (client credentials) or kind: certificate (mTLS client certificate). Meta has no call that removes a credential layer; change the connector's auth_type or delete it instead.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • set_business_agent_connector_credentials_request (SetBusinessAgentConnectorCredentialsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3162
3163
3164
3165
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3162

def set_business_agent_connector_credentials(, connector_id, set_business_agent_connector_credentials_request, opts = {})
  data, _status_code, _headers = set_business_agent_connector_credentials_with_http_info(, connector_id, set_business_agent_connector_credentials_request, opts)
  data
end

#set_business_agent_connector_credentials_with_http_info(account_id, connector_id, set_business_agent_connector_credentials_request, opts = {}) ⇒ Array<(BusinessAgentConnector, Integer, Hash)>

Set connector credentials Set or rotate the connector's credentials in place: `kind: api_key`, `kind: oauth` (client credentials) or `kind: certificate` (mTLS client certificate). Meta has no call that removes a credential layer; change the connector's `auth_type` or delete it instead.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • set_business_agent_connector_credentials_request (SetBusinessAgentConnectorCredentialsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentConnector data, response status code and response headers



3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3174

def set_business_agent_connector_credentials_with_http_info(, connector_id, set_business_agent_connector_credentials_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.set_business_agent_connector_credentials ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.set_business_agent_connector_credentials"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.set_business_agent_connector_credentials"
  end
  # verify the required parameter 'set_business_agent_connector_credentials_request' is set
  if @api_client.config.client_side_validation && set_business_agent_connector_credentials_request.nil?
    fail ArgumentError, "Missing the required parameter 'set_business_agent_connector_credentials_request' when calling BusinessAgentApi.set_business_agent_connector_credentials"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/credentials'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(set_business_agent_connector_credentials_request)

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

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

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

#start_business_agent_eval_run(account_id, start_business_agent_eval_run_request, opts = {}) ⇒ StartBusinessAgentEvalRun202Response

Start an evaluation run Simulates the given scenarios against the agent and scores them. Answers 202 with a job_id to poll with GET.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3241
3242
3243
3244
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3241

def start_business_agent_eval_run(, start_business_agent_eval_run_request, opts = {})
  data, _status_code, _headers = start_business_agent_eval_run_with_http_info(, start_business_agent_eval_run_request, opts)
  data
end

#start_business_agent_eval_run_with_http_info(account_id, start_business_agent_eval_run_request, opts = {}) ⇒ Array<(StartBusinessAgentEvalRun202Response, Integer, Hash)>

Start an evaluation run Simulates the given scenarios against the agent and scores them. Answers 202 with a `job_id` to poll with GET.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3252

def start_business_agent_eval_run_with_http_info(, start_business_agent_eval_run_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.start_business_agent_eval_run ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.start_business_agent_eval_run"
  end
  # verify the required parameter 'start_business_agent_eval_run_request' is set
  if @api_client.config.client_side_validation && start_business_agent_eval_run_request.nil?
    fail ArgumentError, "Missing the required parameter 'start_business_agent_eval_run_request' when calling BusinessAgentApi.start_business_agent_eval_run"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/evals'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(start_business_agent_eval_run_request)

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

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

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

#update_business_agent_connector(account_id, connector_id, business_agent_connector_input, opts = {}) ⇒ BusinessAgentConnector

Update a connector

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • business_agent_connector_input (BusinessAgentConnectorInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3315
3316
3317
3318
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3315

def update_business_agent_connector(, connector_id, business_agent_connector_input, opts = {})
  data, _status_code, _headers = update_business_agent_connector_with_http_info(, connector_id, business_agent_connector_input, opts)
  data
end

#update_business_agent_connector_tool(account_id, connector_id, tool_id, business_agent_connector_tool_input, opts = {}) ⇒ BusinessAgentConnectorTool

Update a connector tool

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • business_agent_connector_tool_input (BusinessAgentConnectorToolInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3394
3395
3396
3397
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3394

def update_business_agent_connector_tool(, connector_id, tool_id, business_agent_connector_tool_input, opts = {})
  data, _status_code, _headers = update_business_agent_connector_tool_with_http_info(, connector_id, tool_id, business_agent_connector_tool_input, opts)
  data
end

#update_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, business_agent_connector_tool_input, opts = {}) ⇒ Array<(BusinessAgentConnectorTool, Integer, Hash)>

Update a connector tool

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • tool_id (String)
  • business_agent_connector_tool_input (BusinessAgentConnectorToolInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentConnectorTool data, response status code and response headers



3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3406

def update_business_agent_connector_tool_with_http_info(, connector_id, tool_id, business_agent_connector_tool_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_connector_tool ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_connector_tool"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.update_business_agent_connector_tool"
  end
  # verify the required parameter 'tool_id' is set
  if @api_client.config.client_side_validation && tool_id.nil?
    fail ArgumentError, "Missing the required parameter 'tool_id' when calling BusinessAgentApi.update_business_agent_connector_tool"
  end
  # verify the required parameter 'business_agent_connector_tool_input' is set
  if @api_client.config.client_side_validation && business_agent_connector_tool_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_connector_tool_input' when calling BusinessAgentApi.update_business_agent_connector_tool"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s)).sub('{' + 'toolId' + '}', CGI.escape(tool_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_connector_tool_input)

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

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

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

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

#update_business_agent_connector_with_http_info(account_id, connector_id, business_agent_connector_input, opts = {}) ⇒ Array<(BusinessAgentConnector, Integer, Hash)>

Update a connector

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • connector_id (String)
  • business_agent_connector_input (BusinessAgentConnectorInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentConnector data, response status code and response headers



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3326

def update_business_agent_connector_with_http_info(, connector_id, business_agent_connector_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_connector ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_connector"
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling BusinessAgentApi.update_business_agent_connector"
  end
  # verify the required parameter 'business_agent_connector_input' is set
  if @api_client.config.client_side_validation && business_agent_connector_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_connector_input' when calling BusinessAgentApi.update_business_agent_connector"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/connectors/{connectorId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'connectorId' + '}', CGI.escape(connector_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_connector_input)

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

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

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

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

#update_business_agent_faq(account_id, faq_id, business_agent_faq_input, opts = {}) ⇒ BusinessAgentFaq

Update a FAQ

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • faq_id (String)
  • business_agent_faq_input (BusinessAgentFaqInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3477
3478
3479
3480
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3477

def update_business_agent_faq(, faq_id, business_agent_faq_input, opts = {})
  data, _status_code, _headers = update_business_agent_faq_with_http_info(, faq_id, business_agent_faq_input, opts)
  data
end

#update_business_agent_faq_with_http_info(account_id, faq_id, business_agent_faq_input, opts = {}) ⇒ Array<(BusinessAgentFaq, Integer, Hash)>

Update a FAQ

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • faq_id (String)
  • business_agent_faq_input (BusinessAgentFaqInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentFaq data, response status code and response headers



3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3488

def update_business_agent_faq_with_http_info(, faq_id, business_agent_faq_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_faq ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_faq"
  end
  # verify the required parameter 'faq_id' is set
  if @api_client.config.client_side_validation && faq_id.nil?
    fail ArgumentError, "Missing the required parameter 'faq_id' when calling BusinessAgentApi.update_business_agent_faq"
  end
  # verify the required parameter 'business_agent_faq_input' is set
  if @api_client.config.client_side_validation && business_agent_faq_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_faq_input' when calling BusinessAgentApi.update_business_agent_faq"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/faqs/{faqId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'faqId' + '}', CGI.escape(faq_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_faq_input)

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

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

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

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

#update_business_agent_settings(account_id, update_business_agent_settings_request, opts = {}) ⇒ BusinessAgentSettings

Update agent settings Partial update: fields you omit keep their value. rollout.enabled: true turns the agent on for new conversations; false stops it on every thread. Turning it on for EVERYONE needs a payment method on the Business Agent billable account (Meta accepts the call but delivers nothing without one); ALLOWLISTED_ONLY does not, which is how you test with a few numbers before billing. never_say_phrases replaces the whole list.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :agent_id (String)

Returns:



3556
3557
3558
3559
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3556

def update_business_agent_settings(, update_business_agent_settings_request, opts = {})
  data, _status_code, _headers = update_business_agent_settings_with_http_info(, update_business_agent_settings_request, opts)
  data
end

#update_business_agent_settings_with_http_info(account_id, update_business_agent_settings_request, opts = {}) ⇒ Array<(BusinessAgentSettings, Integer, Hash)>

Update agent settings Partial update: fields you omit keep their value. `rollout.enabled: true` turns the agent on for new conversations; `false` stops it on every thread. Turning it on for `EVERYONE` needs a payment method on the Business Agent billable account (Meta accepts the call but delivers nothing without one); `ALLOWLISTED_ONLY` does not, which is how you test with a few numbers before billing. `never_say_phrases` replaces the whole list.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Options Hash (opts):

  • :agent_id (String)

Returns:

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

    BusinessAgentSettings data, response status code and response headers



3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3568

def update_business_agent_settings_with_http_info(, update_business_agent_settings_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_settings ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_settings"
  end
  # verify the required parameter 'update_business_agent_settings_request' is set
  if @api_client.config.client_side_validation && update_business_agent_settings_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_business_agent_settings_request' when calling BusinessAgentApi.update_business_agent_settings"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/settings'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(update_business_agent_settings_request)

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

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

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

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

#update_business_agent_skill(account_id, skill_id, business_agent_skill_input, opts = {}) ⇒ BusinessAgentSkill

Update a skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • skill_id (String)
  • business_agent_skill_input (BusinessAgentSkillInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3632
3633
3634
3635
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3632

def update_business_agent_skill(, skill_id, business_agent_skill_input, opts = {})
  data, _status_code, _headers = update_business_agent_skill_with_http_info(, skill_id, business_agent_skill_input, opts)
  data
end

#update_business_agent_skill_with_http_info(account_id, skill_id, business_agent_skill_input, opts = {}) ⇒ Array<(BusinessAgentSkill, Integer, Hash)>

Update a skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • skill_id (String)
  • business_agent_skill_input (BusinessAgentSkillInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentSkill data, response status code and response headers



3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3643

def update_business_agent_skill_with_http_info(, skill_id, business_agent_skill_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_skill"
  end
  # verify the required parameter 'skill_id' is set
  if @api_client.config.client_side_validation && skill_id.nil?
    fail ArgumentError, "Missing the required parameter 'skill_id' when calling BusinessAgentApi.update_business_agent_skill"
  end
  # verify the required parameter 'business_agent_skill_input' is set
  if @api_client.config.client_side_validation && business_agent_skill_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_skill_input' when calling BusinessAgentApi.update_business_agent_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/skills/{skillId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'skillId' + '}', CGI.escape(skill_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_skill_input)

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

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

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

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

#update_business_agent_ui_skill(account_id, ui_skill_id, business_agent_ui_skill_input, opts = {}) ⇒ BusinessAgentUiSkill

Update a UI skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • ui_skill_id (String)
  • business_agent_ui_skill_input (BusinessAgentUiSkillInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3710
3711
3712
3713
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3710

def update_business_agent_ui_skill(, ui_skill_id, business_agent_ui_skill_input, opts = {})
  data, _status_code, _headers = update_business_agent_ui_skill_with_http_info(, ui_skill_id, business_agent_ui_skill_input, opts)
  data
end

#update_business_agent_ui_skill_with_http_info(account_id, ui_skill_id, business_agent_ui_skill_input, opts = {}) ⇒ Array<(BusinessAgentUiSkill, Integer, Hash)>

Update a UI skill

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • ui_skill_id (String)
  • business_agent_ui_skill_input (BusinessAgentUiSkillInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentUiSkill data, response status code and response headers



3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3721

def update_business_agent_ui_skill_with_http_info(, ui_skill_id, business_agent_ui_skill_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_ui_skill ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_ui_skill"
  end
  # verify the required parameter 'ui_skill_id' is set
  if @api_client.config.client_side_validation && ui_skill_id.nil?
    fail ArgumentError, "Missing the required parameter 'ui_skill_id' when calling BusinessAgentApi.update_business_agent_ui_skill"
  end
  # verify the required parameter 'business_agent_ui_skill_input' is set
  if @api_client.config.client_side_validation && business_agent_ui_skill_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_ui_skill_input' when calling BusinessAgentApi.update_business_agent_ui_skill"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'uiSkillId' + '}', CGI.escape(ui_skill_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_ui_skill_input)

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

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

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

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

#update_business_agent_website(account_id, website_id, business_agent_website_input, opts = {}) ⇒ BusinessAgentWebsite

Update a crawled website

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • website_id (String)
  • business_agent_website_input (BusinessAgentWebsiteInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3788
3789
3790
3791
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3788

def update_business_agent_website(, website_id, business_agent_website_input, opts = {})
  data, _status_code, _headers = update_business_agent_website_with_http_info(, website_id, business_agent_website_input, opts)
  data
end

#update_business_agent_website_with_http_info(account_id, website_id, business_agent_website_input, opts = {}) ⇒ Array<(BusinessAgentWebsite, Integer, Hash)>

Update a crawled website

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

  • website_id (String)
  • business_agent_website_input (BusinessAgentWebsiteInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BusinessAgentWebsite data, response status code and response headers



3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3799

def update_business_agent_website_with_http_info(, website_id, business_agent_website_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.update_business_agent_website ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.update_business_agent_website"
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling BusinessAgentApi.update_business_agent_website"
  end
  # verify the required parameter 'business_agent_website_input' is set
  if @api_client.config.client_side_validation && business_agent_website_input.nil?
    fail ArgumentError, "Missing the required parameter 'business_agent_website_input' when calling BusinessAgentApi.update_business_agent_website"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/websites/{websiteId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'websiteId' + '}', CGI.escape(website_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(business_agent_website_input)

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

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

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

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

#upload_business_agent_file(account_id, upload_business_agent_file_request, opts = {}) ⇒ BusinessAgentKnowledgeFile

Upload a knowledge file Accepted types: pdf, doc, docx, png, jpg, jpeg, plus csv and xlsx when Meta enabled extraction on the asset. Meta's limit is 100 MB. Two ways to send the file: - JSON { url, fileName }: Zernio downloads the file (public https URL, no redirects, capped at 100 MB) and forwards it. Use this for anything above a few megabytes. - multipart form-data with a file part (and an optional fileName): bounded by the request body limit of about 4.5 MB; larger uploads must use the url form. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:



3866
3867
3868
3869
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3866

def upload_business_agent_file(, upload_business_agent_file_request, opts = {})
  data, _status_code, _headers = upload_business_agent_file_with_http_info(, upload_business_agent_file_request, opts)
  data
end

#upload_business_agent_file_with_http_info(account_id, upload_business_agent_file_request, opts = {}) ⇒ Array<(BusinessAgentKnowledgeFile, Integer, Hash)>

Upload a knowledge file Accepted types: pdf, doc, docx, png, jpg, jpeg, plus csv and xlsx when Meta enabled extraction on the asset. Meta's limit is 100 MB. Two ways to send the file: - JSON `{ url, fileName }`: Zernio downloads the file (public https URL, no redirects, capped at 100 MB) and forwards it. Use this for anything above a few megabytes. - multipart form-data with a `file` part (and an optional `fileName`): bounded by the request body limit of about 4.5 MB; larger uploads must use the `url` form. Not idempotent.

Parameters:

  • account_id (String) —

    WhatsApp social account id (the number must be managed through the Cloud API).

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

    the optional parameters

Returns:

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

    BusinessAgentKnowledgeFile data, response status code and response headers



3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
 
# File 'lib/zernio-sdk/api/business_agent_api.rb', line 3877

def upload_business_agent_file_with_http_info(, upload_business_agent_file_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAgentApi.upload_business_agent_file ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BusinessAgentApi.upload_business_agent_file"
  end
  # verify the required parameter 'upload_business_agent_file_request' is set
  if @api_client.config.client_side_validation && upload_business_agent_file_request.nil?
    fail ArgumentError, "Missing the required parameter 'upload_business_agent_file_request' when calling BusinessAgentApi.upload_business_agent_file"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/business-agent/files'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
  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(upload_business_agent_file_request)

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

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

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