late-sdk 0.0.875 → 0.0.877

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +118 -3
  3. data/docs/AddBusinessAgentAllowlistEntryRequest.md +18 -0
  4. data/docs/BusinessAgentAllowlistEntry.md +20 -0
  5. data/docs/BusinessAgentApi.md +3949 -0
  6. data/docs/BusinessAgentApiKeyConfig.md +22 -0
  7. data/docs/BusinessAgentApiKeyParamsInner.md +22 -0
  8. data/docs/BusinessAgentBudget.md +24 -0
  9. data/docs/BusinessAgentBusinessInformation.md +28 -0
  10. data/docs/BusinessAgentBusinessInformationContactInfo.md +22 -0
  11. data/docs/BusinessAgentConnector.md +40 -0
  12. data/docs/BusinessAgentConnectorAllOfConnectionStatus.md +20 -0
  13. data/docs/BusinessAgentConnectorInput.md +32 -0
  14. data/docs/BusinessAgentConnectorInputAuthConfig.md +20 -0
  15. data/docs/BusinessAgentConnectorInputUserAuthInjectionConfig.md +22 -0
  16. data/docs/BusinessAgentConnectorTool.md +30 -0
  17. data/docs/BusinessAgentConnectorToolInput.md +28 -0
  18. data/docs/BusinessAgentEventStatus.md +28 -0
  19. data/docs/BusinessAgentFaq.md +26 -0
  20. data/docs/BusinessAgentFaqInput.md +22 -0
  21. data/docs/BusinessAgentKnowledgeFile.md +20 -0
  22. data/docs/BusinessAgentOAuthClientCredentials.md +26 -0
  23. data/docs/BusinessAgentSettings.md +30 -0
  24. data/docs/BusinessAgentSettingsFollowup.md +22 -0
  25. data/docs/BusinessAgentSettingsHandoff.md +22 -0
  26. data/docs/BusinessAgentSettingsRollout.md +18 -0
  27. data/docs/BusinessAgentSkill.md +30 -0
  28. data/docs/BusinessAgentSkillInput.md +22 -0
  29. data/docs/BusinessAgentStatus.md +32 -0
  30. data/docs/BusinessAgentStatusManualStepsInner.md +22 -0
  31. data/docs/BusinessAgentStatusUnverifiedStepsInner.md +22 -0
  32. data/docs/BusinessAgentTestMessageResponse.md +32 -0
  33. data/docs/BusinessAgentUiSkill.md +32 -0
  34. data/docs/BusinessAgentUiSkillInput.md +26 -0
  35. data/docs/BusinessAgentWebsite.md +40 -0
  36. data/docs/BusinessAgentWebsiteInput.md +28 -0
  37. data/docs/ConnectApi.md +1 -68
  38. data/docs/ConnectWhatsAppEmbeddedSignupRequest.md +4 -4
  39. data/docs/GetBusinessAgentBudget200Response.md +18 -0
  40. data/docs/GetBusinessAgentConnectorLogs200Response.md +20 -0
  41. data/docs/InlineObject.md +2 -2
  42. data/docs/InlineObject1.md +1 -1
  43. data/docs/InlineObject2.md +1 -5
  44. data/docs/InlineObject3.md +5 -11
  45. data/docs/InlineObject4.md +28 -0
  46. data/docs/{InlineObject3Details.md → InlineObject4Details.md} +2 -2
  47. data/docs/ListBusinessAgentAllowlist200Response.md +18 -0
  48. data/docs/ListBusinessAgentConnectorTools200Response.md +18 -0
  49. data/docs/ListBusinessAgentConnectors200Response.md +18 -0
  50. data/docs/ListBusinessAgentFaqs200Response.md +18 -0
  51. data/docs/ListBusinessAgentFiles200Response.md +18 -0
  52. data/docs/ListBusinessAgentSettings200Response.md +18 -0
  53. data/docs/ListBusinessAgentSkills200Response.md +18 -0
  54. data/docs/ListBusinessAgentUiSkills200Response.md +20 -0
  55. data/docs/ListBusinessAgentWebsites200Response.md +18 -0
  56. data/docs/MessagesApi.md +1 -1
  57. data/docs/OnboardBusinessAgent201Response.md +18 -0
  58. data/docs/RunBusinessAgentConnectorTool200Response.md +20 -0
  59. data/docs/RunBusinessAgentConnectorToolRequest.md +18 -0
  60. data/docs/SendBusinessAgentEvent202Response.md +20 -0
  61. data/docs/SendBusinessAgentEventRequest.md +24 -0
  62. data/docs/SendBusinessAgentTestMessageRequest.md +20 -0
  63. data/docs/SetBusinessAgentConnectorCredentialsRequest.md +51 -0
  64. data/docs/SetBusinessAgentConnectorCredentialsRequestOneOf.md +20 -0
  65. data/docs/SetBusinessAgentConnectorCredentialsRequestOneOf1.md +20 -0
  66. data/docs/SetBusinessAgentConnectorCredentialsRequestOneOf2.md +24 -0
  67. data/docs/StartBusinessAgentEvalRun202Response.md +20 -0
  68. data/docs/StartBusinessAgentEvalRunRequest.md +18 -0
  69. data/docs/UpdateBusinessAgentSettingsRequest.md +26 -0
  70. data/docs/UpdateBusinessAgentSettingsRequestFollowup.md +22 -0
  71. data/docs/UpdateBusinessAgentSettingsRequestHandoff.md +22 -0
  72. data/docs/UpdateBusinessAgentSettingsRequestRollout.md +18 -0
  73. data/docs/UploadBusinessAgentFileRequest.md +20 -0
  74. data/lib/zernio-sdk/api/business_agent_api.rb +3934 -0
  75. data/lib/zernio-sdk/api/connect_api.rb +2 -59
  76. data/lib/zernio-sdk/api/messages_api.rb +2 -2
  77. data/lib/zernio-sdk/models/add_business_agent_allowlist_entry_request.rb +164 -0
  78. data/lib/zernio-sdk/models/business_agent_allowlist_entry.rb +174 -0
  79. data/lib/zernio-sdk/models/business_agent_api_key_config.rb +172 -0
  80. data/lib/zernio-sdk/models/business_agent_api_key_params_inner.rb +199 -0
  81. data/lib/zernio-sdk/models/business_agent_budget.rb +263 -0
  82. data/lib/zernio-sdk/models/business_agent_business_information.rb +193 -0
  83. data/lib/zernio-sdk/models/business_agent_business_information_contact_info.rb +165 -0
  84. data/lib/zernio-sdk/models/business_agent_connector.rb +352 -0
  85. data/lib/zernio-sdk/models/business_agent_connector_all_of_connection_status.rb +157 -0
  86. data/lib/zernio-sdk/models/business_agent_connector_input.rb +288 -0
  87. data/lib/zernio-sdk/models/business_agent_connector_input_auth_config.rb +156 -0
  88. data/lib/zernio-sdk/models/business_agent_connector_input_user_auth_injection_config.rb +199 -0
  89. data/lib/zernio-sdk/models/business_agent_connector_tool.rb +284 -0
  90. data/lib/zernio-sdk/models/business_agent_connector_tool_input.rb +251 -0
  91. data/lib/zernio-sdk/models/business_agent_event_status.rb +284 -0
  92. data/lib/zernio-sdk/models/business_agent_faq.rb +264 -0
  93. data/lib/zernio-sdk/models/business_agent_faq_input.rb +221 -0
  94. data/lib/zernio-sdk/models/business_agent_knowledge_file.rb +190 -0
  95. data/lib/zernio-sdk/models/business_agent_o_auth_client_credentials.rb +236 -0
  96. data/lib/zernio-sdk/models/business_agent_settings.rb +292 -0
  97. data/lib/zernio-sdk/models/business_agent_settings_followup.rb +199 -0
  98. data/lib/zernio-sdk/models/business_agent_settings_handoff.rb +200 -0
  99. data/lib/zernio-sdk/models/business_agent_settings_rollout.rb +165 -0
  100. data/lib/zernio-sdk/models/business_agent_skill.rb +339 -0
  101. data/lib/zernio-sdk/models/business_agent_skill_input.rb +243 -0
  102. data/lib/zernio-sdk/models/business_agent_status.rb +315 -0
  103. data/lib/zernio-sdk/models/business_agent_status_manual_steps_inner.rb +240 -0
  104. data/lib/zernio-sdk/models/business_agent_status_unverified_steps_inner.rb +240 -0
  105. data/lib/zernio-sdk/models/business_agent_test_message_response.rb +267 -0
  106. data/lib/zernio-sdk/models/business_agent_ui_skill.rb +315 -0
  107. data/lib/zernio-sdk/models/business_agent_ui_skill_input.rb +262 -0
  108. data/lib/zernio-sdk/models/business_agent_website.rb +302 -0
  109. data/lib/zernio-sdk/models/business_agent_website_input.rb +221 -0
  110. data/lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb +3 -4
  111. data/lib/zernio-sdk/models/get_business_agent_budget200_response.rb +166 -0
  112. data/lib/zernio-sdk/models/get_business_agent_connector_logs200_response.rb +160 -0
  113. data/lib/zernio-sdk/models/inline_object.rb +24 -7
  114. data/lib/zernio-sdk/models/inline_object2.rb +4 -69
  115. data/lib/zernio-sdk/models/inline_object3.rb +18 -80
  116. data/lib/zernio-sdk/models/inline_object4.rb +274 -0
  117. data/lib/zernio-sdk/models/{inline_object3_details.rb → inline_object4_details.rb} +3 -3
  118. data/lib/zernio-sdk/models/list_business_agent_allowlist200_response.rb +166 -0
  119. data/lib/zernio-sdk/models/list_business_agent_connector_tools200_response.rb +166 -0
  120. data/lib/zernio-sdk/models/list_business_agent_connectors200_response.rb +166 -0
  121. data/lib/zernio-sdk/models/list_business_agent_faqs200_response.rb +166 -0
  122. data/lib/zernio-sdk/models/list_business_agent_files200_response.rb +166 -0
  123. data/lib/zernio-sdk/models/list_business_agent_settings200_response.rb +166 -0
  124. data/lib/zernio-sdk/models/list_business_agent_skills200_response.rb +166 -0
  125. data/lib/zernio-sdk/models/list_business_agent_ui_skills200_response.rb +177 -0
  126. data/lib/zernio-sdk/models/list_business_agent_websites200_response.rb +166 -0
  127. data/lib/zernio-sdk/models/onboard_business_agent201_response.rb +164 -0
  128. data/lib/zernio-sdk/models/run_business_agent_connector_tool200_response.rb +156 -0
  129. data/lib/zernio-sdk/models/run_business_agent_connector_tool_request.rb +165 -0
  130. data/lib/zernio-sdk/models/send_business_agent_event202_response.rb +173 -0
  131. data/lib/zernio-sdk/models/send_business_agent_event_request.rb +271 -0
  132. data/lib/zernio-sdk/models/send_business_agent_test_message_request.rb +182 -0
  133. data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request.rb +105 -0
  134. data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request_one_of.rb +214 -0
  135. data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request_one_of1.rb +214 -0
  136. data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request_one_of2.rb +252 -0
  137. data/lib/zernio-sdk/models/{get_whats_app_sdk_config200_response.rb → start_business_agent_eval_run202_response.rb} +34 -63
  138. data/lib/zernio-sdk/models/start_business_agent_eval_run_request.rb +184 -0
  139. data/lib/zernio-sdk/models/update_business_agent_settings_request.rb +220 -0
  140. data/lib/zernio-sdk/models/update_business_agent_settings_request_followup.rb +235 -0
  141. data/lib/zernio-sdk/models/update_business_agent_settings_request_handoff.rb +235 -0
  142. data/lib/zernio-sdk/models/update_business_agent_settings_request_rollout.rb +164 -0
  143. data/lib/zernio-sdk/models/upload_business_agent_file_request.rb +175 -0
  144. data/lib/zernio-sdk/version.rb +1 -1
  145. data/lib/zernio-sdk.rb +64 -2
  146. data/openapi.yaml +1718 -55
  147. data/spec/api/business_agent_api_spec.rb +736 -0
  148. data/spec/api/connect_api_spec.rb +1 -12
  149. data/spec/api/messages_api_spec.rb +1 -1
  150. data/spec/models/add_business_agent_allowlist_entry_request_spec.rb +36 -0
  151. data/spec/models/business_agent_allowlist_entry_spec.rb +42 -0
  152. data/spec/models/{get_whats_app_sdk_config200_response_spec.rb → business_agent_api_key_config_spec.rb} +9 -9
  153. data/spec/models/business_agent_api_key_params_inner_spec.rb +48 -0
  154. data/spec/models/business_agent_budget_spec.rb +62 -0
  155. data/spec/models/business_agent_business_information_contact_info_spec.rb +48 -0
  156. data/spec/models/business_agent_business_information_spec.rb +66 -0
  157. data/spec/models/business_agent_connector_all_of_connection_status_spec.rb +42 -0
  158. data/spec/models/business_agent_connector_input_auth_config_spec.rb +42 -0
  159. data/spec/models/business_agent_connector_input_spec.rb +82 -0
  160. data/spec/models/business_agent_connector_input_user_auth_injection_config_spec.rb +48 -0
  161. data/spec/models/business_agent_connector_spec.rb +106 -0
  162. data/spec/models/business_agent_connector_tool_input_spec.rb +66 -0
  163. data/spec/models/business_agent_connector_tool_spec.rb +72 -0
  164. data/spec/models/business_agent_event_status_spec.rb +70 -0
  165. data/spec/models/business_agent_faq_input_spec.rb +48 -0
  166. data/spec/models/business_agent_faq_spec.rb +60 -0
  167. data/spec/models/business_agent_knowledge_file_spec.rb +42 -0
  168. data/spec/models/business_agent_o_auth_client_credentials_spec.rb +60 -0
  169. data/spec/models/business_agent_settings_followup_spec.rb +52 -0
  170. data/spec/models/business_agent_settings_handoff_spec.rb +52 -0
  171. data/spec/models/business_agent_settings_rollout_spec.rb +36 -0
  172. data/spec/models/business_agent_settings_spec.rb +76 -0
  173. data/spec/models/business_agent_skill_input_spec.rb +48 -0
  174. data/spec/models/business_agent_skill_spec.rb +76 -0
  175. data/spec/models/business_agent_status_manual_steps_inner_spec.rb +52 -0
  176. data/spec/models/business_agent_status_spec.rb +78 -0
  177. data/spec/models/business_agent_status_unverified_steps_inner_spec.rb +52 -0
  178. data/spec/models/business_agent_test_message_response_spec.rb +78 -0
  179. data/spec/models/business_agent_ui_skill_input_spec.rb +68 -0
  180. data/spec/models/business_agent_ui_skill_spec.rb +86 -0
  181. data/spec/models/business_agent_website_input_spec.rb +66 -0
  182. data/spec/models/business_agent_website_spec.rb +102 -0
  183. data/spec/models/get_business_agent_budget200_response_spec.rb +36 -0
  184. data/spec/models/get_business_agent_connector_logs200_response_spec.rb +42 -0
  185. data/spec/models/inline_object2_spec.rb +0 -20
  186. data/spec/models/inline_object3_spec.rb +4 -22
  187. data/spec/models/{inline_object3_details_spec.rb → inline_object4_details_spec.rb} +6 -6
  188. data/spec/models/inline_object4_spec.rb +74 -0
  189. data/spec/models/inline_object_spec.rb +1 -1
  190. data/spec/models/list_business_agent_allowlist200_response_spec.rb +36 -0
  191. data/spec/models/list_business_agent_connector_tools200_response_spec.rb +36 -0
  192. data/spec/models/list_business_agent_connectors200_response_spec.rb +36 -0
  193. data/spec/models/list_business_agent_faqs200_response_spec.rb +36 -0
  194. data/spec/models/list_business_agent_files200_response_spec.rb +36 -0
  195. data/spec/models/list_business_agent_settings200_response_spec.rb +36 -0
  196. data/spec/models/list_business_agent_skills200_response_spec.rb +36 -0
  197. data/spec/models/list_business_agent_ui_skills200_response_spec.rb +42 -0
  198. data/spec/models/list_business_agent_websites200_response_spec.rb +36 -0
  199. data/spec/models/onboard_business_agent201_response_spec.rb +36 -0
  200. data/spec/models/run_business_agent_connector_tool200_response_spec.rb +42 -0
  201. data/spec/models/run_business_agent_connector_tool_request_spec.rb +36 -0
  202. data/spec/models/send_business_agent_event202_response_spec.rb +42 -0
  203. data/spec/models/send_business_agent_event_request_spec.rb +54 -0
  204. data/spec/models/send_business_agent_test_message_request_spec.rb +42 -0
  205. data/spec/models/set_business_agent_connector_credentials_request_one_of1_spec.rb +46 -0
  206. data/spec/models/set_business_agent_connector_credentials_request_one_of2_spec.rb +58 -0
  207. data/spec/models/set_business_agent_connector_credentials_request_one_of_spec.rb +46 -0
  208. data/spec/models/set_business_agent_connector_credentials_request_spec.rb +32 -0
  209. data/spec/models/start_business_agent_eval_run202_response_spec.rb +42 -0
  210. data/spec/models/start_business_agent_eval_run_request_spec.rb +36 -0
  211. data/spec/models/update_business_agent_settings_request_followup_spec.rb +52 -0
  212. data/spec/models/update_business_agent_settings_request_handoff_spec.rb +52 -0
  213. data/spec/models/update_business_agent_settings_request_rollout_spec.rb +36 -0
  214. data/spec/models/update_business_agent_settings_request_spec.rb +64 -0
  215. data/spec/models/upload_business_agent_file_request_spec.rb +42 -0
  216. data/zernio-sdk-0.0.877.gem +0 -0
  217. metadata +258 -10
  218. data/docs/GetWhatsAppSdkConfig200Response.md +0 -22
  219. data/zernio-sdk-0.0.875.gem +0 -0
@@ -0,0 +1,3949 @@
1
+ # Zernio::BusinessAgentApi
2
+
3
+ All URIs are relative to *https://zernio.com/api*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_business_agent_allowlist_entry**](BusinessAgentApi.md#add_business_agent_allowlist_entry) | **POST** /v1/accounts/{accountId}/business-agent/allowlist | Allowlist a consumer |
8
+ | [**add_business_agent_website**](BusinessAgentApi.md#add_business_agent_website) | **POST** /v1/accounts/{accountId}/business-agent/websites | Add a website to crawl |
9
+ | [**create_business_agent_connector**](BusinessAgentApi.md#create_business_agent_connector) | **POST** /v1/accounts/{accountId}/business-agent/connectors | Create a connector |
10
+ | [**create_business_agent_connector_tool**](BusinessAgentApi.md#create_business_agent_connector_tool) | **POST** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools | Create a connector tool |
11
+ | [**create_business_agent_faq**](BusinessAgentApi.md#create_business_agent_faq) | **POST** /v1/accounts/{accountId}/business-agent/faqs | Create a FAQ |
12
+ | [**create_business_agent_skill**](BusinessAgentApi.md#create_business_agent_skill) | **POST** /v1/accounts/{accountId}/business-agent/skills | Create a skill |
13
+ | [**create_business_agent_ui_skill**](BusinessAgentApi.md#create_business_agent_ui_skill) | **POST** /v1/accounts/{accountId}/business-agent/ui-skills | Create a UI skill |
14
+ | [**delete_business_agent_connector**](BusinessAgentApi.md#delete_business_agent_connector) | **DELETE** /v1/accounts/{accountId}/business-agent/connectors/{connectorId} | Delete a connector |
15
+ | [**delete_business_agent_connector_tool**](BusinessAgentApi.md#delete_business_agent_connector_tool) | **DELETE** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId} | Delete a connector tool |
16
+ | [**delete_business_agent_faq**](BusinessAgentApi.md#delete_business_agent_faq) | **DELETE** /v1/accounts/{accountId}/business-agent/faqs/{faqId} | Delete a FAQ |
17
+ | [**delete_business_agent_file**](BusinessAgentApi.md#delete_business_agent_file) | **DELETE** /v1/accounts/{accountId}/business-agent/files/{fileId} | Delete a knowledge file |
18
+ | [**delete_business_agent_skill**](BusinessAgentApi.md#delete_business_agent_skill) | **DELETE** /v1/accounts/{accountId}/business-agent/skills/{skillId} | Delete a skill |
19
+ | [**delete_business_agent_ui_skill**](BusinessAgentApi.md#delete_business_agent_ui_skill) | **DELETE** /v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId} | Delete a UI skill |
20
+ | [**delete_business_agent_website**](BusinessAgentApi.md#delete_business_agent_website) | **DELETE** /v1/accounts/{accountId}/business-agent/websites/{websiteId} | Remove a crawled website |
21
+ | [**get_business_agent_budget**](BusinessAgentApi.md#get_business_agent_budget) | **GET** /v1/accounts/{accountId}/business-agent/budget | Get usage budgets |
22
+ | [**get_business_agent_business_information**](BusinessAgentApi.md#get_business_agent_business_information) | **GET** /v1/accounts/{accountId}/business-agent/business-information | Get business information |
23
+ | [**get_business_agent_connector**](BusinessAgentApi.md#get_business_agent_connector) | **GET** /v1/accounts/{accountId}/business-agent/connectors/{connectorId} | Get a connector |
24
+ | [**get_business_agent_connector_logs**](BusinessAgentApi.md#get_business_agent_connector_logs) | **GET** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/logs | Get connector failure logs |
25
+ | [**get_business_agent_connector_tool**](BusinessAgentApi.md#get_business_agent_connector_tool) | **GET** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId} | Get a connector tool |
26
+ | [**get_business_agent_event**](BusinessAgentApi.md#get_business_agent_event) | **GET** /v1/accounts/{accountId}/business-agent/events/{eventId} | Get a business event status |
27
+ | [**get_business_agent_faq**](BusinessAgentApi.md#get_business_agent_faq) | **GET** /v1/accounts/{accountId}/business-agent/faqs/{faqId} | Get a FAQ |
28
+ | [**get_business_agent_file**](BusinessAgentApi.md#get_business_agent_file) | **GET** /v1/accounts/{accountId}/business-agent/files/{fileId} | Get a knowledge file |
29
+ | [**get_business_agent_skill**](BusinessAgentApi.md#get_business_agent_skill) | **GET** /v1/accounts/{accountId}/business-agent/skills/{skillId} | Get a skill |
30
+ | [**get_business_agent_status**](BusinessAgentApi.md#get_business_agent_status) | **GET** /v1/accounts/{accountId}/business-agent | Get agent setup status |
31
+ | [**get_business_agent_ui_skill**](BusinessAgentApi.md#get_business_agent_ui_skill) | **GET** /v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId} | Get a UI skill |
32
+ | [**get_business_agent_website**](BusinessAgentApi.md#get_business_agent_website) | **GET** /v1/accounts/{accountId}/business-agent/websites/{websiteId} | Get a crawled website |
33
+ | [**list_business_agent_allowlist**](BusinessAgentApi.md#list_business_agent_allowlist) | **GET** /v1/accounts/{accountId}/business-agent/allowlist | List allowlisted consumers |
34
+ | [**list_business_agent_connector_tools**](BusinessAgentApi.md#list_business_agent_connector_tools) | **GET** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools | List connector tools |
35
+ | [**list_business_agent_connectors**](BusinessAgentApi.md#list_business_agent_connectors) | **GET** /v1/accounts/{accountId}/business-agent/connectors | List connectors |
36
+ | [**list_business_agent_faqs**](BusinessAgentApi.md#list_business_agent_faqs) | **GET** /v1/accounts/{accountId}/business-agent/faqs | List FAQs |
37
+ | [**list_business_agent_files**](BusinessAgentApi.md#list_business_agent_files) | **GET** /v1/accounts/{accountId}/business-agent/files | List knowledge files |
38
+ | [**list_business_agent_settings**](BusinessAgentApi.md#list_business_agent_settings) | **GET** /v1/accounts/{accountId}/business-agent/settings | List agent settings |
39
+ | [**list_business_agent_skills**](BusinessAgentApi.md#list_business_agent_skills) | **GET** /v1/accounts/{accountId}/business-agent/skills | List skills |
40
+ | [**list_business_agent_ui_skills**](BusinessAgentApi.md#list_business_agent_ui_skills) | **GET** /v1/accounts/{accountId}/business-agent/ui-skills | List UI skills |
41
+ | [**list_business_agent_websites**](BusinessAgentApi.md#list_business_agent_websites) | **GET** /v1/accounts/{accountId}/business-agent/websites | List crawled websites |
42
+ | [**onboard_business_agent**](BusinessAgentApi.md#onboard_business_agent) | **POST** /v1/accounts/{accountId}/business-agent/onboard | Create the agent |
43
+ | [**read_business_agent_evals**](BusinessAgentApi.md#read_business_agent_evals) | **GET** /v1/accounts/{accountId}/business-agent/evals | Read evaluation data |
44
+ | [**refresh_business_agent_connector_tools**](BusinessAgentApi.md#refresh_business_agent_connector_tools) | **POST** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/refresh-tools | Refresh MCP connector tools |
45
+ | [**remove_business_agent_allowlist_entry**](BusinessAgentApi.md#remove_business_agent_allowlist_entry) | **DELETE** /v1/accounts/{accountId}/business-agent/allowlist/{entryId} | Remove an allowlisted consumer |
46
+ | [**replace_business_agent_budget**](BusinessAgentApi.md#replace_business_agent_budget) | **PUT** /v1/accounts/{accountId}/business-agent/budget | Replace usage budgets |
47
+ | [**replace_business_agent_business_information**](BusinessAgentApi.md#replace_business_agent_business_information) | **PUT** /v1/accounts/{accountId}/business-agent/business-information | Replace business information |
48
+ | [**reset_business_agent_business_information**](BusinessAgentApi.md#reset_business_agent_business_information) | **DELETE** /v1/accounts/{accountId}/business-agent/business-information | Reset business information |
49
+ | [**run_business_agent_connector_tool**](BusinessAgentApi.md#run_business_agent_connector_tool) | **POST** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}/run | Run a connector tool once |
50
+ | [**send_business_agent_event**](BusinessAgentApi.md#send_business_agent_event) | **POST** /v1/accounts/{accountId}/business-agent/events | Send a business event |
51
+ | [**send_business_agent_test_message**](BusinessAgentApi.md#send_business_agent_test_message) | **POST** /v1/accounts/{accountId}/business-agent/test-messages | Send a test message |
52
+ | [**set_business_agent_connector_credentials**](BusinessAgentApi.md#set_business_agent_connector_credentials) | **POST** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/credentials | Set connector credentials |
53
+ | [**start_business_agent_eval_run**](BusinessAgentApi.md#start_business_agent_eval_run) | **POST** /v1/accounts/{accountId}/business-agent/evals | Start an evaluation run |
54
+ | [**update_business_agent_connector**](BusinessAgentApi.md#update_business_agent_connector) | **PUT** /v1/accounts/{accountId}/business-agent/connectors/{connectorId} | Update a connector |
55
+ | [**update_business_agent_connector_tool**](BusinessAgentApi.md#update_business_agent_connector_tool) | **PUT** /v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId} | Update a connector tool |
56
+ | [**update_business_agent_faq**](BusinessAgentApi.md#update_business_agent_faq) | **PUT** /v1/accounts/{accountId}/business-agent/faqs/{faqId} | Update a FAQ |
57
+ | [**update_business_agent_settings**](BusinessAgentApi.md#update_business_agent_settings) | **PATCH** /v1/accounts/{accountId}/business-agent/settings | Update agent settings |
58
+ | [**update_business_agent_skill**](BusinessAgentApi.md#update_business_agent_skill) | **PUT** /v1/accounts/{accountId}/business-agent/skills/{skillId} | Update a skill |
59
+ | [**update_business_agent_ui_skill**](BusinessAgentApi.md#update_business_agent_ui_skill) | **PUT** /v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId} | Update a UI skill |
60
+ | [**update_business_agent_website**](BusinessAgentApi.md#update_business_agent_website) | **PUT** /v1/accounts/{accountId}/business-agent/websites/{websiteId} | Update a crawled website |
61
+ | [**upload_business_agent_file**](BusinessAgentApi.md#upload_business_agent_file) | **POST** /v1/accounts/{accountId}/business-agent/files | Upload a knowledge file |
62
+
63
+
64
+ ## add_business_agent_allowlist_entry
65
+
66
+ > <BusinessAgentAllowlistEntry> add_business_agent_allowlist_entry(account_id, add_business_agent_allowlist_entry_request)
67
+
68
+ Allowlist a consumer
69
+
70
+ One E.164 number per call. Not idempotent.
71
+
72
+ ### Examples
73
+
74
+ ```ruby
75
+ require 'time'
76
+ require 'zernio-sdk'
77
+ # setup authorization
78
+ Zernio.configure do |config|
79
+ # Configure Bearer authorization (JWT): bearerAuth
80
+ config.access_token = 'YOUR_BEARER_TOKEN'
81
+ end
82
+
83
+ api_instance = Zernio::BusinessAgentApi.new
84
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
85
+ add_business_agent_allowlist_entry_request = Zernio::AddBusinessAgentAllowlistEntryRequest.new({consumer_phone_number: '+34600000000'}) # AddBusinessAgentAllowlistEntryRequest |
86
+
87
+ begin
88
+ # Allowlist a consumer
89
+ result = api_instance.add_business_agent_allowlist_entry(account_id, add_business_agent_allowlist_entry_request)
90
+ p result
91
+ rescue Zernio::ApiError => e
92
+ puts "Error when calling BusinessAgentApi->add_business_agent_allowlist_entry: #{e}"
93
+ end
94
+ ```
95
+
96
+ #### Using the add_business_agent_allowlist_entry_with_http_info variant
97
+
98
+ This returns an Array which contains the response data, status code and headers.
99
+
100
+ > <Array(<BusinessAgentAllowlistEntry>, Integer, Hash)> add_business_agent_allowlist_entry_with_http_info(account_id, add_business_agent_allowlist_entry_request)
101
+
102
+ ```ruby
103
+ begin
104
+ # Allowlist a consumer
105
+ data, status_code, headers = api_instance.add_business_agent_allowlist_entry_with_http_info(account_id, add_business_agent_allowlist_entry_request)
106
+ p status_code # => 2xx
107
+ p headers # => { ... }
108
+ p data # => <BusinessAgentAllowlistEntry>
109
+ rescue Zernio::ApiError => e
110
+ puts "Error when calling BusinessAgentApi->add_business_agent_allowlist_entry_with_http_info: #{e}"
111
+ end
112
+ ```
113
+
114
+ ### Parameters
115
+
116
+ | Name | Type | Description | Notes |
117
+ | ---- | ---- | ----------- | ----- |
118
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
119
+ | **add_business_agent_allowlist_entry_request** | [**AddBusinessAgentAllowlistEntryRequest**](AddBusinessAgentAllowlistEntryRequest.md) | | |
120
+
121
+ ### Return type
122
+
123
+ [**BusinessAgentAllowlistEntry**](BusinessAgentAllowlistEntry.md)
124
+
125
+ ### Authorization
126
+
127
+ [bearerAuth](../README.md#bearerAuth)
128
+
129
+ ### HTTP request headers
130
+
131
+ - **Content-Type**: application/json
132
+ - **Accept**: application/json
133
+
134
+
135
+ ## add_business_agent_website
136
+
137
+ > <BusinessAgentWebsite> add_business_agent_website(account_id, business_agent_website_input)
138
+
139
+ Add a website to crawl
140
+
141
+ Meta crawls the site into the agent knowledge and recrawls it periodically; check `crawl_status` and `crawl_error` on read. Not idempotent.
142
+
143
+ ### Examples
144
+
145
+ ```ruby
146
+ require 'time'
147
+ require 'zernio-sdk'
148
+ # setup authorization
149
+ Zernio.configure do |config|
150
+ # Configure Bearer authorization (JWT): bearerAuth
151
+ config.access_token = 'YOUR_BEARER_TOKEN'
152
+ end
153
+
154
+ api_instance = Zernio::BusinessAgentApi.new
155
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
156
+ business_agent_website_input = Zernio::BusinessAgentWebsiteInput.new({url: 'url_example'}) # BusinessAgentWebsiteInput |
157
+
158
+ begin
159
+ # Add a website to crawl
160
+ result = api_instance.add_business_agent_website(account_id, business_agent_website_input)
161
+ p result
162
+ rescue Zernio::ApiError => e
163
+ puts "Error when calling BusinessAgentApi->add_business_agent_website: #{e}"
164
+ end
165
+ ```
166
+
167
+ #### Using the add_business_agent_website_with_http_info variant
168
+
169
+ This returns an Array which contains the response data, status code and headers.
170
+
171
+ > <Array(<BusinessAgentWebsite>, Integer, Hash)> add_business_agent_website_with_http_info(account_id, business_agent_website_input)
172
+
173
+ ```ruby
174
+ begin
175
+ # Add a website to crawl
176
+ data, status_code, headers = api_instance.add_business_agent_website_with_http_info(account_id, business_agent_website_input)
177
+ p status_code # => 2xx
178
+ p headers # => { ... }
179
+ p data # => <BusinessAgentWebsite>
180
+ rescue Zernio::ApiError => e
181
+ puts "Error when calling BusinessAgentApi->add_business_agent_website_with_http_info: #{e}"
182
+ end
183
+ ```
184
+
185
+ ### Parameters
186
+
187
+ | Name | Type | Description | Notes |
188
+ | ---- | ---- | ----------- | ----- |
189
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
190
+ | **business_agent_website_input** | [**BusinessAgentWebsiteInput**](BusinessAgentWebsiteInput.md) | | |
191
+
192
+ ### Return type
193
+
194
+ [**BusinessAgentWebsite**](BusinessAgentWebsite.md)
195
+
196
+ ### Authorization
197
+
198
+ [bearerAuth](../README.md#bearerAuth)
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: application/json
203
+ - **Accept**: application/json
204
+
205
+
206
+ ## create_business_agent_connector
207
+
208
+ > <BusinessAgentConnector> create_business_agent_connector(account_id, business_agent_connector_input)
209
+
210
+ Create a connector
211
+
212
+ Base URL plus how to authenticate (OAuth client credentials, API key or none). Names are unique per number. Not idempotent.
213
+
214
+ ### Examples
215
+
216
+ ```ruby
217
+ require 'time'
218
+ require 'zernio-sdk'
219
+ # setup authorization
220
+ Zernio.configure do |config|
221
+ # Configure Bearer authorization (JWT): bearerAuth
222
+ config.access_token = 'YOUR_BEARER_TOKEN'
223
+ end
224
+
225
+ api_instance = Zernio::BusinessAgentApi.new
226
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
227
+ business_agent_connector_input = Zernio::BusinessAgentConnectorInput.new({name: 'name_example', base_url: 'base_url_example', auth_type: 'OAUTH2_CLIENT_CREDENTIALS'}) # BusinessAgentConnectorInput |
228
+
229
+ begin
230
+ # Create a connector
231
+ result = api_instance.create_business_agent_connector(account_id, business_agent_connector_input)
232
+ p result
233
+ rescue Zernio::ApiError => e
234
+ puts "Error when calling BusinessAgentApi->create_business_agent_connector: #{e}"
235
+ end
236
+ ```
237
+
238
+ #### Using the create_business_agent_connector_with_http_info variant
239
+
240
+ This returns an Array which contains the response data, status code and headers.
241
+
242
+ > <Array(<BusinessAgentConnector>, Integer, Hash)> create_business_agent_connector_with_http_info(account_id, business_agent_connector_input)
243
+
244
+ ```ruby
245
+ begin
246
+ # Create a connector
247
+ data, status_code, headers = api_instance.create_business_agent_connector_with_http_info(account_id, business_agent_connector_input)
248
+ p status_code # => 2xx
249
+ p headers # => { ... }
250
+ p data # => <BusinessAgentConnector>
251
+ rescue Zernio::ApiError => e
252
+ puts "Error when calling BusinessAgentApi->create_business_agent_connector_with_http_info: #{e}"
253
+ end
254
+ ```
255
+
256
+ ### Parameters
257
+
258
+ | Name | Type | Description | Notes |
259
+ | ---- | ---- | ----------- | ----- |
260
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
261
+ | **business_agent_connector_input** | [**BusinessAgentConnectorInput**](BusinessAgentConnectorInput.md) | | |
262
+
263
+ ### Return type
264
+
265
+ [**BusinessAgentConnector**](BusinessAgentConnector.md)
266
+
267
+ ### Authorization
268
+
269
+ [bearerAuth](../README.md#bearerAuth)
270
+
271
+ ### HTTP request headers
272
+
273
+ - **Content-Type**: application/json
274
+ - **Accept**: application/json
275
+
276
+
277
+ ## create_business_agent_connector_tool
278
+
279
+ > <BusinessAgentConnectorTool> create_business_agent_connector_tool(account_id, connector_id, business_agent_connector_tool_input)
280
+
281
+ Create a connector tool
282
+
283
+ 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.
284
+
285
+ ### Examples
286
+
287
+ ```ruby
288
+ require 'time'
289
+ require 'zernio-sdk'
290
+ # setup authorization
291
+ Zernio.configure do |config|
292
+ # Configure Bearer authorization (JWT): bearerAuth
293
+ config.access_token = 'YOUR_BEARER_TOKEN'
294
+ end
295
+
296
+ api_instance = Zernio::BusinessAgentApi.new
297
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
298
+ connector_id = 'connector_id_example' # String |
299
+ business_agent_connector_tool_input = Zernio::BusinessAgentConnectorToolInput.new({name: 'name_example', description: 'description_example', request_definition: { key: 3.56}}) # BusinessAgentConnectorToolInput |
300
+
301
+ begin
302
+ # Create a connector tool
303
+ result = api_instance.create_business_agent_connector_tool(account_id, connector_id, business_agent_connector_tool_input)
304
+ p result
305
+ rescue Zernio::ApiError => e
306
+ puts "Error when calling BusinessAgentApi->create_business_agent_connector_tool: #{e}"
307
+ end
308
+ ```
309
+
310
+ #### Using the create_business_agent_connector_tool_with_http_info variant
311
+
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<BusinessAgentConnectorTool>, Integer, Hash)> create_business_agent_connector_tool_with_http_info(account_id, connector_id, business_agent_connector_tool_input)
315
+
316
+ ```ruby
317
+ begin
318
+ # Create a connector tool
319
+ data, status_code, headers = api_instance.create_business_agent_connector_tool_with_http_info(account_id, connector_id, business_agent_connector_tool_input)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <BusinessAgentConnectorTool>
323
+ rescue Zernio::ApiError => e
324
+ puts "Error when calling BusinessAgentApi->create_business_agent_connector_tool_with_http_info: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
333
+ | **connector_id** | **String** | | |
334
+ | **business_agent_connector_tool_input** | [**BusinessAgentConnectorToolInput**](BusinessAgentConnectorToolInput.md) | | |
335
+
336
+ ### Return type
337
+
338
+ [**BusinessAgentConnectorTool**](BusinessAgentConnectorTool.md)
339
+
340
+ ### Authorization
341
+
342
+ [bearerAuth](../README.md#bearerAuth)
343
+
344
+ ### HTTP request headers
345
+
346
+ - **Content-Type**: application/json
347
+ - **Accept**: application/json
348
+
349
+
350
+ ## create_business_agent_faq
351
+
352
+ > <BusinessAgentFaq> create_business_agent_faq(account_id, business_agent_faq_input)
353
+
354
+ Create a FAQ
355
+
356
+ One specific question per entry; beyond a few hundred entries retrieval quality drops. Not idempotent.
357
+
358
+ ### Examples
359
+
360
+ ```ruby
361
+ require 'time'
362
+ require 'zernio-sdk'
363
+ # setup authorization
364
+ Zernio.configure do |config|
365
+ # Configure Bearer authorization (JWT): bearerAuth
366
+ config.access_token = 'YOUR_BEARER_TOKEN'
367
+ end
368
+
369
+ api_instance = Zernio::BusinessAgentApi.new
370
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
371
+ business_agent_faq_input = Zernio::BusinessAgentFaqInput.new({question: 'question_example', answer: 'answer_example'}) # BusinessAgentFaqInput |
372
+
373
+ begin
374
+ # Create a FAQ
375
+ result = api_instance.create_business_agent_faq(account_id, business_agent_faq_input)
376
+ p result
377
+ rescue Zernio::ApiError => e
378
+ puts "Error when calling BusinessAgentApi->create_business_agent_faq: #{e}"
379
+ end
380
+ ```
381
+
382
+ #### Using the create_business_agent_faq_with_http_info variant
383
+
384
+ This returns an Array which contains the response data, status code and headers.
385
+
386
+ > <Array(<BusinessAgentFaq>, Integer, Hash)> create_business_agent_faq_with_http_info(account_id, business_agent_faq_input)
387
+
388
+ ```ruby
389
+ begin
390
+ # Create a FAQ
391
+ data, status_code, headers = api_instance.create_business_agent_faq_with_http_info(account_id, business_agent_faq_input)
392
+ p status_code # => 2xx
393
+ p headers # => { ... }
394
+ p data # => <BusinessAgentFaq>
395
+ rescue Zernio::ApiError => e
396
+ puts "Error when calling BusinessAgentApi->create_business_agent_faq_with_http_info: #{e}"
397
+ end
398
+ ```
399
+
400
+ ### Parameters
401
+
402
+ | Name | Type | Description | Notes |
403
+ | ---- | ---- | ----------- | ----- |
404
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
405
+ | **business_agent_faq_input** | [**BusinessAgentFaqInput**](BusinessAgentFaqInput.md) | | |
406
+
407
+ ### Return type
408
+
409
+ [**BusinessAgentFaq**](BusinessAgentFaq.md)
410
+
411
+ ### Authorization
412
+
413
+ [bearerAuth](../README.md#bearerAuth)
414
+
415
+ ### HTTP request headers
416
+
417
+ - **Content-Type**: application/json
418
+ - **Accept**: application/json
419
+
420
+
421
+ ## create_business_agent_skill
422
+
423
+ > <BusinessAgentSkill> create_business_agent_skill(account_id, business_agent_skill_input)
424
+
425
+ Create a skill
426
+
427
+ Behavioral instructions in the brand voice. Reads back `pending_review` until Meta content review passes it. Not idempotent.
428
+
429
+ ### Examples
430
+
431
+ ```ruby
432
+ require 'time'
433
+ require 'zernio-sdk'
434
+ # setup authorization
435
+ Zernio.configure do |config|
436
+ # Configure Bearer authorization (JWT): bearerAuth
437
+ config.access_token = 'YOUR_BEARER_TOKEN'
438
+ end
439
+
440
+ api_instance = Zernio::BusinessAgentApi.new
441
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
442
+ business_agent_skill_input = Zernio::BusinessAgentSkillInput.new({skill: 'skill_example'}) # BusinessAgentSkillInput |
443
+
444
+ begin
445
+ # Create a skill
446
+ result = api_instance.create_business_agent_skill(account_id, business_agent_skill_input)
447
+ p result
448
+ rescue Zernio::ApiError => e
449
+ puts "Error when calling BusinessAgentApi->create_business_agent_skill: #{e}"
450
+ end
451
+ ```
452
+
453
+ #### Using the create_business_agent_skill_with_http_info variant
454
+
455
+ This returns an Array which contains the response data, status code and headers.
456
+
457
+ > <Array(<BusinessAgentSkill>, Integer, Hash)> create_business_agent_skill_with_http_info(account_id, business_agent_skill_input)
458
+
459
+ ```ruby
460
+ begin
461
+ # Create a skill
462
+ data, status_code, headers = api_instance.create_business_agent_skill_with_http_info(account_id, business_agent_skill_input)
463
+ p status_code # => 2xx
464
+ p headers # => { ... }
465
+ p data # => <BusinessAgentSkill>
466
+ rescue Zernio::ApiError => e
467
+ puts "Error when calling BusinessAgentApi->create_business_agent_skill_with_http_info: #{e}"
468
+ end
469
+ ```
470
+
471
+ ### Parameters
472
+
473
+ | Name | Type | Description | Notes |
474
+ | ---- | ---- | ----------- | ----- |
475
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
476
+ | **business_agent_skill_input** | [**BusinessAgentSkillInput**](BusinessAgentSkillInput.md) | | |
477
+
478
+ ### Return type
479
+
480
+ [**BusinessAgentSkill**](BusinessAgentSkill.md)
481
+
482
+ ### Authorization
483
+
484
+ [bearerAuth](../README.md#bearerAuth)
485
+
486
+ ### HTTP request headers
487
+
488
+ - **Content-Type**: application/json
489
+ - **Accept**: application/json
490
+
491
+
492
+ ## create_business_agent_ui_skill
493
+
494
+ > <BusinessAgentUiSkill> create_business_agent_ui_skill(account_id, business_agent_ui_skill_input)
495
+
496
+ Create a UI skill
497
+
498
+ 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.
499
+
500
+ ### Examples
501
+
502
+ ```ruby
503
+ require 'time'
504
+ require 'zernio-sdk'
505
+ # setup authorization
506
+ Zernio.configure do |config|
507
+ # Configure Bearer authorization (JWT): bearerAuth
508
+ config.access_token = 'YOUR_BEARER_TOKEN'
509
+ end
510
+
511
+ api_instance = Zernio::BusinessAgentApi.new
512
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
513
+ business_agent_ui_skill_input = Zernio::BusinessAgentUiSkillInput.new({component_type: 'carousel_quick_reply', status: 'enabled', instruction: 'instruction_example'}) # BusinessAgentUiSkillInput |
514
+
515
+ begin
516
+ # Create a UI skill
517
+ result = api_instance.create_business_agent_ui_skill(account_id, business_agent_ui_skill_input)
518
+ p result
519
+ rescue Zernio::ApiError => e
520
+ puts "Error when calling BusinessAgentApi->create_business_agent_ui_skill: #{e}"
521
+ end
522
+ ```
523
+
524
+ #### Using the create_business_agent_ui_skill_with_http_info variant
525
+
526
+ This returns an Array which contains the response data, status code and headers.
527
+
528
+ > <Array(<BusinessAgentUiSkill>, Integer, Hash)> create_business_agent_ui_skill_with_http_info(account_id, business_agent_ui_skill_input)
529
+
530
+ ```ruby
531
+ begin
532
+ # Create a UI skill
533
+ data, status_code, headers = api_instance.create_business_agent_ui_skill_with_http_info(account_id, business_agent_ui_skill_input)
534
+ p status_code # => 2xx
535
+ p headers # => { ... }
536
+ p data # => <BusinessAgentUiSkill>
537
+ rescue Zernio::ApiError => e
538
+ puts "Error when calling BusinessAgentApi->create_business_agent_ui_skill_with_http_info: #{e}"
539
+ end
540
+ ```
541
+
542
+ ### Parameters
543
+
544
+ | Name | Type | Description | Notes |
545
+ | ---- | ---- | ----------- | ----- |
546
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
547
+ | **business_agent_ui_skill_input** | [**BusinessAgentUiSkillInput**](BusinessAgentUiSkillInput.md) | | |
548
+
549
+ ### Return type
550
+
551
+ [**BusinessAgentUiSkill**](BusinessAgentUiSkill.md)
552
+
553
+ ### Authorization
554
+
555
+ [bearerAuth](../README.md#bearerAuth)
556
+
557
+ ### HTTP request headers
558
+
559
+ - **Content-Type**: application/json
560
+ - **Accept**: application/json
561
+
562
+
563
+ ## delete_business_agent_connector
564
+
565
+ > <InlineObject> delete_business_agent_connector(account_id, connector_id)
566
+
567
+ Delete a connector
568
+
569
+ ### Examples
570
+
571
+ ```ruby
572
+ require 'time'
573
+ require 'zernio-sdk'
574
+ # setup authorization
575
+ Zernio.configure do |config|
576
+ # Configure Bearer authorization (JWT): bearerAuth
577
+ config.access_token = 'YOUR_BEARER_TOKEN'
578
+ end
579
+
580
+ api_instance = Zernio::BusinessAgentApi.new
581
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
582
+ connector_id = 'connector_id_example' # String |
583
+
584
+ begin
585
+ # Delete a connector
586
+ result = api_instance.delete_business_agent_connector(account_id, connector_id)
587
+ p result
588
+ rescue Zernio::ApiError => e
589
+ puts "Error when calling BusinessAgentApi->delete_business_agent_connector: #{e}"
590
+ end
591
+ ```
592
+
593
+ #### Using the delete_business_agent_connector_with_http_info variant
594
+
595
+ This returns an Array which contains the response data, status code and headers.
596
+
597
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_connector_with_http_info(account_id, connector_id)
598
+
599
+ ```ruby
600
+ begin
601
+ # Delete a connector
602
+ data, status_code, headers = api_instance.delete_business_agent_connector_with_http_info(account_id, connector_id)
603
+ p status_code # => 2xx
604
+ p headers # => { ... }
605
+ p data # => <InlineObject>
606
+ rescue Zernio::ApiError => e
607
+ puts "Error when calling BusinessAgentApi->delete_business_agent_connector_with_http_info: #{e}"
608
+ end
609
+ ```
610
+
611
+ ### Parameters
612
+
613
+ | Name | Type | Description | Notes |
614
+ | ---- | ---- | ----------- | ----- |
615
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
616
+ | **connector_id** | **String** | | |
617
+
618
+ ### Return type
619
+
620
+ [**InlineObject**](InlineObject.md)
621
+
622
+ ### Authorization
623
+
624
+ [bearerAuth](../README.md#bearerAuth)
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: Not defined
629
+ - **Accept**: application/json
630
+
631
+
632
+ ## delete_business_agent_connector_tool
633
+
634
+ > <InlineObject> delete_business_agent_connector_tool(account_id, connector_id, tool_id)
635
+
636
+ Delete a connector tool
637
+
638
+ ### Examples
639
+
640
+ ```ruby
641
+ require 'time'
642
+ require 'zernio-sdk'
643
+ # setup authorization
644
+ Zernio.configure do |config|
645
+ # Configure Bearer authorization (JWT): bearerAuth
646
+ config.access_token = 'YOUR_BEARER_TOKEN'
647
+ end
648
+
649
+ api_instance = Zernio::BusinessAgentApi.new
650
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
651
+ connector_id = 'connector_id_example' # String |
652
+ tool_id = 'tool_id_example' # String |
653
+
654
+ begin
655
+ # Delete a connector tool
656
+ result = api_instance.delete_business_agent_connector_tool(account_id, connector_id, tool_id)
657
+ p result
658
+ rescue Zernio::ApiError => e
659
+ puts "Error when calling BusinessAgentApi->delete_business_agent_connector_tool: #{e}"
660
+ end
661
+ ```
662
+
663
+ #### Using the delete_business_agent_connector_tool_with_http_info variant
664
+
665
+ This returns an Array which contains the response data, status code and headers.
666
+
667
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id)
668
+
669
+ ```ruby
670
+ begin
671
+ # Delete a connector tool
672
+ data, status_code, headers = api_instance.delete_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id)
673
+ p status_code # => 2xx
674
+ p headers # => { ... }
675
+ p data # => <InlineObject>
676
+ rescue Zernio::ApiError => e
677
+ puts "Error when calling BusinessAgentApi->delete_business_agent_connector_tool_with_http_info: #{e}"
678
+ end
679
+ ```
680
+
681
+ ### Parameters
682
+
683
+ | Name | Type | Description | Notes |
684
+ | ---- | ---- | ----------- | ----- |
685
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
686
+ | **connector_id** | **String** | | |
687
+ | **tool_id** | **String** | | |
688
+
689
+ ### Return type
690
+
691
+ [**InlineObject**](InlineObject.md)
692
+
693
+ ### Authorization
694
+
695
+ [bearerAuth](../README.md#bearerAuth)
696
+
697
+ ### HTTP request headers
698
+
699
+ - **Content-Type**: Not defined
700
+ - **Accept**: application/json
701
+
702
+
703
+ ## delete_business_agent_faq
704
+
705
+ > <InlineObject> delete_business_agent_faq(account_id, faq_id)
706
+
707
+ Delete a FAQ
708
+
709
+ ### Examples
710
+
711
+ ```ruby
712
+ require 'time'
713
+ require 'zernio-sdk'
714
+ # setup authorization
715
+ Zernio.configure do |config|
716
+ # Configure Bearer authorization (JWT): bearerAuth
717
+ config.access_token = 'YOUR_BEARER_TOKEN'
718
+ end
719
+
720
+ api_instance = Zernio::BusinessAgentApi.new
721
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
722
+ faq_id = 'faq_id_example' # String |
723
+
724
+ begin
725
+ # Delete a FAQ
726
+ result = api_instance.delete_business_agent_faq(account_id, faq_id)
727
+ p result
728
+ rescue Zernio::ApiError => e
729
+ puts "Error when calling BusinessAgentApi->delete_business_agent_faq: #{e}"
730
+ end
731
+ ```
732
+
733
+ #### Using the delete_business_agent_faq_with_http_info variant
734
+
735
+ This returns an Array which contains the response data, status code and headers.
736
+
737
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_faq_with_http_info(account_id, faq_id)
738
+
739
+ ```ruby
740
+ begin
741
+ # Delete a FAQ
742
+ data, status_code, headers = api_instance.delete_business_agent_faq_with_http_info(account_id, faq_id)
743
+ p status_code # => 2xx
744
+ p headers # => { ... }
745
+ p data # => <InlineObject>
746
+ rescue Zernio::ApiError => e
747
+ puts "Error when calling BusinessAgentApi->delete_business_agent_faq_with_http_info: #{e}"
748
+ end
749
+ ```
750
+
751
+ ### Parameters
752
+
753
+ | Name | Type | Description | Notes |
754
+ | ---- | ---- | ----------- | ----- |
755
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
756
+ | **faq_id** | **String** | | |
757
+
758
+ ### Return type
759
+
760
+ [**InlineObject**](InlineObject.md)
761
+
762
+ ### Authorization
763
+
764
+ [bearerAuth](../README.md#bearerAuth)
765
+
766
+ ### HTTP request headers
767
+
768
+ - **Content-Type**: Not defined
769
+ - **Accept**: application/json
770
+
771
+
772
+ ## delete_business_agent_file
773
+
774
+ > <InlineObject> delete_business_agent_file(account_id, file_id)
775
+
776
+ Delete a knowledge file
777
+
778
+ ### Examples
779
+
780
+ ```ruby
781
+ require 'time'
782
+ require 'zernio-sdk'
783
+ # setup authorization
784
+ Zernio.configure do |config|
785
+ # Configure Bearer authorization (JWT): bearerAuth
786
+ config.access_token = 'YOUR_BEARER_TOKEN'
787
+ end
788
+
789
+ api_instance = Zernio::BusinessAgentApi.new
790
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
791
+ file_id = 'file_id_example' # String |
792
+
793
+ begin
794
+ # Delete a knowledge file
795
+ result = api_instance.delete_business_agent_file(account_id, file_id)
796
+ p result
797
+ rescue Zernio::ApiError => e
798
+ puts "Error when calling BusinessAgentApi->delete_business_agent_file: #{e}"
799
+ end
800
+ ```
801
+
802
+ #### Using the delete_business_agent_file_with_http_info variant
803
+
804
+ This returns an Array which contains the response data, status code and headers.
805
+
806
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_file_with_http_info(account_id, file_id)
807
+
808
+ ```ruby
809
+ begin
810
+ # Delete a knowledge file
811
+ data, status_code, headers = api_instance.delete_business_agent_file_with_http_info(account_id, file_id)
812
+ p status_code # => 2xx
813
+ p headers # => { ... }
814
+ p data # => <InlineObject>
815
+ rescue Zernio::ApiError => e
816
+ puts "Error when calling BusinessAgentApi->delete_business_agent_file_with_http_info: #{e}"
817
+ end
818
+ ```
819
+
820
+ ### Parameters
821
+
822
+ | Name | Type | Description | Notes |
823
+ | ---- | ---- | ----------- | ----- |
824
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
825
+ | **file_id** | **String** | | |
826
+
827
+ ### Return type
828
+
829
+ [**InlineObject**](InlineObject.md)
830
+
831
+ ### Authorization
832
+
833
+ [bearerAuth](../README.md#bearerAuth)
834
+
835
+ ### HTTP request headers
836
+
837
+ - **Content-Type**: Not defined
838
+ - **Accept**: application/json
839
+
840
+
841
+ ## delete_business_agent_skill
842
+
843
+ > <InlineObject> delete_business_agent_skill(account_id, skill_id)
844
+
845
+ Delete a skill
846
+
847
+ ### Examples
848
+
849
+ ```ruby
850
+ require 'time'
851
+ require 'zernio-sdk'
852
+ # setup authorization
853
+ Zernio.configure do |config|
854
+ # Configure Bearer authorization (JWT): bearerAuth
855
+ config.access_token = 'YOUR_BEARER_TOKEN'
856
+ end
857
+
858
+ api_instance = Zernio::BusinessAgentApi.new
859
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
860
+ skill_id = 'skill_id_example' # String |
861
+
862
+ begin
863
+ # Delete a skill
864
+ result = api_instance.delete_business_agent_skill(account_id, skill_id)
865
+ p result
866
+ rescue Zernio::ApiError => e
867
+ puts "Error when calling BusinessAgentApi->delete_business_agent_skill: #{e}"
868
+ end
869
+ ```
870
+
871
+ #### Using the delete_business_agent_skill_with_http_info variant
872
+
873
+ This returns an Array which contains the response data, status code and headers.
874
+
875
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_skill_with_http_info(account_id, skill_id)
876
+
877
+ ```ruby
878
+ begin
879
+ # Delete a skill
880
+ data, status_code, headers = api_instance.delete_business_agent_skill_with_http_info(account_id, skill_id)
881
+ p status_code # => 2xx
882
+ p headers # => { ... }
883
+ p data # => <InlineObject>
884
+ rescue Zernio::ApiError => e
885
+ puts "Error when calling BusinessAgentApi->delete_business_agent_skill_with_http_info: #{e}"
886
+ end
887
+ ```
888
+
889
+ ### Parameters
890
+
891
+ | Name | Type | Description | Notes |
892
+ | ---- | ---- | ----------- | ----- |
893
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
894
+ | **skill_id** | **String** | | |
895
+
896
+ ### Return type
897
+
898
+ [**InlineObject**](InlineObject.md)
899
+
900
+ ### Authorization
901
+
902
+ [bearerAuth](../README.md#bearerAuth)
903
+
904
+ ### HTTP request headers
905
+
906
+ - **Content-Type**: Not defined
907
+ - **Accept**: application/json
908
+
909
+
910
+ ## delete_business_agent_ui_skill
911
+
912
+ > <InlineObject> delete_business_agent_ui_skill(account_id, ui_skill_id)
913
+
914
+ Delete a UI skill
915
+
916
+ ### Examples
917
+
918
+ ```ruby
919
+ require 'time'
920
+ require 'zernio-sdk'
921
+ # setup authorization
922
+ Zernio.configure do |config|
923
+ # Configure Bearer authorization (JWT): bearerAuth
924
+ config.access_token = 'YOUR_BEARER_TOKEN'
925
+ end
926
+
927
+ api_instance = Zernio::BusinessAgentApi.new
928
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
929
+ ui_skill_id = 'ui_skill_id_example' # String |
930
+
931
+ begin
932
+ # Delete a UI skill
933
+ result = api_instance.delete_business_agent_ui_skill(account_id, ui_skill_id)
934
+ p result
935
+ rescue Zernio::ApiError => e
936
+ puts "Error when calling BusinessAgentApi->delete_business_agent_ui_skill: #{e}"
937
+ end
938
+ ```
939
+
940
+ #### Using the delete_business_agent_ui_skill_with_http_info variant
941
+
942
+ This returns an Array which contains the response data, status code and headers.
943
+
944
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_ui_skill_with_http_info(account_id, ui_skill_id)
945
+
946
+ ```ruby
947
+ begin
948
+ # Delete a UI skill
949
+ data, status_code, headers = api_instance.delete_business_agent_ui_skill_with_http_info(account_id, ui_skill_id)
950
+ p status_code # => 2xx
951
+ p headers # => { ... }
952
+ p data # => <InlineObject>
953
+ rescue Zernio::ApiError => e
954
+ puts "Error when calling BusinessAgentApi->delete_business_agent_ui_skill_with_http_info: #{e}"
955
+ end
956
+ ```
957
+
958
+ ### Parameters
959
+
960
+ | Name | Type | Description | Notes |
961
+ | ---- | ---- | ----------- | ----- |
962
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
963
+ | **ui_skill_id** | **String** | | |
964
+
965
+ ### Return type
966
+
967
+ [**InlineObject**](InlineObject.md)
968
+
969
+ ### Authorization
970
+
971
+ [bearerAuth](../README.md#bearerAuth)
972
+
973
+ ### HTTP request headers
974
+
975
+ - **Content-Type**: Not defined
976
+ - **Accept**: application/json
977
+
978
+
979
+ ## delete_business_agent_website
980
+
981
+ > <InlineObject> delete_business_agent_website(account_id, website_id)
982
+
983
+ Remove a crawled website
984
+
985
+ ### Examples
986
+
987
+ ```ruby
988
+ require 'time'
989
+ require 'zernio-sdk'
990
+ # setup authorization
991
+ Zernio.configure do |config|
992
+ # Configure Bearer authorization (JWT): bearerAuth
993
+ config.access_token = 'YOUR_BEARER_TOKEN'
994
+ end
995
+
996
+ api_instance = Zernio::BusinessAgentApi.new
997
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
998
+ website_id = 'website_id_example' # String |
999
+
1000
+ begin
1001
+ # Remove a crawled website
1002
+ result = api_instance.delete_business_agent_website(account_id, website_id)
1003
+ p result
1004
+ rescue Zernio::ApiError => e
1005
+ puts "Error when calling BusinessAgentApi->delete_business_agent_website: #{e}"
1006
+ end
1007
+ ```
1008
+
1009
+ #### Using the delete_business_agent_website_with_http_info variant
1010
+
1011
+ This returns an Array which contains the response data, status code and headers.
1012
+
1013
+ > <Array(<InlineObject>, Integer, Hash)> delete_business_agent_website_with_http_info(account_id, website_id)
1014
+
1015
+ ```ruby
1016
+ begin
1017
+ # Remove a crawled website
1018
+ data, status_code, headers = api_instance.delete_business_agent_website_with_http_info(account_id, website_id)
1019
+ p status_code # => 2xx
1020
+ p headers # => { ... }
1021
+ p data # => <InlineObject>
1022
+ rescue Zernio::ApiError => e
1023
+ puts "Error when calling BusinessAgentApi->delete_business_agent_website_with_http_info: #{e}"
1024
+ end
1025
+ ```
1026
+
1027
+ ### Parameters
1028
+
1029
+ | Name | Type | Description | Notes |
1030
+ | ---- | ---- | ----------- | ----- |
1031
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1032
+ | **website_id** | **String** | | |
1033
+
1034
+ ### Return type
1035
+
1036
+ [**InlineObject**](InlineObject.md)
1037
+
1038
+ ### Authorization
1039
+
1040
+ [bearerAuth](../README.md#bearerAuth)
1041
+
1042
+ ### HTTP request headers
1043
+
1044
+ - **Content-Type**: Not defined
1045
+ - **Accept**: application/json
1046
+
1047
+
1048
+ ## get_business_agent_budget
1049
+
1050
+ > <GetBusinessAgentBudget200Response> get_business_agent_budget(account_id)
1051
+
1052
+ Get usage budgets
1053
+
1054
+ Caps over rolling windows for the Business Manager that owns the number. An empty list means unlimited.
1055
+
1056
+ ### Examples
1057
+
1058
+ ```ruby
1059
+ require 'time'
1060
+ require 'zernio-sdk'
1061
+ # setup authorization
1062
+ Zernio.configure do |config|
1063
+ # Configure Bearer authorization (JWT): bearerAuth
1064
+ config.access_token = 'YOUR_BEARER_TOKEN'
1065
+ end
1066
+
1067
+ api_instance = Zernio::BusinessAgentApi.new
1068
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1069
+
1070
+ begin
1071
+ # Get usage budgets
1072
+ result = api_instance.get_business_agent_budget(account_id)
1073
+ p result
1074
+ rescue Zernio::ApiError => e
1075
+ puts "Error when calling BusinessAgentApi->get_business_agent_budget: #{e}"
1076
+ end
1077
+ ```
1078
+
1079
+ #### Using the get_business_agent_budget_with_http_info variant
1080
+
1081
+ This returns an Array which contains the response data, status code and headers.
1082
+
1083
+ > <Array(<GetBusinessAgentBudget200Response>, Integer, Hash)> get_business_agent_budget_with_http_info(account_id)
1084
+
1085
+ ```ruby
1086
+ begin
1087
+ # Get usage budgets
1088
+ data, status_code, headers = api_instance.get_business_agent_budget_with_http_info(account_id)
1089
+ p status_code # => 2xx
1090
+ p headers # => { ... }
1091
+ p data # => <GetBusinessAgentBudget200Response>
1092
+ rescue Zernio::ApiError => e
1093
+ puts "Error when calling BusinessAgentApi->get_business_agent_budget_with_http_info: #{e}"
1094
+ end
1095
+ ```
1096
+
1097
+ ### Parameters
1098
+
1099
+ | Name | Type | Description | Notes |
1100
+ | ---- | ---- | ----------- | ----- |
1101
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1102
+
1103
+ ### Return type
1104
+
1105
+ [**GetBusinessAgentBudget200Response**](GetBusinessAgentBudget200Response.md)
1106
+
1107
+ ### Authorization
1108
+
1109
+ [bearerAuth](../README.md#bearerAuth)
1110
+
1111
+ ### HTTP request headers
1112
+
1113
+ - **Content-Type**: Not defined
1114
+ - **Accept**: application/json
1115
+
1116
+
1117
+ ## get_business_agent_business_information
1118
+
1119
+ > <BusinessAgentBusinessInformation> get_business_agent_business_information(account_id)
1120
+
1121
+ Get business information
1122
+
1123
+ Payment methods, return policy, how to buy, shipping, description and contact details the agent answers from. Empty values until configured.
1124
+
1125
+ ### Examples
1126
+
1127
+ ```ruby
1128
+ require 'time'
1129
+ require 'zernio-sdk'
1130
+ # setup authorization
1131
+ Zernio.configure do |config|
1132
+ # Configure Bearer authorization (JWT): bearerAuth
1133
+ config.access_token = 'YOUR_BEARER_TOKEN'
1134
+ end
1135
+
1136
+ api_instance = Zernio::BusinessAgentApi.new
1137
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1138
+
1139
+ begin
1140
+ # Get business information
1141
+ result = api_instance.get_business_agent_business_information(account_id)
1142
+ p result
1143
+ rescue Zernio::ApiError => e
1144
+ puts "Error when calling BusinessAgentApi->get_business_agent_business_information: #{e}"
1145
+ end
1146
+ ```
1147
+
1148
+ #### Using the get_business_agent_business_information_with_http_info variant
1149
+
1150
+ This returns an Array which contains the response data, status code and headers.
1151
+
1152
+ > <Array(<BusinessAgentBusinessInformation>, Integer, Hash)> get_business_agent_business_information_with_http_info(account_id)
1153
+
1154
+ ```ruby
1155
+ begin
1156
+ # Get business information
1157
+ data, status_code, headers = api_instance.get_business_agent_business_information_with_http_info(account_id)
1158
+ p status_code # => 2xx
1159
+ p headers # => { ... }
1160
+ p data # => <BusinessAgentBusinessInformation>
1161
+ rescue Zernio::ApiError => e
1162
+ puts "Error when calling BusinessAgentApi->get_business_agent_business_information_with_http_info: #{e}"
1163
+ end
1164
+ ```
1165
+
1166
+ ### Parameters
1167
+
1168
+ | Name | Type | Description | Notes |
1169
+ | ---- | ---- | ----------- | ----- |
1170
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1171
+
1172
+ ### Return type
1173
+
1174
+ [**BusinessAgentBusinessInformation**](BusinessAgentBusinessInformation.md)
1175
+
1176
+ ### Authorization
1177
+
1178
+ [bearerAuth](../README.md#bearerAuth)
1179
+
1180
+ ### HTTP request headers
1181
+
1182
+ - **Content-Type**: Not defined
1183
+ - **Accept**: application/json
1184
+
1185
+
1186
+ ## get_business_agent_connector
1187
+
1188
+ > <BusinessAgentConnector> get_business_agent_connector(account_id, connector_id)
1189
+
1190
+ Get a connector
1191
+
1192
+ ### Examples
1193
+
1194
+ ```ruby
1195
+ require 'time'
1196
+ require 'zernio-sdk'
1197
+ # setup authorization
1198
+ Zernio.configure do |config|
1199
+ # Configure Bearer authorization (JWT): bearerAuth
1200
+ config.access_token = 'YOUR_BEARER_TOKEN'
1201
+ end
1202
+
1203
+ api_instance = Zernio::BusinessAgentApi.new
1204
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1205
+ connector_id = 'connector_id_example' # String |
1206
+
1207
+ begin
1208
+ # Get a connector
1209
+ result = api_instance.get_business_agent_connector(account_id, connector_id)
1210
+ p result
1211
+ rescue Zernio::ApiError => e
1212
+ puts "Error when calling BusinessAgentApi->get_business_agent_connector: #{e}"
1213
+ end
1214
+ ```
1215
+
1216
+ #### Using the get_business_agent_connector_with_http_info variant
1217
+
1218
+ This returns an Array which contains the response data, status code and headers.
1219
+
1220
+ > <Array(<BusinessAgentConnector>, Integer, Hash)> get_business_agent_connector_with_http_info(account_id, connector_id)
1221
+
1222
+ ```ruby
1223
+ begin
1224
+ # Get a connector
1225
+ data, status_code, headers = api_instance.get_business_agent_connector_with_http_info(account_id, connector_id)
1226
+ p status_code # => 2xx
1227
+ p headers # => { ... }
1228
+ p data # => <BusinessAgentConnector>
1229
+ rescue Zernio::ApiError => e
1230
+ puts "Error when calling BusinessAgentApi->get_business_agent_connector_with_http_info: #{e}"
1231
+ end
1232
+ ```
1233
+
1234
+ ### Parameters
1235
+
1236
+ | Name | Type | Description | Notes |
1237
+ | ---- | ---- | ----------- | ----- |
1238
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1239
+ | **connector_id** | **String** | | |
1240
+
1241
+ ### Return type
1242
+
1243
+ [**BusinessAgentConnector**](BusinessAgentConnector.md)
1244
+
1245
+ ### Authorization
1246
+
1247
+ [bearerAuth](../README.md#bearerAuth)
1248
+
1249
+ ### HTTP request headers
1250
+
1251
+ - **Content-Type**: Not defined
1252
+ - **Accept**: application/json
1253
+
1254
+
1255
+ ## get_business_agent_connector_logs
1256
+
1257
+ > <GetBusinessAgentConnectorLogs200Response> get_business_agent_connector_logs(account_id, connector_id, opts)
1258
+
1259
+ Get connector failure logs
1260
+
1261
+ 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`.
1262
+
1263
+ ### Examples
1264
+
1265
+ ```ruby
1266
+ require 'time'
1267
+ require 'zernio-sdk'
1268
+ # setup authorization
1269
+ Zernio.configure do |config|
1270
+ # Configure Bearer authorization (JWT): bearerAuth
1271
+ config.access_token = 'YOUR_BEARER_TOKEN'
1272
+ end
1273
+
1274
+ api_instance = Zernio::BusinessAgentApi.new
1275
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1276
+ connector_id = 'connector_id_example' # String |
1277
+ opts = {
1278
+ start_time: 56, # Integer | Unix seconds.
1279
+ end_time: 56, # Integer | Unix seconds.
1280
+ limit: 56, # Integer |
1281
+ tool_id: 'tool_id_example', # String |
1282
+ include_stats: true, # Boolean | Add success rate and latency percentiles.
1283
+ summary_only: true, # Boolean | Aggregate failure patterns instead of entries.
1284
+ top_n: 56 # Integer |
1285
+ }
1286
+
1287
+ begin
1288
+ # Get connector failure logs
1289
+ result = api_instance.get_business_agent_connector_logs(account_id, connector_id, opts)
1290
+ p result
1291
+ rescue Zernio::ApiError => e
1292
+ puts "Error when calling BusinessAgentApi->get_business_agent_connector_logs: #{e}"
1293
+ end
1294
+ ```
1295
+
1296
+ #### Using the get_business_agent_connector_logs_with_http_info variant
1297
+
1298
+ This returns an Array which contains the response data, status code and headers.
1299
+
1300
+ > <Array(<GetBusinessAgentConnectorLogs200Response>, Integer, Hash)> get_business_agent_connector_logs_with_http_info(account_id, connector_id, opts)
1301
+
1302
+ ```ruby
1303
+ begin
1304
+ # Get connector failure logs
1305
+ data, status_code, headers = api_instance.get_business_agent_connector_logs_with_http_info(account_id, connector_id, opts)
1306
+ p status_code # => 2xx
1307
+ p headers # => { ... }
1308
+ p data # => <GetBusinessAgentConnectorLogs200Response>
1309
+ rescue Zernio::ApiError => e
1310
+ puts "Error when calling BusinessAgentApi->get_business_agent_connector_logs_with_http_info: #{e}"
1311
+ end
1312
+ ```
1313
+
1314
+ ### Parameters
1315
+
1316
+ | Name | Type | Description | Notes |
1317
+ | ---- | ---- | ----------- | ----- |
1318
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1319
+ | **connector_id** | **String** | | |
1320
+ | **start_time** | **Integer** | Unix seconds. | [optional] |
1321
+ | **end_time** | **Integer** | Unix seconds. | [optional] |
1322
+ | **limit** | **Integer** | | [optional] |
1323
+ | **tool_id** | **String** | | [optional] |
1324
+ | **include_stats** | **Boolean** | Add success rate and latency percentiles. | [optional] |
1325
+ | **summary_only** | **Boolean** | Aggregate failure patterns instead of entries. | [optional] |
1326
+ | **top_n** | **Integer** | | [optional] |
1327
+
1328
+ ### Return type
1329
+
1330
+ [**GetBusinessAgentConnectorLogs200Response**](GetBusinessAgentConnectorLogs200Response.md)
1331
+
1332
+ ### Authorization
1333
+
1334
+ [bearerAuth](../README.md#bearerAuth)
1335
+
1336
+ ### HTTP request headers
1337
+
1338
+ - **Content-Type**: Not defined
1339
+ - **Accept**: application/json
1340
+
1341
+
1342
+ ## get_business_agent_connector_tool
1343
+
1344
+ > <BusinessAgentConnectorTool> get_business_agent_connector_tool(account_id, connector_id, tool_id)
1345
+
1346
+ Get a connector tool
1347
+
1348
+ ### Examples
1349
+
1350
+ ```ruby
1351
+ require 'time'
1352
+ require 'zernio-sdk'
1353
+ # setup authorization
1354
+ Zernio.configure do |config|
1355
+ # Configure Bearer authorization (JWT): bearerAuth
1356
+ config.access_token = 'YOUR_BEARER_TOKEN'
1357
+ end
1358
+
1359
+ api_instance = Zernio::BusinessAgentApi.new
1360
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1361
+ connector_id = 'connector_id_example' # String |
1362
+ tool_id = 'tool_id_example' # String |
1363
+
1364
+ begin
1365
+ # Get a connector tool
1366
+ result = api_instance.get_business_agent_connector_tool(account_id, connector_id, tool_id)
1367
+ p result
1368
+ rescue Zernio::ApiError => e
1369
+ puts "Error when calling BusinessAgentApi->get_business_agent_connector_tool: #{e}"
1370
+ end
1371
+ ```
1372
+
1373
+ #### Using the get_business_agent_connector_tool_with_http_info variant
1374
+
1375
+ This returns an Array which contains the response data, status code and headers.
1376
+
1377
+ > <Array(<BusinessAgentConnectorTool>, Integer, Hash)> get_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id)
1378
+
1379
+ ```ruby
1380
+ begin
1381
+ # Get a connector tool
1382
+ data, status_code, headers = api_instance.get_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id)
1383
+ p status_code # => 2xx
1384
+ p headers # => { ... }
1385
+ p data # => <BusinessAgentConnectorTool>
1386
+ rescue Zernio::ApiError => e
1387
+ puts "Error when calling BusinessAgentApi->get_business_agent_connector_tool_with_http_info: #{e}"
1388
+ end
1389
+ ```
1390
+
1391
+ ### Parameters
1392
+
1393
+ | Name | Type | Description | Notes |
1394
+ | ---- | ---- | ----------- | ----- |
1395
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1396
+ | **connector_id** | **String** | | |
1397
+ | **tool_id** | **String** | | |
1398
+
1399
+ ### Return type
1400
+
1401
+ [**BusinessAgentConnectorTool**](BusinessAgentConnectorTool.md)
1402
+
1403
+ ### Authorization
1404
+
1405
+ [bearerAuth](../README.md#bearerAuth)
1406
+
1407
+ ### HTTP request headers
1408
+
1409
+ - **Content-Type**: Not defined
1410
+ - **Accept**: application/json
1411
+
1412
+
1413
+ ## get_business_agent_event
1414
+
1415
+ > <BusinessAgentEventStatus> get_business_agent_event(account_id, event_id)
1416
+
1417
+ Get a business event status
1418
+
1419
+ ### Examples
1420
+
1421
+ ```ruby
1422
+ require 'time'
1423
+ require 'zernio-sdk'
1424
+ # setup authorization
1425
+ Zernio.configure do |config|
1426
+ # Configure Bearer authorization (JWT): bearerAuth
1427
+ config.access_token = 'YOUR_BEARER_TOKEN'
1428
+ end
1429
+
1430
+ api_instance = Zernio::BusinessAgentApi.new
1431
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1432
+ event_id = 'event_id_example' # String |
1433
+
1434
+ begin
1435
+ # Get a business event status
1436
+ result = api_instance.get_business_agent_event(account_id, event_id)
1437
+ p result
1438
+ rescue Zernio::ApiError => e
1439
+ puts "Error when calling BusinessAgentApi->get_business_agent_event: #{e}"
1440
+ end
1441
+ ```
1442
+
1443
+ #### Using the get_business_agent_event_with_http_info variant
1444
+
1445
+ This returns an Array which contains the response data, status code and headers.
1446
+
1447
+ > <Array(<BusinessAgentEventStatus>, Integer, Hash)> get_business_agent_event_with_http_info(account_id, event_id)
1448
+
1449
+ ```ruby
1450
+ begin
1451
+ # Get a business event status
1452
+ data, status_code, headers = api_instance.get_business_agent_event_with_http_info(account_id, event_id)
1453
+ p status_code # => 2xx
1454
+ p headers # => { ... }
1455
+ p data # => <BusinessAgentEventStatus>
1456
+ rescue Zernio::ApiError => e
1457
+ puts "Error when calling BusinessAgentApi->get_business_agent_event_with_http_info: #{e}"
1458
+ end
1459
+ ```
1460
+
1461
+ ### Parameters
1462
+
1463
+ | Name | Type | Description | Notes |
1464
+ | ---- | ---- | ----------- | ----- |
1465
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1466
+ | **event_id** | **String** | | |
1467
+
1468
+ ### Return type
1469
+
1470
+ [**BusinessAgentEventStatus**](BusinessAgentEventStatus.md)
1471
+
1472
+ ### Authorization
1473
+
1474
+ [bearerAuth](../README.md#bearerAuth)
1475
+
1476
+ ### HTTP request headers
1477
+
1478
+ - **Content-Type**: Not defined
1479
+ - **Accept**: application/json
1480
+
1481
+
1482
+ ## get_business_agent_faq
1483
+
1484
+ > <BusinessAgentFaq> get_business_agent_faq(account_id, faq_id)
1485
+
1486
+ Get a FAQ
1487
+
1488
+ ### Examples
1489
+
1490
+ ```ruby
1491
+ require 'time'
1492
+ require 'zernio-sdk'
1493
+ # setup authorization
1494
+ Zernio.configure do |config|
1495
+ # Configure Bearer authorization (JWT): bearerAuth
1496
+ config.access_token = 'YOUR_BEARER_TOKEN'
1497
+ end
1498
+
1499
+ api_instance = Zernio::BusinessAgentApi.new
1500
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1501
+ faq_id = 'faq_id_example' # String |
1502
+
1503
+ begin
1504
+ # Get a FAQ
1505
+ result = api_instance.get_business_agent_faq(account_id, faq_id)
1506
+ p result
1507
+ rescue Zernio::ApiError => e
1508
+ puts "Error when calling BusinessAgentApi->get_business_agent_faq: #{e}"
1509
+ end
1510
+ ```
1511
+
1512
+ #### Using the get_business_agent_faq_with_http_info variant
1513
+
1514
+ This returns an Array which contains the response data, status code and headers.
1515
+
1516
+ > <Array(<BusinessAgentFaq>, Integer, Hash)> get_business_agent_faq_with_http_info(account_id, faq_id)
1517
+
1518
+ ```ruby
1519
+ begin
1520
+ # Get a FAQ
1521
+ data, status_code, headers = api_instance.get_business_agent_faq_with_http_info(account_id, faq_id)
1522
+ p status_code # => 2xx
1523
+ p headers # => { ... }
1524
+ p data # => <BusinessAgentFaq>
1525
+ rescue Zernio::ApiError => e
1526
+ puts "Error when calling BusinessAgentApi->get_business_agent_faq_with_http_info: #{e}"
1527
+ end
1528
+ ```
1529
+
1530
+ ### Parameters
1531
+
1532
+ | Name | Type | Description | Notes |
1533
+ | ---- | ---- | ----------- | ----- |
1534
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1535
+ | **faq_id** | **String** | | |
1536
+
1537
+ ### Return type
1538
+
1539
+ [**BusinessAgentFaq**](BusinessAgentFaq.md)
1540
+
1541
+ ### Authorization
1542
+
1543
+ [bearerAuth](../README.md#bearerAuth)
1544
+
1545
+ ### HTTP request headers
1546
+
1547
+ - **Content-Type**: Not defined
1548
+ - **Accept**: application/json
1549
+
1550
+
1551
+ ## get_business_agent_file
1552
+
1553
+ > <BusinessAgentKnowledgeFile> get_business_agent_file(account_id, file_id)
1554
+
1555
+ Get a knowledge file
1556
+
1557
+ ### Examples
1558
+
1559
+ ```ruby
1560
+ require 'time'
1561
+ require 'zernio-sdk'
1562
+ # setup authorization
1563
+ Zernio.configure do |config|
1564
+ # Configure Bearer authorization (JWT): bearerAuth
1565
+ config.access_token = 'YOUR_BEARER_TOKEN'
1566
+ end
1567
+
1568
+ api_instance = Zernio::BusinessAgentApi.new
1569
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1570
+ file_id = 'file_id_example' # String |
1571
+
1572
+ begin
1573
+ # Get a knowledge file
1574
+ result = api_instance.get_business_agent_file(account_id, file_id)
1575
+ p result
1576
+ rescue Zernio::ApiError => e
1577
+ puts "Error when calling BusinessAgentApi->get_business_agent_file: #{e}"
1578
+ end
1579
+ ```
1580
+
1581
+ #### Using the get_business_agent_file_with_http_info variant
1582
+
1583
+ This returns an Array which contains the response data, status code and headers.
1584
+
1585
+ > <Array(<BusinessAgentKnowledgeFile>, Integer, Hash)> get_business_agent_file_with_http_info(account_id, file_id)
1586
+
1587
+ ```ruby
1588
+ begin
1589
+ # Get a knowledge file
1590
+ data, status_code, headers = api_instance.get_business_agent_file_with_http_info(account_id, file_id)
1591
+ p status_code # => 2xx
1592
+ p headers # => { ... }
1593
+ p data # => <BusinessAgentKnowledgeFile>
1594
+ rescue Zernio::ApiError => e
1595
+ puts "Error when calling BusinessAgentApi->get_business_agent_file_with_http_info: #{e}"
1596
+ end
1597
+ ```
1598
+
1599
+ ### Parameters
1600
+
1601
+ | Name | Type | Description | Notes |
1602
+ | ---- | ---- | ----------- | ----- |
1603
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1604
+ | **file_id** | **String** | | |
1605
+
1606
+ ### Return type
1607
+
1608
+ [**BusinessAgentKnowledgeFile**](BusinessAgentKnowledgeFile.md)
1609
+
1610
+ ### Authorization
1611
+
1612
+ [bearerAuth](../README.md#bearerAuth)
1613
+
1614
+ ### HTTP request headers
1615
+
1616
+ - **Content-Type**: Not defined
1617
+ - **Accept**: application/json
1618
+
1619
+
1620
+ ## get_business_agent_skill
1621
+
1622
+ > <BusinessAgentSkill> get_business_agent_skill(account_id, skill_id)
1623
+
1624
+ Get a skill
1625
+
1626
+ ### Examples
1627
+
1628
+ ```ruby
1629
+ require 'time'
1630
+ require 'zernio-sdk'
1631
+ # setup authorization
1632
+ Zernio.configure do |config|
1633
+ # Configure Bearer authorization (JWT): bearerAuth
1634
+ config.access_token = 'YOUR_BEARER_TOKEN'
1635
+ end
1636
+
1637
+ api_instance = Zernio::BusinessAgentApi.new
1638
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1639
+ skill_id = 'skill_id_example' # String |
1640
+
1641
+ begin
1642
+ # Get a skill
1643
+ result = api_instance.get_business_agent_skill(account_id, skill_id)
1644
+ p result
1645
+ rescue Zernio::ApiError => e
1646
+ puts "Error when calling BusinessAgentApi->get_business_agent_skill: #{e}"
1647
+ end
1648
+ ```
1649
+
1650
+ #### Using the get_business_agent_skill_with_http_info variant
1651
+
1652
+ This returns an Array which contains the response data, status code and headers.
1653
+
1654
+ > <Array(<BusinessAgentSkill>, Integer, Hash)> get_business_agent_skill_with_http_info(account_id, skill_id)
1655
+
1656
+ ```ruby
1657
+ begin
1658
+ # Get a skill
1659
+ data, status_code, headers = api_instance.get_business_agent_skill_with_http_info(account_id, skill_id)
1660
+ p status_code # => 2xx
1661
+ p headers # => { ... }
1662
+ p data # => <BusinessAgentSkill>
1663
+ rescue Zernio::ApiError => e
1664
+ puts "Error when calling BusinessAgentApi->get_business_agent_skill_with_http_info: #{e}"
1665
+ end
1666
+ ```
1667
+
1668
+ ### Parameters
1669
+
1670
+ | Name | Type | Description | Notes |
1671
+ | ---- | ---- | ----------- | ----- |
1672
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1673
+ | **skill_id** | **String** | | |
1674
+
1675
+ ### Return type
1676
+
1677
+ [**BusinessAgentSkill**](BusinessAgentSkill.md)
1678
+
1679
+ ### Authorization
1680
+
1681
+ [bearerAuth](../README.md#bearerAuth)
1682
+
1683
+ ### HTTP request headers
1684
+
1685
+ - **Content-Type**: Not defined
1686
+ - **Accept**: application/json
1687
+
1688
+
1689
+ ## get_business_agent_status
1690
+
1691
+ > <BusinessAgentStatus> get_business_agent_status(account_id)
1692
+
1693
+ Get agent setup status
1694
+
1695
+ 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.
1696
+
1697
+ ### Examples
1698
+
1699
+ ```ruby
1700
+ require 'time'
1701
+ require 'zernio-sdk'
1702
+ # setup authorization
1703
+ Zernio.configure do |config|
1704
+ # Configure Bearer authorization (JWT): bearerAuth
1705
+ config.access_token = 'YOUR_BEARER_TOKEN'
1706
+ end
1707
+
1708
+ api_instance = Zernio::BusinessAgentApi.new
1709
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1710
+
1711
+ begin
1712
+ # Get agent setup status
1713
+ result = api_instance.get_business_agent_status(account_id)
1714
+ p result
1715
+ rescue Zernio::ApiError => e
1716
+ puts "Error when calling BusinessAgentApi->get_business_agent_status: #{e}"
1717
+ end
1718
+ ```
1719
+
1720
+ #### Using the get_business_agent_status_with_http_info variant
1721
+
1722
+ This returns an Array which contains the response data, status code and headers.
1723
+
1724
+ > <Array(<BusinessAgentStatus>, Integer, Hash)> get_business_agent_status_with_http_info(account_id)
1725
+
1726
+ ```ruby
1727
+ begin
1728
+ # Get agent setup status
1729
+ data, status_code, headers = api_instance.get_business_agent_status_with_http_info(account_id)
1730
+ p status_code # => 2xx
1731
+ p headers # => { ... }
1732
+ p data # => <BusinessAgentStatus>
1733
+ rescue Zernio::ApiError => e
1734
+ puts "Error when calling BusinessAgentApi->get_business_agent_status_with_http_info: #{e}"
1735
+ end
1736
+ ```
1737
+
1738
+ ### Parameters
1739
+
1740
+ | Name | Type | Description | Notes |
1741
+ | ---- | ---- | ----------- | ----- |
1742
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1743
+
1744
+ ### Return type
1745
+
1746
+ [**BusinessAgentStatus**](BusinessAgentStatus.md)
1747
+
1748
+ ### Authorization
1749
+
1750
+ [bearerAuth](../README.md#bearerAuth)
1751
+
1752
+ ### HTTP request headers
1753
+
1754
+ - **Content-Type**: Not defined
1755
+ - **Accept**: application/json
1756
+
1757
+
1758
+ ## get_business_agent_ui_skill
1759
+
1760
+ > <BusinessAgentUiSkill> get_business_agent_ui_skill(account_id, ui_skill_id)
1761
+
1762
+ Get a UI skill
1763
+
1764
+ ### Examples
1765
+
1766
+ ```ruby
1767
+ require 'time'
1768
+ require 'zernio-sdk'
1769
+ # setup authorization
1770
+ Zernio.configure do |config|
1771
+ # Configure Bearer authorization (JWT): bearerAuth
1772
+ config.access_token = 'YOUR_BEARER_TOKEN'
1773
+ end
1774
+
1775
+ api_instance = Zernio::BusinessAgentApi.new
1776
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1777
+ ui_skill_id = 'ui_skill_id_example' # String |
1778
+
1779
+ begin
1780
+ # Get a UI skill
1781
+ result = api_instance.get_business_agent_ui_skill(account_id, ui_skill_id)
1782
+ p result
1783
+ rescue Zernio::ApiError => e
1784
+ puts "Error when calling BusinessAgentApi->get_business_agent_ui_skill: #{e}"
1785
+ end
1786
+ ```
1787
+
1788
+ #### Using the get_business_agent_ui_skill_with_http_info variant
1789
+
1790
+ This returns an Array which contains the response data, status code and headers.
1791
+
1792
+ > <Array(<BusinessAgentUiSkill>, Integer, Hash)> get_business_agent_ui_skill_with_http_info(account_id, ui_skill_id)
1793
+
1794
+ ```ruby
1795
+ begin
1796
+ # Get a UI skill
1797
+ data, status_code, headers = api_instance.get_business_agent_ui_skill_with_http_info(account_id, ui_skill_id)
1798
+ p status_code # => 2xx
1799
+ p headers # => { ... }
1800
+ p data # => <BusinessAgentUiSkill>
1801
+ rescue Zernio::ApiError => e
1802
+ puts "Error when calling BusinessAgentApi->get_business_agent_ui_skill_with_http_info: #{e}"
1803
+ end
1804
+ ```
1805
+
1806
+ ### Parameters
1807
+
1808
+ | Name | Type | Description | Notes |
1809
+ | ---- | ---- | ----------- | ----- |
1810
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1811
+ | **ui_skill_id** | **String** | | |
1812
+
1813
+ ### Return type
1814
+
1815
+ [**BusinessAgentUiSkill**](BusinessAgentUiSkill.md)
1816
+
1817
+ ### Authorization
1818
+
1819
+ [bearerAuth](../README.md#bearerAuth)
1820
+
1821
+ ### HTTP request headers
1822
+
1823
+ - **Content-Type**: Not defined
1824
+ - **Accept**: application/json
1825
+
1826
+
1827
+ ## get_business_agent_website
1828
+
1829
+ > <BusinessAgentWebsite> get_business_agent_website(account_id, website_id)
1830
+
1831
+ Get a crawled website
1832
+
1833
+ ### Examples
1834
+
1835
+ ```ruby
1836
+ require 'time'
1837
+ require 'zernio-sdk'
1838
+ # setup authorization
1839
+ Zernio.configure do |config|
1840
+ # Configure Bearer authorization (JWT): bearerAuth
1841
+ config.access_token = 'YOUR_BEARER_TOKEN'
1842
+ end
1843
+
1844
+ api_instance = Zernio::BusinessAgentApi.new
1845
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1846
+ website_id = 'website_id_example' # String |
1847
+
1848
+ begin
1849
+ # Get a crawled website
1850
+ result = api_instance.get_business_agent_website(account_id, website_id)
1851
+ p result
1852
+ rescue Zernio::ApiError => e
1853
+ puts "Error when calling BusinessAgentApi->get_business_agent_website: #{e}"
1854
+ end
1855
+ ```
1856
+
1857
+ #### Using the get_business_agent_website_with_http_info variant
1858
+
1859
+ This returns an Array which contains the response data, status code and headers.
1860
+
1861
+ > <Array(<BusinessAgentWebsite>, Integer, Hash)> get_business_agent_website_with_http_info(account_id, website_id)
1862
+
1863
+ ```ruby
1864
+ begin
1865
+ # Get a crawled website
1866
+ data, status_code, headers = api_instance.get_business_agent_website_with_http_info(account_id, website_id)
1867
+ p status_code # => 2xx
1868
+ p headers # => { ... }
1869
+ p data # => <BusinessAgentWebsite>
1870
+ rescue Zernio::ApiError => e
1871
+ puts "Error when calling BusinessAgentApi->get_business_agent_website_with_http_info: #{e}"
1872
+ end
1873
+ ```
1874
+
1875
+ ### Parameters
1876
+
1877
+ | Name | Type | Description | Notes |
1878
+ | ---- | ---- | ----------- | ----- |
1879
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1880
+ | **website_id** | **String** | | |
1881
+
1882
+ ### Return type
1883
+
1884
+ [**BusinessAgentWebsite**](BusinessAgentWebsite.md)
1885
+
1886
+ ### Authorization
1887
+
1888
+ [bearerAuth](../README.md#bearerAuth)
1889
+
1890
+ ### HTTP request headers
1891
+
1892
+ - **Content-Type**: Not defined
1893
+ - **Accept**: application/json
1894
+
1895
+
1896
+ ## list_business_agent_allowlist
1897
+
1898
+ > <ListBusinessAgentAllowlist200Response> list_business_agent_allowlist(account_id)
1899
+
1900
+ List allowlisted consumers
1901
+
1902
+ Consumers the agent answers while `ai_audience` is ALLOWLISTED_ONLY.
1903
+
1904
+ ### Examples
1905
+
1906
+ ```ruby
1907
+ require 'time'
1908
+ require 'zernio-sdk'
1909
+ # setup authorization
1910
+ Zernio.configure do |config|
1911
+ # Configure Bearer authorization (JWT): bearerAuth
1912
+ config.access_token = 'YOUR_BEARER_TOKEN'
1913
+ end
1914
+
1915
+ api_instance = Zernio::BusinessAgentApi.new
1916
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1917
+
1918
+ begin
1919
+ # List allowlisted consumers
1920
+ result = api_instance.list_business_agent_allowlist(account_id)
1921
+ p result
1922
+ rescue Zernio::ApiError => e
1923
+ puts "Error when calling BusinessAgentApi->list_business_agent_allowlist: #{e}"
1924
+ end
1925
+ ```
1926
+
1927
+ #### Using the list_business_agent_allowlist_with_http_info variant
1928
+
1929
+ This returns an Array which contains the response data, status code and headers.
1930
+
1931
+ > <Array(<ListBusinessAgentAllowlist200Response>, Integer, Hash)> list_business_agent_allowlist_with_http_info(account_id)
1932
+
1933
+ ```ruby
1934
+ begin
1935
+ # List allowlisted consumers
1936
+ data, status_code, headers = api_instance.list_business_agent_allowlist_with_http_info(account_id)
1937
+ p status_code # => 2xx
1938
+ p headers # => { ... }
1939
+ p data # => <ListBusinessAgentAllowlist200Response>
1940
+ rescue Zernio::ApiError => e
1941
+ puts "Error when calling BusinessAgentApi->list_business_agent_allowlist_with_http_info: #{e}"
1942
+ end
1943
+ ```
1944
+
1945
+ ### Parameters
1946
+
1947
+ | Name | Type | Description | Notes |
1948
+ | ---- | ---- | ----------- | ----- |
1949
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
1950
+
1951
+ ### Return type
1952
+
1953
+ [**ListBusinessAgentAllowlist200Response**](ListBusinessAgentAllowlist200Response.md)
1954
+
1955
+ ### Authorization
1956
+
1957
+ [bearerAuth](../README.md#bearerAuth)
1958
+
1959
+ ### HTTP request headers
1960
+
1961
+ - **Content-Type**: Not defined
1962
+ - **Accept**: application/json
1963
+
1964
+
1965
+ ## list_business_agent_connector_tools
1966
+
1967
+ > <ListBusinessAgentConnectorTools200Response> list_business_agent_connector_tools(account_id, connector_id)
1968
+
1969
+ List connector tools
1970
+
1971
+ ### Examples
1972
+
1973
+ ```ruby
1974
+ require 'time'
1975
+ require 'zernio-sdk'
1976
+ # setup authorization
1977
+ Zernio.configure do |config|
1978
+ # Configure Bearer authorization (JWT): bearerAuth
1979
+ config.access_token = 'YOUR_BEARER_TOKEN'
1980
+ end
1981
+
1982
+ api_instance = Zernio::BusinessAgentApi.new
1983
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
1984
+ connector_id = 'connector_id_example' # String |
1985
+
1986
+ begin
1987
+ # List connector tools
1988
+ result = api_instance.list_business_agent_connector_tools(account_id, connector_id)
1989
+ p result
1990
+ rescue Zernio::ApiError => e
1991
+ puts "Error when calling BusinessAgentApi->list_business_agent_connector_tools: #{e}"
1992
+ end
1993
+ ```
1994
+
1995
+ #### Using the list_business_agent_connector_tools_with_http_info variant
1996
+
1997
+ This returns an Array which contains the response data, status code and headers.
1998
+
1999
+ > <Array(<ListBusinessAgentConnectorTools200Response>, Integer, Hash)> list_business_agent_connector_tools_with_http_info(account_id, connector_id)
2000
+
2001
+ ```ruby
2002
+ begin
2003
+ # List connector tools
2004
+ data, status_code, headers = api_instance.list_business_agent_connector_tools_with_http_info(account_id, connector_id)
2005
+ p status_code # => 2xx
2006
+ p headers # => { ... }
2007
+ p data # => <ListBusinessAgentConnectorTools200Response>
2008
+ rescue Zernio::ApiError => e
2009
+ puts "Error when calling BusinessAgentApi->list_business_agent_connector_tools_with_http_info: #{e}"
2010
+ end
2011
+ ```
2012
+
2013
+ ### Parameters
2014
+
2015
+ | Name | Type | Description | Notes |
2016
+ | ---- | ---- | ----------- | ----- |
2017
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2018
+ | **connector_id** | **String** | | |
2019
+
2020
+ ### Return type
2021
+
2022
+ [**ListBusinessAgentConnectorTools200Response**](ListBusinessAgentConnectorTools200Response.md)
2023
+
2024
+ ### Authorization
2025
+
2026
+ [bearerAuth](../README.md#bearerAuth)
2027
+
2028
+ ### HTTP request headers
2029
+
2030
+ - **Content-Type**: Not defined
2031
+ - **Accept**: application/json
2032
+
2033
+
2034
+ ## list_business_agent_connectors
2035
+
2036
+ > <ListBusinessAgentConnectors200Response> list_business_agent_connectors(account_id)
2037
+
2038
+ List connectors
2039
+
2040
+ External APIs the agent may call. `connection_status` says whether Meta can currently reach each one.
2041
+
2042
+ ### Examples
2043
+
2044
+ ```ruby
2045
+ require 'time'
2046
+ require 'zernio-sdk'
2047
+ # setup authorization
2048
+ Zernio.configure do |config|
2049
+ # Configure Bearer authorization (JWT): bearerAuth
2050
+ config.access_token = 'YOUR_BEARER_TOKEN'
2051
+ end
2052
+
2053
+ api_instance = Zernio::BusinessAgentApi.new
2054
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2055
+
2056
+ begin
2057
+ # List connectors
2058
+ result = api_instance.list_business_agent_connectors(account_id)
2059
+ p result
2060
+ rescue Zernio::ApiError => e
2061
+ puts "Error when calling BusinessAgentApi->list_business_agent_connectors: #{e}"
2062
+ end
2063
+ ```
2064
+
2065
+ #### Using the list_business_agent_connectors_with_http_info variant
2066
+
2067
+ This returns an Array which contains the response data, status code and headers.
2068
+
2069
+ > <Array(<ListBusinessAgentConnectors200Response>, Integer, Hash)> list_business_agent_connectors_with_http_info(account_id)
2070
+
2071
+ ```ruby
2072
+ begin
2073
+ # List connectors
2074
+ data, status_code, headers = api_instance.list_business_agent_connectors_with_http_info(account_id)
2075
+ p status_code # => 2xx
2076
+ p headers # => { ... }
2077
+ p data # => <ListBusinessAgentConnectors200Response>
2078
+ rescue Zernio::ApiError => e
2079
+ puts "Error when calling BusinessAgentApi->list_business_agent_connectors_with_http_info: #{e}"
2080
+ end
2081
+ ```
2082
+
2083
+ ### Parameters
2084
+
2085
+ | Name | Type | Description | Notes |
2086
+ | ---- | ---- | ----------- | ----- |
2087
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2088
+
2089
+ ### Return type
2090
+
2091
+ [**ListBusinessAgentConnectors200Response**](ListBusinessAgentConnectors200Response.md)
2092
+
2093
+ ### Authorization
2094
+
2095
+ [bearerAuth](../README.md#bearerAuth)
2096
+
2097
+ ### HTTP request headers
2098
+
2099
+ - **Content-Type**: Not defined
2100
+ - **Accept**: application/json
2101
+
2102
+
2103
+ ## list_business_agent_faqs
2104
+
2105
+ > <ListBusinessAgentFaqs200Response> list_business_agent_faqs(account_id)
2106
+
2107
+ List FAQs
2108
+
2109
+ ### Examples
2110
+
2111
+ ```ruby
2112
+ require 'time'
2113
+ require 'zernio-sdk'
2114
+ # setup authorization
2115
+ Zernio.configure do |config|
2116
+ # Configure Bearer authorization (JWT): bearerAuth
2117
+ config.access_token = 'YOUR_BEARER_TOKEN'
2118
+ end
2119
+
2120
+ api_instance = Zernio::BusinessAgentApi.new
2121
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2122
+
2123
+ begin
2124
+ # List FAQs
2125
+ result = api_instance.list_business_agent_faqs(account_id)
2126
+ p result
2127
+ rescue Zernio::ApiError => e
2128
+ puts "Error when calling BusinessAgentApi->list_business_agent_faqs: #{e}"
2129
+ end
2130
+ ```
2131
+
2132
+ #### Using the list_business_agent_faqs_with_http_info variant
2133
+
2134
+ This returns an Array which contains the response data, status code and headers.
2135
+
2136
+ > <Array(<ListBusinessAgentFaqs200Response>, Integer, Hash)> list_business_agent_faqs_with_http_info(account_id)
2137
+
2138
+ ```ruby
2139
+ begin
2140
+ # List FAQs
2141
+ data, status_code, headers = api_instance.list_business_agent_faqs_with_http_info(account_id)
2142
+ p status_code # => 2xx
2143
+ p headers # => { ... }
2144
+ p data # => <ListBusinessAgentFaqs200Response>
2145
+ rescue Zernio::ApiError => e
2146
+ puts "Error when calling BusinessAgentApi->list_business_agent_faqs_with_http_info: #{e}"
2147
+ end
2148
+ ```
2149
+
2150
+ ### Parameters
2151
+
2152
+ | Name | Type | Description | Notes |
2153
+ | ---- | ---- | ----------- | ----- |
2154
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2155
+
2156
+ ### Return type
2157
+
2158
+ [**ListBusinessAgentFaqs200Response**](ListBusinessAgentFaqs200Response.md)
2159
+
2160
+ ### Authorization
2161
+
2162
+ [bearerAuth](../README.md#bearerAuth)
2163
+
2164
+ ### HTTP request headers
2165
+
2166
+ - **Content-Type**: Not defined
2167
+ - **Accept**: application/json
2168
+
2169
+
2170
+ ## list_business_agent_files
2171
+
2172
+ > <ListBusinessAgentFiles200Response> list_business_agent_files(account_id)
2173
+
2174
+ List knowledge files
2175
+
2176
+ ### Examples
2177
+
2178
+ ```ruby
2179
+ require 'time'
2180
+ require 'zernio-sdk'
2181
+ # setup authorization
2182
+ Zernio.configure do |config|
2183
+ # Configure Bearer authorization (JWT): bearerAuth
2184
+ config.access_token = 'YOUR_BEARER_TOKEN'
2185
+ end
2186
+
2187
+ api_instance = Zernio::BusinessAgentApi.new
2188
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2189
+
2190
+ begin
2191
+ # List knowledge files
2192
+ result = api_instance.list_business_agent_files(account_id)
2193
+ p result
2194
+ rescue Zernio::ApiError => e
2195
+ puts "Error when calling BusinessAgentApi->list_business_agent_files: #{e}"
2196
+ end
2197
+ ```
2198
+
2199
+ #### Using the list_business_agent_files_with_http_info variant
2200
+
2201
+ This returns an Array which contains the response data, status code and headers.
2202
+
2203
+ > <Array(<ListBusinessAgentFiles200Response>, Integer, Hash)> list_business_agent_files_with_http_info(account_id)
2204
+
2205
+ ```ruby
2206
+ begin
2207
+ # List knowledge files
2208
+ data, status_code, headers = api_instance.list_business_agent_files_with_http_info(account_id)
2209
+ p status_code # => 2xx
2210
+ p headers # => { ... }
2211
+ p data # => <ListBusinessAgentFiles200Response>
2212
+ rescue Zernio::ApiError => e
2213
+ puts "Error when calling BusinessAgentApi->list_business_agent_files_with_http_info: #{e}"
2214
+ end
2215
+ ```
2216
+
2217
+ ### Parameters
2218
+
2219
+ | Name | Type | Description | Notes |
2220
+ | ---- | ---- | ----------- | ----- |
2221
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2222
+
2223
+ ### Return type
2224
+
2225
+ [**ListBusinessAgentFiles200Response**](ListBusinessAgentFiles200Response.md)
2226
+
2227
+ ### Authorization
2228
+
2229
+ [bearerAuth](../README.md#bearerAuth)
2230
+
2231
+ ### HTTP request headers
2232
+
2233
+ - **Content-Type**: Not defined
2234
+ - **Accept**: application/json
2235
+
2236
+
2237
+ ## list_business_agent_settings
2238
+
2239
+ > <ListBusinessAgentSettings200Response> list_business_agent_settings(account_id, opts)
2240
+
2241
+ List agent settings
2242
+
2243
+ Settings of every agent configured on the number (normally one). Pass `agentId` to read one.
2244
+
2245
+ ### Examples
2246
+
2247
+ ```ruby
2248
+ require 'time'
2249
+ require 'zernio-sdk'
2250
+ # setup authorization
2251
+ Zernio.configure do |config|
2252
+ # Configure Bearer authorization (JWT): bearerAuth
2253
+ config.access_token = 'YOUR_BEARER_TOKEN'
2254
+ end
2255
+
2256
+ api_instance = Zernio::BusinessAgentApi.new
2257
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2258
+ opts = {
2259
+ agent_id: 'agent_id_example' # String |
2260
+ }
2261
+
2262
+ begin
2263
+ # List agent settings
2264
+ result = api_instance.list_business_agent_settings(account_id, opts)
2265
+ p result
2266
+ rescue Zernio::ApiError => e
2267
+ puts "Error when calling BusinessAgentApi->list_business_agent_settings: #{e}"
2268
+ end
2269
+ ```
2270
+
2271
+ #### Using the list_business_agent_settings_with_http_info variant
2272
+
2273
+ This returns an Array which contains the response data, status code and headers.
2274
+
2275
+ > <Array(<ListBusinessAgentSettings200Response>, Integer, Hash)> list_business_agent_settings_with_http_info(account_id, opts)
2276
+
2277
+ ```ruby
2278
+ begin
2279
+ # List agent settings
2280
+ data, status_code, headers = api_instance.list_business_agent_settings_with_http_info(account_id, opts)
2281
+ p status_code # => 2xx
2282
+ p headers # => { ... }
2283
+ p data # => <ListBusinessAgentSettings200Response>
2284
+ rescue Zernio::ApiError => e
2285
+ puts "Error when calling BusinessAgentApi->list_business_agent_settings_with_http_info: #{e}"
2286
+ end
2287
+ ```
2288
+
2289
+ ### Parameters
2290
+
2291
+ | Name | Type | Description | Notes |
2292
+ | ---- | ---- | ----------- | ----- |
2293
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2294
+ | **agent_id** | **String** | | [optional] |
2295
+
2296
+ ### Return type
2297
+
2298
+ [**ListBusinessAgentSettings200Response**](ListBusinessAgentSettings200Response.md)
2299
+
2300
+ ### Authorization
2301
+
2302
+ [bearerAuth](../README.md#bearerAuth)
2303
+
2304
+ ### HTTP request headers
2305
+
2306
+ - **Content-Type**: Not defined
2307
+ - **Accept**: application/json
2308
+
2309
+
2310
+ ## list_business_agent_skills
2311
+
2312
+ > <ListBusinessAgentSkills200Response> list_business_agent_skills(account_id)
2313
+
2314
+ List skills
2315
+
2316
+ ### Examples
2317
+
2318
+ ```ruby
2319
+ require 'time'
2320
+ require 'zernio-sdk'
2321
+ # setup authorization
2322
+ Zernio.configure do |config|
2323
+ # Configure Bearer authorization (JWT): bearerAuth
2324
+ config.access_token = 'YOUR_BEARER_TOKEN'
2325
+ end
2326
+
2327
+ api_instance = Zernio::BusinessAgentApi.new
2328
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2329
+
2330
+ begin
2331
+ # List skills
2332
+ result = api_instance.list_business_agent_skills(account_id)
2333
+ p result
2334
+ rescue Zernio::ApiError => e
2335
+ puts "Error when calling BusinessAgentApi->list_business_agent_skills: #{e}"
2336
+ end
2337
+ ```
2338
+
2339
+ #### Using the list_business_agent_skills_with_http_info variant
2340
+
2341
+ This returns an Array which contains the response data, status code and headers.
2342
+
2343
+ > <Array(<ListBusinessAgentSkills200Response>, Integer, Hash)> list_business_agent_skills_with_http_info(account_id)
2344
+
2345
+ ```ruby
2346
+ begin
2347
+ # List skills
2348
+ data, status_code, headers = api_instance.list_business_agent_skills_with_http_info(account_id)
2349
+ p status_code # => 2xx
2350
+ p headers # => { ... }
2351
+ p data # => <ListBusinessAgentSkills200Response>
2352
+ rescue Zernio::ApiError => e
2353
+ puts "Error when calling BusinessAgentApi->list_business_agent_skills_with_http_info: #{e}"
2354
+ end
2355
+ ```
2356
+
2357
+ ### Parameters
2358
+
2359
+ | Name | Type | Description | Notes |
2360
+ | ---- | ---- | ----------- | ----- |
2361
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2362
+
2363
+ ### Return type
2364
+
2365
+ [**ListBusinessAgentSkills200Response**](ListBusinessAgentSkills200Response.md)
2366
+
2367
+ ### Authorization
2368
+
2369
+ [bearerAuth](../README.md#bearerAuth)
2370
+
2371
+ ### HTTP request headers
2372
+
2373
+ - **Content-Type**: Not defined
2374
+ - **Accept**: application/json
2375
+
2376
+
2377
+ ## list_business_agent_ui_skills
2378
+
2379
+ > <ListBusinessAgentUiSkills200Response> list_business_agent_ui_skills(account_id, opts)
2380
+
2381
+ List UI skills
2382
+
2383
+ Cursor paged; follow `paging.cursors.after` until `paging.next` is absent.
2384
+
2385
+ ### Examples
2386
+
2387
+ ```ruby
2388
+ require 'time'
2389
+ require 'zernio-sdk'
2390
+ # setup authorization
2391
+ Zernio.configure do |config|
2392
+ # Configure Bearer authorization (JWT): bearerAuth
2393
+ config.access_token = 'YOUR_BEARER_TOKEN'
2394
+ end
2395
+
2396
+ api_instance = Zernio::BusinessAgentApi.new
2397
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2398
+ opts = {
2399
+ before: 'before_example', # String |
2400
+ after: 'after_example', # String |
2401
+ limit: 56 # Integer |
2402
+ }
2403
+
2404
+ begin
2405
+ # List UI skills
2406
+ result = api_instance.list_business_agent_ui_skills(account_id, opts)
2407
+ p result
2408
+ rescue Zernio::ApiError => e
2409
+ puts "Error when calling BusinessAgentApi->list_business_agent_ui_skills: #{e}"
2410
+ end
2411
+ ```
2412
+
2413
+ #### Using the list_business_agent_ui_skills_with_http_info variant
2414
+
2415
+ This returns an Array which contains the response data, status code and headers.
2416
+
2417
+ > <Array(<ListBusinessAgentUiSkills200Response>, Integer, Hash)> list_business_agent_ui_skills_with_http_info(account_id, opts)
2418
+
2419
+ ```ruby
2420
+ begin
2421
+ # List UI skills
2422
+ data, status_code, headers = api_instance.list_business_agent_ui_skills_with_http_info(account_id, opts)
2423
+ p status_code # => 2xx
2424
+ p headers # => { ... }
2425
+ p data # => <ListBusinessAgentUiSkills200Response>
2426
+ rescue Zernio::ApiError => e
2427
+ puts "Error when calling BusinessAgentApi->list_business_agent_ui_skills_with_http_info: #{e}"
2428
+ end
2429
+ ```
2430
+
2431
+ ### Parameters
2432
+
2433
+ | Name | Type | Description | Notes |
2434
+ | ---- | ---- | ----------- | ----- |
2435
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2436
+ | **before** | **String** | | [optional] |
2437
+ | **after** | **String** | | [optional] |
2438
+ | **limit** | **Integer** | | [optional] |
2439
+
2440
+ ### Return type
2441
+
2442
+ [**ListBusinessAgentUiSkills200Response**](ListBusinessAgentUiSkills200Response.md)
2443
+
2444
+ ### Authorization
2445
+
2446
+ [bearerAuth](../README.md#bearerAuth)
2447
+
2448
+ ### HTTP request headers
2449
+
2450
+ - **Content-Type**: Not defined
2451
+ - **Accept**: application/json
2452
+
2453
+
2454
+ ## list_business_agent_websites
2455
+
2456
+ > <ListBusinessAgentWebsites200Response> list_business_agent_websites(account_id)
2457
+
2458
+ List crawled websites
2459
+
2460
+ ### Examples
2461
+
2462
+ ```ruby
2463
+ require 'time'
2464
+ require 'zernio-sdk'
2465
+ # setup authorization
2466
+ Zernio.configure do |config|
2467
+ # Configure Bearer authorization (JWT): bearerAuth
2468
+ config.access_token = 'YOUR_BEARER_TOKEN'
2469
+ end
2470
+
2471
+ api_instance = Zernio::BusinessAgentApi.new
2472
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2473
+
2474
+ begin
2475
+ # List crawled websites
2476
+ result = api_instance.list_business_agent_websites(account_id)
2477
+ p result
2478
+ rescue Zernio::ApiError => e
2479
+ puts "Error when calling BusinessAgentApi->list_business_agent_websites: #{e}"
2480
+ end
2481
+ ```
2482
+
2483
+ #### Using the list_business_agent_websites_with_http_info variant
2484
+
2485
+ This returns an Array which contains the response data, status code and headers.
2486
+
2487
+ > <Array(<ListBusinessAgentWebsites200Response>, Integer, Hash)> list_business_agent_websites_with_http_info(account_id)
2488
+
2489
+ ```ruby
2490
+ begin
2491
+ # List crawled websites
2492
+ data, status_code, headers = api_instance.list_business_agent_websites_with_http_info(account_id)
2493
+ p status_code # => 2xx
2494
+ p headers # => { ... }
2495
+ p data # => <ListBusinessAgentWebsites200Response>
2496
+ rescue Zernio::ApiError => e
2497
+ puts "Error when calling BusinessAgentApi->list_business_agent_websites_with_http_info: #{e}"
2498
+ end
2499
+ ```
2500
+
2501
+ ### Parameters
2502
+
2503
+ | Name | Type | Description | Notes |
2504
+ | ---- | ---- | ----------- | ----- |
2505
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2506
+
2507
+ ### Return type
2508
+
2509
+ [**ListBusinessAgentWebsites200Response**](ListBusinessAgentWebsites200Response.md)
2510
+
2511
+ ### Authorization
2512
+
2513
+ [bearerAuth](../README.md#bearerAuth)
2514
+
2515
+ ### HTTP request headers
2516
+
2517
+ - **Content-Type**: Not defined
2518
+ - **Accept**: application/json
2519
+
2520
+
2521
+ ## onboard_business_agent
2522
+
2523
+ > <OnboardBusinessAgent201Response> onboard_business_agent(account_id)
2524
+
2525
+ Create the agent
2526
+
2527
+ 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.
2528
+
2529
+ ### Examples
2530
+
2531
+ ```ruby
2532
+ require 'time'
2533
+ require 'zernio-sdk'
2534
+ # setup authorization
2535
+ Zernio.configure do |config|
2536
+ # Configure Bearer authorization (JWT): bearerAuth
2537
+ config.access_token = 'YOUR_BEARER_TOKEN'
2538
+ end
2539
+
2540
+ api_instance = Zernio::BusinessAgentApi.new
2541
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2542
+
2543
+ begin
2544
+ # Create the agent
2545
+ result = api_instance.onboard_business_agent(account_id)
2546
+ p result
2547
+ rescue Zernio::ApiError => e
2548
+ puts "Error when calling BusinessAgentApi->onboard_business_agent: #{e}"
2549
+ end
2550
+ ```
2551
+
2552
+ #### Using the onboard_business_agent_with_http_info variant
2553
+
2554
+ This returns an Array which contains the response data, status code and headers.
2555
+
2556
+ > <Array(<OnboardBusinessAgent201Response>, Integer, Hash)> onboard_business_agent_with_http_info(account_id)
2557
+
2558
+ ```ruby
2559
+ begin
2560
+ # Create the agent
2561
+ data, status_code, headers = api_instance.onboard_business_agent_with_http_info(account_id)
2562
+ p status_code # => 2xx
2563
+ p headers # => { ... }
2564
+ p data # => <OnboardBusinessAgent201Response>
2565
+ rescue Zernio::ApiError => e
2566
+ puts "Error when calling BusinessAgentApi->onboard_business_agent_with_http_info: #{e}"
2567
+ end
2568
+ ```
2569
+
2570
+ ### Parameters
2571
+
2572
+ | Name | Type | Description | Notes |
2573
+ | ---- | ---- | ----------- | ----- |
2574
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2575
+
2576
+ ### Return type
2577
+
2578
+ [**OnboardBusinessAgent201Response**](OnboardBusinessAgent201Response.md)
2579
+
2580
+ ### Authorization
2581
+
2582
+ [bearerAuth](../README.md#bearerAuth)
2583
+
2584
+ ### HTTP request headers
2585
+
2586
+ - **Content-Type**: Not defined
2587
+ - **Accept**: application/json
2588
+
2589
+
2590
+ ## read_business_agent_evals
2591
+
2592
+ > Hash&lt;String, Object&gt; read_business_agent_evals(account_id, opts)
2593
+
2594
+ Read evaluation data
2595
+
2596
+ 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.
2597
+
2598
+ ### Examples
2599
+
2600
+ ```ruby
2601
+ require 'time'
2602
+ require 'zernio-sdk'
2603
+ # setup authorization
2604
+ Zernio.configure do |config|
2605
+ # Configure Bearer authorization (JWT): bearerAuth
2606
+ config.access_token = 'YOUR_BEARER_TOKEN'
2607
+ end
2608
+
2609
+ api_instance = Zernio::BusinessAgentApi.new
2610
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2611
+ opts = {
2612
+ job_id: 'job_id_example', # String |
2613
+ summary_ids: 'summary_ids_example', # String | Comma-separated summary ids.
2614
+ eval_ids: 'eval_ids_example' # String | Comma-separated evaluation ids.
2615
+ }
2616
+
2617
+ begin
2618
+ # Read evaluation data
2619
+ result = api_instance.read_business_agent_evals(account_id, opts)
2620
+ p result
2621
+ rescue Zernio::ApiError => e
2622
+ puts "Error when calling BusinessAgentApi->read_business_agent_evals: #{e}"
2623
+ end
2624
+ ```
2625
+
2626
+ #### Using the read_business_agent_evals_with_http_info variant
2627
+
2628
+ This returns an Array which contains the response data, status code and headers.
2629
+
2630
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> read_business_agent_evals_with_http_info(account_id, opts)
2631
+
2632
+ ```ruby
2633
+ begin
2634
+ # Read evaluation data
2635
+ data, status_code, headers = api_instance.read_business_agent_evals_with_http_info(account_id, opts)
2636
+ p status_code # => 2xx
2637
+ p headers # => { ... }
2638
+ p data # => Hash&lt;String, Object&gt;
2639
+ rescue Zernio::ApiError => e
2640
+ puts "Error when calling BusinessAgentApi->read_business_agent_evals_with_http_info: #{e}"
2641
+ end
2642
+ ```
2643
+
2644
+ ### Parameters
2645
+
2646
+ | Name | Type | Description | Notes |
2647
+ | ---- | ---- | ----------- | ----- |
2648
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2649
+ | **job_id** | **String** | | [optional] |
2650
+ | **summary_ids** | **String** | Comma-separated summary ids. | [optional] |
2651
+ | **eval_ids** | **String** | Comma-separated evaluation ids. | [optional] |
2652
+
2653
+ ### Return type
2654
+
2655
+ **Hash&lt;String, Object&gt;**
2656
+
2657
+ ### Authorization
2658
+
2659
+ [bearerAuth](../README.md#bearerAuth)
2660
+
2661
+ ### HTTP request headers
2662
+
2663
+ - **Content-Type**: Not defined
2664
+ - **Accept**: application/json
2665
+
2666
+
2667
+ ## refresh_business_agent_connector_tools
2668
+
2669
+ > <BusinessAgentConnector> refresh_business_agent_connector_tools(account_id, connector_id)
2670
+
2671
+ Refresh MCP connector tools
2672
+
2673
+ 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.
2674
+
2675
+ ### Examples
2676
+
2677
+ ```ruby
2678
+ require 'time'
2679
+ require 'zernio-sdk'
2680
+ # setup authorization
2681
+ Zernio.configure do |config|
2682
+ # Configure Bearer authorization (JWT): bearerAuth
2683
+ config.access_token = 'YOUR_BEARER_TOKEN'
2684
+ end
2685
+
2686
+ api_instance = Zernio::BusinessAgentApi.new
2687
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2688
+ connector_id = 'connector_id_example' # String |
2689
+
2690
+ begin
2691
+ # Refresh MCP connector tools
2692
+ result = api_instance.refresh_business_agent_connector_tools(account_id, connector_id)
2693
+ p result
2694
+ rescue Zernio::ApiError => e
2695
+ puts "Error when calling BusinessAgentApi->refresh_business_agent_connector_tools: #{e}"
2696
+ end
2697
+ ```
2698
+
2699
+ #### Using the refresh_business_agent_connector_tools_with_http_info variant
2700
+
2701
+ This returns an Array which contains the response data, status code and headers.
2702
+
2703
+ > <Array(<BusinessAgentConnector>, Integer, Hash)> refresh_business_agent_connector_tools_with_http_info(account_id, connector_id)
2704
+
2705
+ ```ruby
2706
+ begin
2707
+ # Refresh MCP connector tools
2708
+ data, status_code, headers = api_instance.refresh_business_agent_connector_tools_with_http_info(account_id, connector_id)
2709
+ p status_code # => 2xx
2710
+ p headers # => { ... }
2711
+ p data # => <BusinessAgentConnector>
2712
+ rescue Zernio::ApiError => e
2713
+ puts "Error when calling BusinessAgentApi->refresh_business_agent_connector_tools_with_http_info: #{e}"
2714
+ end
2715
+ ```
2716
+
2717
+ ### Parameters
2718
+
2719
+ | Name | Type | Description | Notes |
2720
+ | ---- | ---- | ----------- | ----- |
2721
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2722
+ | **connector_id** | **String** | | |
2723
+
2724
+ ### Return type
2725
+
2726
+ [**BusinessAgentConnector**](BusinessAgentConnector.md)
2727
+
2728
+ ### Authorization
2729
+
2730
+ [bearerAuth](../README.md#bearerAuth)
2731
+
2732
+ ### HTTP request headers
2733
+
2734
+ - **Content-Type**: Not defined
2735
+ - **Accept**: application/json
2736
+
2737
+
2738
+ ## remove_business_agent_allowlist_entry
2739
+
2740
+ > <InlineObject> remove_business_agent_allowlist_entry(account_id, entry_id)
2741
+
2742
+ Remove an allowlisted consumer
2743
+
2744
+ ### Examples
2745
+
2746
+ ```ruby
2747
+ require 'time'
2748
+ require 'zernio-sdk'
2749
+ # setup authorization
2750
+ Zernio.configure do |config|
2751
+ # Configure Bearer authorization (JWT): bearerAuth
2752
+ config.access_token = 'YOUR_BEARER_TOKEN'
2753
+ end
2754
+
2755
+ api_instance = Zernio::BusinessAgentApi.new
2756
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2757
+ entry_id = 'entry_id_example' # String |
2758
+
2759
+ begin
2760
+ # Remove an allowlisted consumer
2761
+ result = api_instance.remove_business_agent_allowlist_entry(account_id, entry_id)
2762
+ p result
2763
+ rescue Zernio::ApiError => e
2764
+ puts "Error when calling BusinessAgentApi->remove_business_agent_allowlist_entry: #{e}"
2765
+ end
2766
+ ```
2767
+
2768
+ #### Using the remove_business_agent_allowlist_entry_with_http_info variant
2769
+
2770
+ This returns an Array which contains the response data, status code and headers.
2771
+
2772
+ > <Array(<InlineObject>, Integer, Hash)> remove_business_agent_allowlist_entry_with_http_info(account_id, entry_id)
2773
+
2774
+ ```ruby
2775
+ begin
2776
+ # Remove an allowlisted consumer
2777
+ data, status_code, headers = api_instance.remove_business_agent_allowlist_entry_with_http_info(account_id, entry_id)
2778
+ p status_code # => 2xx
2779
+ p headers # => { ... }
2780
+ p data # => <InlineObject>
2781
+ rescue Zernio::ApiError => e
2782
+ puts "Error when calling BusinessAgentApi->remove_business_agent_allowlist_entry_with_http_info: #{e}"
2783
+ end
2784
+ ```
2785
+
2786
+ ### Parameters
2787
+
2788
+ | Name | Type | Description | Notes |
2789
+ | ---- | ---- | ----------- | ----- |
2790
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2791
+ | **entry_id** | **String** | | |
2792
+
2793
+ ### Return type
2794
+
2795
+ [**InlineObject**](InlineObject.md)
2796
+
2797
+ ### Authorization
2798
+
2799
+ [bearerAuth](../README.md#bearerAuth)
2800
+
2801
+ ### HTTP request headers
2802
+
2803
+ - **Content-Type**: Not defined
2804
+ - **Accept**: application/json
2805
+
2806
+
2807
+ ## replace_business_agent_budget
2808
+
2809
+ > <GetBusinessAgentBudget200Response> replace_business_agent_budget(account_id, get_business_agent_budget200_response)
2810
+
2811
+ Replace usage budgets
2812
+
2813
+ 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.
2814
+
2815
+ ### Examples
2816
+
2817
+ ```ruby
2818
+ require 'time'
2819
+ require 'zernio-sdk'
2820
+ # setup authorization
2821
+ Zernio.configure do |config|
2822
+ # Configure Bearer authorization (JWT): bearerAuth
2823
+ config.access_token = 'YOUR_BEARER_TOKEN'
2824
+ end
2825
+
2826
+ api_instance = Zernio::BusinessAgentApi.new
2827
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2828
+ get_business_agent_budget200_response = Zernio::GetBusinessAgentBudget200Response.new({budgets: [Zernio::BusinessAgentBudget.new({unit_type: 'token', time_window: 'one_day', max_budget: 37})]}) # GetBusinessAgentBudget200Response |
2829
+
2830
+ begin
2831
+ # Replace usage budgets
2832
+ result = api_instance.replace_business_agent_budget(account_id, get_business_agent_budget200_response)
2833
+ p result
2834
+ rescue Zernio::ApiError => e
2835
+ puts "Error when calling BusinessAgentApi->replace_business_agent_budget: #{e}"
2836
+ end
2837
+ ```
2838
+
2839
+ #### Using the replace_business_agent_budget_with_http_info variant
2840
+
2841
+ This returns an Array which contains the response data, status code and headers.
2842
+
2843
+ > <Array(<GetBusinessAgentBudget200Response>, Integer, Hash)> replace_business_agent_budget_with_http_info(account_id, get_business_agent_budget200_response)
2844
+
2845
+ ```ruby
2846
+ begin
2847
+ # Replace usage budgets
2848
+ data, status_code, headers = api_instance.replace_business_agent_budget_with_http_info(account_id, get_business_agent_budget200_response)
2849
+ p status_code # => 2xx
2850
+ p headers # => { ... }
2851
+ p data # => <GetBusinessAgentBudget200Response>
2852
+ rescue Zernio::ApiError => e
2853
+ puts "Error when calling BusinessAgentApi->replace_business_agent_budget_with_http_info: #{e}"
2854
+ end
2855
+ ```
2856
+
2857
+ ### Parameters
2858
+
2859
+ | Name | Type | Description | Notes |
2860
+ | ---- | ---- | ----------- | ----- |
2861
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2862
+ | **get_business_agent_budget200_response** | [**GetBusinessAgentBudget200Response**](GetBusinessAgentBudget200Response.md) | | |
2863
+
2864
+ ### Return type
2865
+
2866
+ [**GetBusinessAgentBudget200Response**](GetBusinessAgentBudget200Response.md)
2867
+
2868
+ ### Authorization
2869
+
2870
+ [bearerAuth](../README.md#bearerAuth)
2871
+
2872
+ ### HTTP request headers
2873
+
2874
+ - **Content-Type**: application/json
2875
+ - **Accept**: application/json
2876
+
2877
+
2878
+ ## replace_business_agent_business_information
2879
+
2880
+ > <BusinessAgentBusinessInformation> replace_business_agent_business_information(account_id, business_agent_business_information)
2881
+
2882
+ Replace business information
2883
+
2884
+ Full replacement: every field you send overwrites the stored value; fields you omit are cleared.
2885
+
2886
+ ### Examples
2887
+
2888
+ ```ruby
2889
+ require 'time'
2890
+ require 'zernio-sdk'
2891
+ # setup authorization
2892
+ Zernio.configure do |config|
2893
+ # Configure Bearer authorization (JWT): bearerAuth
2894
+ config.access_token = 'YOUR_BEARER_TOKEN'
2895
+ end
2896
+
2897
+ api_instance = Zernio::BusinessAgentApi.new
2898
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2899
+ business_agent_business_information = Zernio::BusinessAgentBusinessInformation.new # BusinessAgentBusinessInformation |
2900
+
2901
+ begin
2902
+ # Replace business information
2903
+ result = api_instance.replace_business_agent_business_information(account_id, business_agent_business_information)
2904
+ p result
2905
+ rescue Zernio::ApiError => e
2906
+ puts "Error when calling BusinessAgentApi->replace_business_agent_business_information: #{e}"
2907
+ end
2908
+ ```
2909
+
2910
+ #### Using the replace_business_agent_business_information_with_http_info variant
2911
+
2912
+ This returns an Array which contains the response data, status code and headers.
2913
+
2914
+ > <Array(<BusinessAgentBusinessInformation>, Integer, Hash)> replace_business_agent_business_information_with_http_info(account_id, business_agent_business_information)
2915
+
2916
+ ```ruby
2917
+ begin
2918
+ # Replace business information
2919
+ data, status_code, headers = api_instance.replace_business_agent_business_information_with_http_info(account_id, business_agent_business_information)
2920
+ p status_code # => 2xx
2921
+ p headers # => { ... }
2922
+ p data # => <BusinessAgentBusinessInformation>
2923
+ rescue Zernio::ApiError => e
2924
+ puts "Error when calling BusinessAgentApi->replace_business_agent_business_information_with_http_info: #{e}"
2925
+ end
2926
+ ```
2927
+
2928
+ ### Parameters
2929
+
2930
+ | Name | Type | Description | Notes |
2931
+ | ---- | ---- | ----------- | ----- |
2932
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
2933
+ | **business_agent_business_information** | [**BusinessAgentBusinessInformation**](BusinessAgentBusinessInformation.md) | | |
2934
+
2935
+ ### Return type
2936
+
2937
+ [**BusinessAgentBusinessInformation**](BusinessAgentBusinessInformation.md)
2938
+
2939
+ ### Authorization
2940
+
2941
+ [bearerAuth](../README.md#bearerAuth)
2942
+
2943
+ ### HTTP request headers
2944
+
2945
+ - **Content-Type**: application/json
2946
+ - **Accept**: application/json
2947
+
2948
+
2949
+ ## reset_business_agent_business_information
2950
+
2951
+ > <InlineObject> reset_business_agent_business_information(account_id)
2952
+
2953
+ Reset business information
2954
+
2955
+ ### Examples
2956
+
2957
+ ```ruby
2958
+ require 'time'
2959
+ require 'zernio-sdk'
2960
+ # setup authorization
2961
+ Zernio.configure do |config|
2962
+ # Configure Bearer authorization (JWT): bearerAuth
2963
+ config.access_token = 'YOUR_BEARER_TOKEN'
2964
+ end
2965
+
2966
+ api_instance = Zernio::BusinessAgentApi.new
2967
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
2968
+
2969
+ begin
2970
+ # Reset business information
2971
+ result = api_instance.reset_business_agent_business_information(account_id)
2972
+ p result
2973
+ rescue Zernio::ApiError => e
2974
+ puts "Error when calling BusinessAgentApi->reset_business_agent_business_information: #{e}"
2975
+ end
2976
+ ```
2977
+
2978
+ #### Using the reset_business_agent_business_information_with_http_info variant
2979
+
2980
+ This returns an Array which contains the response data, status code and headers.
2981
+
2982
+ > <Array(<InlineObject>, Integer, Hash)> reset_business_agent_business_information_with_http_info(account_id)
2983
+
2984
+ ```ruby
2985
+ begin
2986
+ # Reset business information
2987
+ data, status_code, headers = api_instance.reset_business_agent_business_information_with_http_info(account_id)
2988
+ p status_code # => 2xx
2989
+ p headers # => { ... }
2990
+ p data # => <InlineObject>
2991
+ rescue Zernio::ApiError => e
2992
+ puts "Error when calling BusinessAgentApi->reset_business_agent_business_information_with_http_info: #{e}"
2993
+ end
2994
+ ```
2995
+
2996
+ ### Parameters
2997
+
2998
+ | Name | Type | Description | Notes |
2999
+ | ---- | ---- | ----------- | ----- |
3000
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3001
+
3002
+ ### Return type
3003
+
3004
+ [**InlineObject**](InlineObject.md)
3005
+
3006
+ ### Authorization
3007
+
3008
+ [bearerAuth](../README.md#bearerAuth)
3009
+
3010
+ ### HTTP request headers
3011
+
3012
+ - **Content-Type**: Not defined
3013
+ - **Accept**: application/json
3014
+
3015
+
3016
+ ## run_business_agent_connector_tool
3017
+
3018
+ > <RunBusinessAgentConnectorTool200Response> run_business_agent_connector_tool(account_id, connector_id, tool_id, run_business_agent_connector_tool_request)
3019
+
3020
+ Run a connector tool once
3021
+
3022
+ Executes the tool against the merchant API and returns the raw upstream result, to check a connector before the agent relies on it.
3023
+
3024
+ ### Examples
3025
+
3026
+ ```ruby
3027
+ require 'time'
3028
+ require 'zernio-sdk'
3029
+ # setup authorization
3030
+ Zernio.configure do |config|
3031
+ # Configure Bearer authorization (JWT): bearerAuth
3032
+ config.access_token = 'YOUR_BEARER_TOKEN'
3033
+ end
3034
+
3035
+ api_instance = Zernio::BusinessAgentApi.new
3036
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3037
+ connector_id = 'connector_id_example' # String |
3038
+ tool_id = 'tool_id_example' # String |
3039
+ run_business_agent_connector_tool_request = Zernio::RunBusinessAgentConnectorToolRequest.new({input: 'input_example'}) # RunBusinessAgentConnectorToolRequest |
3040
+
3041
+ begin
3042
+ # Run a connector tool once
3043
+ result = api_instance.run_business_agent_connector_tool(account_id, connector_id, tool_id, run_business_agent_connector_tool_request)
3044
+ p result
3045
+ rescue Zernio::ApiError => e
3046
+ puts "Error when calling BusinessAgentApi->run_business_agent_connector_tool: #{e}"
3047
+ end
3048
+ ```
3049
+
3050
+ #### Using the run_business_agent_connector_tool_with_http_info variant
3051
+
3052
+ This returns an Array which contains the response data, status code and headers.
3053
+
3054
+ > <Array(<RunBusinessAgentConnectorTool200Response>, Integer, Hash)> run_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, run_business_agent_connector_tool_request)
3055
+
3056
+ ```ruby
3057
+ begin
3058
+ # Run a connector tool once
3059
+ data, status_code, headers = api_instance.run_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, run_business_agent_connector_tool_request)
3060
+ p status_code # => 2xx
3061
+ p headers # => { ... }
3062
+ p data # => <RunBusinessAgentConnectorTool200Response>
3063
+ rescue Zernio::ApiError => e
3064
+ puts "Error when calling BusinessAgentApi->run_business_agent_connector_tool_with_http_info: #{e}"
3065
+ end
3066
+ ```
3067
+
3068
+ ### Parameters
3069
+
3070
+ | Name | Type | Description | Notes |
3071
+ | ---- | ---- | ----------- | ----- |
3072
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3073
+ | **connector_id** | **String** | | |
3074
+ | **tool_id** | **String** | | |
3075
+ | **run_business_agent_connector_tool_request** | [**RunBusinessAgentConnectorToolRequest**](RunBusinessAgentConnectorToolRequest.md) | | |
3076
+
3077
+ ### Return type
3078
+
3079
+ [**RunBusinessAgentConnectorTool200Response**](RunBusinessAgentConnectorTool200Response.md)
3080
+
3081
+ ### Authorization
3082
+
3083
+ [bearerAuth](../README.md#bearerAuth)
3084
+
3085
+ ### HTTP request headers
3086
+
3087
+ - **Content-Type**: application/json
3088
+ - **Accept**: application/json
3089
+
3090
+
3091
+ ## send_business_agent_event
3092
+
3093
+ > <SendBusinessAgentEvent202Response> send_business_agent_event(account_id, send_business_agent_event_request)
3094
+
3095
+ Send a business event
3096
+
3097
+ 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.
3098
+
3099
+ ### Examples
3100
+
3101
+ ```ruby
3102
+ require 'time'
3103
+ require 'zernio-sdk'
3104
+ # setup authorization
3105
+ Zernio.configure do |config|
3106
+ # Configure Bearer authorization (JWT): bearerAuth
3107
+ config.access_token = 'YOUR_BEARER_TOKEN'
3108
+ end
3109
+
3110
+ api_instance = Zernio::BusinessAgentApi.new
3111
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3112
+ send_business_agent_event_request = Zernio::SendBusinessAgentEventRequest.new({to: '+34600000000', type: 'order_shipped', description: 'description_example', payload: 'payload_example'}) # SendBusinessAgentEventRequest |
3113
+
3114
+ begin
3115
+ # Send a business event
3116
+ result = api_instance.send_business_agent_event(account_id, send_business_agent_event_request)
3117
+ p result
3118
+ rescue Zernio::ApiError => e
3119
+ puts "Error when calling BusinessAgentApi->send_business_agent_event: #{e}"
3120
+ end
3121
+ ```
3122
+
3123
+ #### Using the send_business_agent_event_with_http_info variant
3124
+
3125
+ This returns an Array which contains the response data, status code and headers.
3126
+
3127
+ > <Array(<SendBusinessAgentEvent202Response>, Integer, Hash)> send_business_agent_event_with_http_info(account_id, send_business_agent_event_request)
3128
+
3129
+ ```ruby
3130
+ begin
3131
+ # Send a business event
3132
+ data, status_code, headers = api_instance.send_business_agent_event_with_http_info(account_id, send_business_agent_event_request)
3133
+ p status_code # => 2xx
3134
+ p headers # => { ... }
3135
+ p data # => <SendBusinessAgentEvent202Response>
3136
+ rescue Zernio::ApiError => e
3137
+ puts "Error when calling BusinessAgentApi->send_business_agent_event_with_http_info: #{e}"
3138
+ end
3139
+ ```
3140
+
3141
+ ### Parameters
3142
+
3143
+ | Name | Type | Description | Notes |
3144
+ | ---- | ---- | ----------- | ----- |
3145
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3146
+ | **send_business_agent_event_request** | [**SendBusinessAgentEventRequest**](SendBusinessAgentEventRequest.md) | | |
3147
+
3148
+ ### Return type
3149
+
3150
+ [**SendBusinessAgentEvent202Response**](SendBusinessAgentEvent202Response.md)
3151
+
3152
+ ### Authorization
3153
+
3154
+ [bearerAuth](../README.md#bearerAuth)
3155
+
3156
+ ### HTTP request headers
3157
+
3158
+ - **Content-Type**: application/json
3159
+ - **Accept**: application/json
3160
+
3161
+
3162
+ ## send_business_agent_test_message
3163
+
3164
+ > <BusinessAgentTestMessageResponse> send_business_agent_test_message(account_id, send_business_agent_test_message_request)
3165
+
3166
+ Send a test message
3167
+
3168
+ 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.
3169
+
3170
+ ### Examples
3171
+
3172
+ ```ruby
3173
+ require 'time'
3174
+ require 'zernio-sdk'
3175
+ # setup authorization
3176
+ Zernio.configure do |config|
3177
+ # Configure Bearer authorization (JWT): bearerAuth
3178
+ config.access_token = 'YOUR_BEARER_TOKEN'
3179
+ end
3180
+
3181
+ api_instance = Zernio::BusinessAgentApi.new
3182
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3183
+ send_business_agent_test_message_request = Zernio::SendBusinessAgentTestMessageRequest.new({message: 'message_example'}) # SendBusinessAgentTestMessageRequest |
3184
+
3185
+ begin
3186
+ # Send a test message
3187
+ result = api_instance.send_business_agent_test_message(account_id, send_business_agent_test_message_request)
3188
+ p result
3189
+ rescue Zernio::ApiError => e
3190
+ puts "Error when calling BusinessAgentApi->send_business_agent_test_message: #{e}"
3191
+ end
3192
+ ```
3193
+
3194
+ #### Using the send_business_agent_test_message_with_http_info variant
3195
+
3196
+ This returns an Array which contains the response data, status code and headers.
3197
+
3198
+ > <Array(<BusinessAgentTestMessageResponse>, Integer, Hash)> send_business_agent_test_message_with_http_info(account_id, send_business_agent_test_message_request)
3199
+
3200
+ ```ruby
3201
+ begin
3202
+ # Send a test message
3203
+ data, status_code, headers = api_instance.send_business_agent_test_message_with_http_info(account_id, send_business_agent_test_message_request)
3204
+ p status_code # => 2xx
3205
+ p headers # => { ... }
3206
+ p data # => <BusinessAgentTestMessageResponse>
3207
+ rescue Zernio::ApiError => e
3208
+ puts "Error when calling BusinessAgentApi->send_business_agent_test_message_with_http_info: #{e}"
3209
+ end
3210
+ ```
3211
+
3212
+ ### Parameters
3213
+
3214
+ | Name | Type | Description | Notes |
3215
+ | ---- | ---- | ----------- | ----- |
3216
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3217
+ | **send_business_agent_test_message_request** | [**SendBusinessAgentTestMessageRequest**](SendBusinessAgentTestMessageRequest.md) | | |
3218
+
3219
+ ### Return type
3220
+
3221
+ [**BusinessAgentTestMessageResponse**](BusinessAgentTestMessageResponse.md)
3222
+
3223
+ ### Authorization
3224
+
3225
+ [bearerAuth](../README.md#bearerAuth)
3226
+
3227
+ ### HTTP request headers
3228
+
3229
+ - **Content-Type**: application/json
3230
+ - **Accept**: application/json
3231
+
3232
+
3233
+ ## set_business_agent_connector_credentials
3234
+
3235
+ > <BusinessAgentConnector> set_business_agent_connector_credentials(account_id, connector_id, set_business_agent_connector_credentials_request)
3236
+
3237
+ Set connector credentials
3238
+
3239
+ 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.
3240
+
3241
+ ### Examples
3242
+
3243
+ ```ruby
3244
+ require 'time'
3245
+ require 'zernio-sdk'
3246
+ # setup authorization
3247
+ Zernio.configure do |config|
3248
+ # Configure Bearer authorization (JWT): bearerAuth
3249
+ config.access_token = 'YOUR_BEARER_TOKEN'
3250
+ end
3251
+
3252
+ api_instance = Zernio::BusinessAgentApi.new
3253
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3254
+ connector_id = 'connector_id_example' # String |
3255
+ set_business_agent_connector_credentials_request = Zernio::SetBusinessAgentConnectorCredentialsRequestOneOf.new({kind: 'api_key', api_key_config: Zernio::BusinessAgentApiKeyConfig.new}) # SetBusinessAgentConnectorCredentialsRequest |
3256
+
3257
+ begin
3258
+ # Set connector credentials
3259
+ result = api_instance.set_business_agent_connector_credentials(account_id, connector_id, set_business_agent_connector_credentials_request)
3260
+ p result
3261
+ rescue Zernio::ApiError => e
3262
+ puts "Error when calling BusinessAgentApi->set_business_agent_connector_credentials: #{e}"
3263
+ end
3264
+ ```
3265
+
3266
+ #### Using the set_business_agent_connector_credentials_with_http_info variant
3267
+
3268
+ This returns an Array which contains the response data, status code and headers.
3269
+
3270
+ > <Array(<BusinessAgentConnector>, Integer, Hash)> set_business_agent_connector_credentials_with_http_info(account_id, connector_id, set_business_agent_connector_credentials_request)
3271
+
3272
+ ```ruby
3273
+ begin
3274
+ # Set connector credentials
3275
+ data, status_code, headers = api_instance.set_business_agent_connector_credentials_with_http_info(account_id, connector_id, set_business_agent_connector_credentials_request)
3276
+ p status_code # => 2xx
3277
+ p headers # => { ... }
3278
+ p data # => <BusinessAgentConnector>
3279
+ rescue Zernio::ApiError => e
3280
+ puts "Error when calling BusinessAgentApi->set_business_agent_connector_credentials_with_http_info: #{e}"
3281
+ end
3282
+ ```
3283
+
3284
+ ### Parameters
3285
+
3286
+ | Name | Type | Description | Notes |
3287
+ | ---- | ---- | ----------- | ----- |
3288
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3289
+ | **connector_id** | **String** | | |
3290
+ | **set_business_agent_connector_credentials_request** | [**SetBusinessAgentConnectorCredentialsRequest**](SetBusinessAgentConnectorCredentialsRequest.md) | | |
3291
+
3292
+ ### Return type
3293
+
3294
+ [**BusinessAgentConnector**](BusinessAgentConnector.md)
3295
+
3296
+ ### Authorization
3297
+
3298
+ [bearerAuth](../README.md#bearerAuth)
3299
+
3300
+ ### HTTP request headers
3301
+
3302
+ - **Content-Type**: application/json
3303
+ - **Accept**: application/json
3304
+
3305
+
3306
+ ## start_business_agent_eval_run
3307
+
3308
+ > <StartBusinessAgentEvalRun202Response> start_business_agent_eval_run(account_id, start_business_agent_eval_run_request)
3309
+
3310
+ Start an evaluation run
3311
+
3312
+ Simulates the given scenarios against the agent and scores them. Answers 202 with a `job_id` to poll with GET.
3313
+
3314
+ ### Examples
3315
+
3316
+ ```ruby
3317
+ require 'time'
3318
+ require 'zernio-sdk'
3319
+ # setup authorization
3320
+ Zernio.configure do |config|
3321
+ # Configure Bearer authorization (JWT): bearerAuth
3322
+ config.access_token = 'YOUR_BEARER_TOKEN'
3323
+ end
3324
+
3325
+ api_instance = Zernio::BusinessAgentApi.new
3326
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3327
+ start_business_agent_eval_run_request = Zernio::StartBusinessAgentEvalRunRequest.new({eval_case_ids: ['eval_case_ids_example']}) # StartBusinessAgentEvalRunRequest |
3328
+
3329
+ begin
3330
+ # Start an evaluation run
3331
+ result = api_instance.start_business_agent_eval_run(account_id, start_business_agent_eval_run_request)
3332
+ p result
3333
+ rescue Zernio::ApiError => e
3334
+ puts "Error when calling BusinessAgentApi->start_business_agent_eval_run: #{e}"
3335
+ end
3336
+ ```
3337
+
3338
+ #### Using the start_business_agent_eval_run_with_http_info variant
3339
+
3340
+ This returns an Array which contains the response data, status code and headers.
3341
+
3342
+ > <Array(<StartBusinessAgentEvalRun202Response>, Integer, Hash)> start_business_agent_eval_run_with_http_info(account_id, start_business_agent_eval_run_request)
3343
+
3344
+ ```ruby
3345
+ begin
3346
+ # Start an evaluation run
3347
+ data, status_code, headers = api_instance.start_business_agent_eval_run_with_http_info(account_id, start_business_agent_eval_run_request)
3348
+ p status_code # => 2xx
3349
+ p headers # => { ... }
3350
+ p data # => <StartBusinessAgentEvalRun202Response>
3351
+ rescue Zernio::ApiError => e
3352
+ puts "Error when calling BusinessAgentApi->start_business_agent_eval_run_with_http_info: #{e}"
3353
+ end
3354
+ ```
3355
+
3356
+ ### Parameters
3357
+
3358
+ | Name | Type | Description | Notes |
3359
+ | ---- | ---- | ----------- | ----- |
3360
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3361
+ | **start_business_agent_eval_run_request** | [**StartBusinessAgentEvalRunRequest**](StartBusinessAgentEvalRunRequest.md) | | |
3362
+
3363
+ ### Return type
3364
+
3365
+ [**StartBusinessAgentEvalRun202Response**](StartBusinessAgentEvalRun202Response.md)
3366
+
3367
+ ### Authorization
3368
+
3369
+ [bearerAuth](../README.md#bearerAuth)
3370
+
3371
+ ### HTTP request headers
3372
+
3373
+ - **Content-Type**: application/json
3374
+ - **Accept**: application/json
3375
+
3376
+
3377
+ ## update_business_agent_connector
3378
+
3379
+ > <BusinessAgentConnector> update_business_agent_connector(account_id, connector_id, business_agent_connector_input)
3380
+
3381
+ Update a connector
3382
+
3383
+ ### Examples
3384
+
3385
+ ```ruby
3386
+ require 'time'
3387
+ require 'zernio-sdk'
3388
+ # setup authorization
3389
+ Zernio.configure do |config|
3390
+ # Configure Bearer authorization (JWT): bearerAuth
3391
+ config.access_token = 'YOUR_BEARER_TOKEN'
3392
+ end
3393
+
3394
+ api_instance = Zernio::BusinessAgentApi.new
3395
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3396
+ connector_id = 'connector_id_example' # String |
3397
+ business_agent_connector_input = Zernio::BusinessAgentConnectorInput.new({name: 'name_example', base_url: 'base_url_example', auth_type: 'OAUTH2_CLIENT_CREDENTIALS'}) # BusinessAgentConnectorInput |
3398
+
3399
+ begin
3400
+ # Update a connector
3401
+ result = api_instance.update_business_agent_connector(account_id, connector_id, business_agent_connector_input)
3402
+ p result
3403
+ rescue Zernio::ApiError => e
3404
+ puts "Error when calling BusinessAgentApi->update_business_agent_connector: #{e}"
3405
+ end
3406
+ ```
3407
+
3408
+ #### Using the update_business_agent_connector_with_http_info variant
3409
+
3410
+ This returns an Array which contains the response data, status code and headers.
3411
+
3412
+ > <Array(<BusinessAgentConnector>, Integer, Hash)> update_business_agent_connector_with_http_info(account_id, connector_id, business_agent_connector_input)
3413
+
3414
+ ```ruby
3415
+ begin
3416
+ # Update a connector
3417
+ data, status_code, headers = api_instance.update_business_agent_connector_with_http_info(account_id, connector_id, business_agent_connector_input)
3418
+ p status_code # => 2xx
3419
+ p headers # => { ... }
3420
+ p data # => <BusinessAgentConnector>
3421
+ rescue Zernio::ApiError => e
3422
+ puts "Error when calling BusinessAgentApi->update_business_agent_connector_with_http_info: #{e}"
3423
+ end
3424
+ ```
3425
+
3426
+ ### Parameters
3427
+
3428
+ | Name | Type | Description | Notes |
3429
+ | ---- | ---- | ----------- | ----- |
3430
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3431
+ | **connector_id** | **String** | | |
3432
+ | **business_agent_connector_input** | [**BusinessAgentConnectorInput**](BusinessAgentConnectorInput.md) | | |
3433
+
3434
+ ### Return type
3435
+
3436
+ [**BusinessAgentConnector**](BusinessAgentConnector.md)
3437
+
3438
+ ### Authorization
3439
+
3440
+ [bearerAuth](../README.md#bearerAuth)
3441
+
3442
+ ### HTTP request headers
3443
+
3444
+ - **Content-Type**: application/json
3445
+ - **Accept**: application/json
3446
+
3447
+
3448
+ ## update_business_agent_connector_tool
3449
+
3450
+ > <BusinessAgentConnectorTool> update_business_agent_connector_tool(account_id, connector_id, tool_id, business_agent_connector_tool_input)
3451
+
3452
+ Update a connector tool
3453
+
3454
+ ### Examples
3455
+
3456
+ ```ruby
3457
+ require 'time'
3458
+ require 'zernio-sdk'
3459
+ # setup authorization
3460
+ Zernio.configure do |config|
3461
+ # Configure Bearer authorization (JWT): bearerAuth
3462
+ config.access_token = 'YOUR_BEARER_TOKEN'
3463
+ end
3464
+
3465
+ api_instance = Zernio::BusinessAgentApi.new
3466
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3467
+ connector_id = 'connector_id_example' # String |
3468
+ tool_id = 'tool_id_example' # String |
3469
+ business_agent_connector_tool_input = Zernio::BusinessAgentConnectorToolInput.new({name: 'name_example', description: 'description_example', request_definition: { key: 3.56}}) # BusinessAgentConnectorToolInput |
3470
+
3471
+ begin
3472
+ # Update a connector tool
3473
+ result = api_instance.update_business_agent_connector_tool(account_id, connector_id, tool_id, business_agent_connector_tool_input)
3474
+ p result
3475
+ rescue Zernio::ApiError => e
3476
+ puts "Error when calling BusinessAgentApi->update_business_agent_connector_tool: #{e}"
3477
+ end
3478
+ ```
3479
+
3480
+ #### Using the update_business_agent_connector_tool_with_http_info variant
3481
+
3482
+ This returns an Array which contains the response data, status code and headers.
3483
+
3484
+ > <Array(<BusinessAgentConnectorTool>, Integer, Hash)> update_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, business_agent_connector_tool_input)
3485
+
3486
+ ```ruby
3487
+ begin
3488
+ # Update a connector tool
3489
+ data, status_code, headers = api_instance.update_business_agent_connector_tool_with_http_info(account_id, connector_id, tool_id, business_agent_connector_tool_input)
3490
+ p status_code # => 2xx
3491
+ p headers # => { ... }
3492
+ p data # => <BusinessAgentConnectorTool>
3493
+ rescue Zernio::ApiError => e
3494
+ puts "Error when calling BusinessAgentApi->update_business_agent_connector_tool_with_http_info: #{e}"
3495
+ end
3496
+ ```
3497
+
3498
+ ### Parameters
3499
+
3500
+ | Name | Type | Description | Notes |
3501
+ | ---- | ---- | ----------- | ----- |
3502
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3503
+ | **connector_id** | **String** | | |
3504
+ | **tool_id** | **String** | | |
3505
+ | **business_agent_connector_tool_input** | [**BusinessAgentConnectorToolInput**](BusinessAgentConnectorToolInput.md) | | |
3506
+
3507
+ ### Return type
3508
+
3509
+ [**BusinessAgentConnectorTool**](BusinessAgentConnectorTool.md)
3510
+
3511
+ ### Authorization
3512
+
3513
+ [bearerAuth](../README.md#bearerAuth)
3514
+
3515
+ ### HTTP request headers
3516
+
3517
+ - **Content-Type**: application/json
3518
+ - **Accept**: application/json
3519
+
3520
+
3521
+ ## update_business_agent_faq
3522
+
3523
+ > <BusinessAgentFaq> update_business_agent_faq(account_id, faq_id, business_agent_faq_input)
3524
+
3525
+ Update a FAQ
3526
+
3527
+ ### Examples
3528
+
3529
+ ```ruby
3530
+ require 'time'
3531
+ require 'zernio-sdk'
3532
+ # setup authorization
3533
+ Zernio.configure do |config|
3534
+ # Configure Bearer authorization (JWT): bearerAuth
3535
+ config.access_token = 'YOUR_BEARER_TOKEN'
3536
+ end
3537
+
3538
+ api_instance = Zernio::BusinessAgentApi.new
3539
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3540
+ faq_id = 'faq_id_example' # String |
3541
+ business_agent_faq_input = Zernio::BusinessAgentFaqInput.new({question: 'question_example', answer: 'answer_example'}) # BusinessAgentFaqInput |
3542
+
3543
+ begin
3544
+ # Update a FAQ
3545
+ result = api_instance.update_business_agent_faq(account_id, faq_id, business_agent_faq_input)
3546
+ p result
3547
+ rescue Zernio::ApiError => e
3548
+ puts "Error when calling BusinessAgentApi->update_business_agent_faq: #{e}"
3549
+ end
3550
+ ```
3551
+
3552
+ #### Using the update_business_agent_faq_with_http_info variant
3553
+
3554
+ This returns an Array which contains the response data, status code and headers.
3555
+
3556
+ > <Array(<BusinessAgentFaq>, Integer, Hash)> update_business_agent_faq_with_http_info(account_id, faq_id, business_agent_faq_input)
3557
+
3558
+ ```ruby
3559
+ begin
3560
+ # Update a FAQ
3561
+ data, status_code, headers = api_instance.update_business_agent_faq_with_http_info(account_id, faq_id, business_agent_faq_input)
3562
+ p status_code # => 2xx
3563
+ p headers # => { ... }
3564
+ p data # => <BusinessAgentFaq>
3565
+ rescue Zernio::ApiError => e
3566
+ puts "Error when calling BusinessAgentApi->update_business_agent_faq_with_http_info: #{e}"
3567
+ end
3568
+ ```
3569
+
3570
+ ### Parameters
3571
+
3572
+ | Name | Type | Description | Notes |
3573
+ | ---- | ---- | ----------- | ----- |
3574
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3575
+ | **faq_id** | **String** | | |
3576
+ | **business_agent_faq_input** | [**BusinessAgentFaqInput**](BusinessAgentFaqInput.md) | | |
3577
+
3578
+ ### Return type
3579
+
3580
+ [**BusinessAgentFaq**](BusinessAgentFaq.md)
3581
+
3582
+ ### Authorization
3583
+
3584
+ [bearerAuth](../README.md#bearerAuth)
3585
+
3586
+ ### HTTP request headers
3587
+
3588
+ - **Content-Type**: application/json
3589
+ - **Accept**: application/json
3590
+
3591
+
3592
+ ## update_business_agent_settings
3593
+
3594
+ > <BusinessAgentSettings> update_business_agent_settings(account_id, update_business_agent_settings_request, opts)
3595
+
3596
+ Update agent settings
3597
+
3598
+ 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.
3599
+
3600
+ ### Examples
3601
+
3602
+ ```ruby
3603
+ require 'time'
3604
+ require 'zernio-sdk'
3605
+ # setup authorization
3606
+ Zernio.configure do |config|
3607
+ # Configure Bearer authorization (JWT): bearerAuth
3608
+ config.access_token = 'YOUR_BEARER_TOKEN'
3609
+ end
3610
+
3611
+ api_instance = Zernio::BusinessAgentApi.new
3612
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3613
+ update_business_agent_settings_request = Zernio::UpdateBusinessAgentSettingsRequest.new # UpdateBusinessAgentSettingsRequest |
3614
+ opts = {
3615
+ agent_id: 'agent_id_example' # String |
3616
+ }
3617
+
3618
+ begin
3619
+ # Update agent settings
3620
+ result = api_instance.update_business_agent_settings(account_id, update_business_agent_settings_request, opts)
3621
+ p result
3622
+ rescue Zernio::ApiError => e
3623
+ puts "Error when calling BusinessAgentApi->update_business_agent_settings: #{e}"
3624
+ end
3625
+ ```
3626
+
3627
+ #### Using the update_business_agent_settings_with_http_info variant
3628
+
3629
+ This returns an Array which contains the response data, status code and headers.
3630
+
3631
+ > <Array(<BusinessAgentSettings>, Integer, Hash)> update_business_agent_settings_with_http_info(account_id, update_business_agent_settings_request, opts)
3632
+
3633
+ ```ruby
3634
+ begin
3635
+ # Update agent settings
3636
+ data, status_code, headers = api_instance.update_business_agent_settings_with_http_info(account_id, update_business_agent_settings_request, opts)
3637
+ p status_code # => 2xx
3638
+ p headers # => { ... }
3639
+ p data # => <BusinessAgentSettings>
3640
+ rescue Zernio::ApiError => e
3641
+ puts "Error when calling BusinessAgentApi->update_business_agent_settings_with_http_info: #{e}"
3642
+ end
3643
+ ```
3644
+
3645
+ ### Parameters
3646
+
3647
+ | Name | Type | Description | Notes |
3648
+ | ---- | ---- | ----------- | ----- |
3649
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3650
+ | **update_business_agent_settings_request** | [**UpdateBusinessAgentSettingsRequest**](UpdateBusinessAgentSettingsRequest.md) | | |
3651
+ | **agent_id** | **String** | | [optional] |
3652
+
3653
+ ### Return type
3654
+
3655
+ [**BusinessAgentSettings**](BusinessAgentSettings.md)
3656
+
3657
+ ### Authorization
3658
+
3659
+ [bearerAuth](../README.md#bearerAuth)
3660
+
3661
+ ### HTTP request headers
3662
+
3663
+ - **Content-Type**: application/json
3664
+ - **Accept**: application/json
3665
+
3666
+
3667
+ ## update_business_agent_skill
3668
+
3669
+ > <BusinessAgentSkill> update_business_agent_skill(account_id, skill_id, business_agent_skill_input)
3670
+
3671
+ Update a skill
3672
+
3673
+ ### Examples
3674
+
3675
+ ```ruby
3676
+ require 'time'
3677
+ require 'zernio-sdk'
3678
+ # setup authorization
3679
+ Zernio.configure do |config|
3680
+ # Configure Bearer authorization (JWT): bearerAuth
3681
+ config.access_token = 'YOUR_BEARER_TOKEN'
3682
+ end
3683
+
3684
+ api_instance = Zernio::BusinessAgentApi.new
3685
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3686
+ skill_id = 'skill_id_example' # String |
3687
+ business_agent_skill_input = Zernio::BusinessAgentSkillInput.new({skill: 'skill_example'}) # BusinessAgentSkillInput |
3688
+
3689
+ begin
3690
+ # Update a skill
3691
+ result = api_instance.update_business_agent_skill(account_id, skill_id, business_agent_skill_input)
3692
+ p result
3693
+ rescue Zernio::ApiError => e
3694
+ puts "Error when calling BusinessAgentApi->update_business_agent_skill: #{e}"
3695
+ end
3696
+ ```
3697
+
3698
+ #### Using the update_business_agent_skill_with_http_info variant
3699
+
3700
+ This returns an Array which contains the response data, status code and headers.
3701
+
3702
+ > <Array(<BusinessAgentSkill>, Integer, Hash)> update_business_agent_skill_with_http_info(account_id, skill_id, business_agent_skill_input)
3703
+
3704
+ ```ruby
3705
+ begin
3706
+ # Update a skill
3707
+ data, status_code, headers = api_instance.update_business_agent_skill_with_http_info(account_id, skill_id, business_agent_skill_input)
3708
+ p status_code # => 2xx
3709
+ p headers # => { ... }
3710
+ p data # => <BusinessAgentSkill>
3711
+ rescue Zernio::ApiError => e
3712
+ puts "Error when calling BusinessAgentApi->update_business_agent_skill_with_http_info: #{e}"
3713
+ end
3714
+ ```
3715
+
3716
+ ### Parameters
3717
+
3718
+ | Name | Type | Description | Notes |
3719
+ | ---- | ---- | ----------- | ----- |
3720
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3721
+ | **skill_id** | **String** | | |
3722
+ | **business_agent_skill_input** | [**BusinessAgentSkillInput**](BusinessAgentSkillInput.md) | | |
3723
+
3724
+ ### Return type
3725
+
3726
+ [**BusinessAgentSkill**](BusinessAgentSkill.md)
3727
+
3728
+ ### Authorization
3729
+
3730
+ [bearerAuth](../README.md#bearerAuth)
3731
+
3732
+ ### HTTP request headers
3733
+
3734
+ - **Content-Type**: application/json
3735
+ - **Accept**: application/json
3736
+
3737
+
3738
+ ## update_business_agent_ui_skill
3739
+
3740
+ > <BusinessAgentUiSkill> update_business_agent_ui_skill(account_id, ui_skill_id, business_agent_ui_skill_input)
3741
+
3742
+ Update a UI skill
3743
+
3744
+ ### Examples
3745
+
3746
+ ```ruby
3747
+ require 'time'
3748
+ require 'zernio-sdk'
3749
+ # setup authorization
3750
+ Zernio.configure do |config|
3751
+ # Configure Bearer authorization (JWT): bearerAuth
3752
+ config.access_token = 'YOUR_BEARER_TOKEN'
3753
+ end
3754
+
3755
+ api_instance = Zernio::BusinessAgentApi.new
3756
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3757
+ ui_skill_id = 'ui_skill_id_example' # String |
3758
+ business_agent_ui_skill_input = Zernio::BusinessAgentUiSkillInput.new({component_type: 'carousel_quick_reply', status: 'enabled', instruction: 'instruction_example'}) # BusinessAgentUiSkillInput |
3759
+
3760
+ begin
3761
+ # Update a UI skill
3762
+ result = api_instance.update_business_agent_ui_skill(account_id, ui_skill_id, business_agent_ui_skill_input)
3763
+ p result
3764
+ rescue Zernio::ApiError => e
3765
+ puts "Error when calling BusinessAgentApi->update_business_agent_ui_skill: #{e}"
3766
+ end
3767
+ ```
3768
+
3769
+ #### Using the update_business_agent_ui_skill_with_http_info variant
3770
+
3771
+ This returns an Array which contains the response data, status code and headers.
3772
+
3773
+ > <Array(<BusinessAgentUiSkill>, Integer, Hash)> update_business_agent_ui_skill_with_http_info(account_id, ui_skill_id, business_agent_ui_skill_input)
3774
+
3775
+ ```ruby
3776
+ begin
3777
+ # Update a UI skill
3778
+ data, status_code, headers = api_instance.update_business_agent_ui_skill_with_http_info(account_id, ui_skill_id, business_agent_ui_skill_input)
3779
+ p status_code # => 2xx
3780
+ p headers # => { ... }
3781
+ p data # => <BusinessAgentUiSkill>
3782
+ rescue Zernio::ApiError => e
3783
+ puts "Error when calling BusinessAgentApi->update_business_agent_ui_skill_with_http_info: #{e}"
3784
+ end
3785
+ ```
3786
+
3787
+ ### Parameters
3788
+
3789
+ | Name | Type | Description | Notes |
3790
+ | ---- | ---- | ----------- | ----- |
3791
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3792
+ | **ui_skill_id** | **String** | | |
3793
+ | **business_agent_ui_skill_input** | [**BusinessAgentUiSkillInput**](BusinessAgentUiSkillInput.md) | | |
3794
+
3795
+ ### Return type
3796
+
3797
+ [**BusinessAgentUiSkill**](BusinessAgentUiSkill.md)
3798
+
3799
+ ### Authorization
3800
+
3801
+ [bearerAuth](../README.md#bearerAuth)
3802
+
3803
+ ### HTTP request headers
3804
+
3805
+ - **Content-Type**: application/json
3806
+ - **Accept**: application/json
3807
+
3808
+
3809
+ ## update_business_agent_website
3810
+
3811
+ > <BusinessAgentWebsite> update_business_agent_website(account_id, website_id, business_agent_website_input)
3812
+
3813
+ Update a crawled website
3814
+
3815
+ ### Examples
3816
+
3817
+ ```ruby
3818
+ require 'time'
3819
+ require 'zernio-sdk'
3820
+ # setup authorization
3821
+ Zernio.configure do |config|
3822
+ # Configure Bearer authorization (JWT): bearerAuth
3823
+ config.access_token = 'YOUR_BEARER_TOKEN'
3824
+ end
3825
+
3826
+ api_instance = Zernio::BusinessAgentApi.new
3827
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3828
+ website_id = 'website_id_example' # String |
3829
+ business_agent_website_input = Zernio::BusinessAgentWebsiteInput.new({url: 'url_example'}) # BusinessAgentWebsiteInput |
3830
+
3831
+ begin
3832
+ # Update a crawled website
3833
+ result = api_instance.update_business_agent_website(account_id, website_id, business_agent_website_input)
3834
+ p result
3835
+ rescue Zernio::ApiError => e
3836
+ puts "Error when calling BusinessAgentApi->update_business_agent_website: #{e}"
3837
+ end
3838
+ ```
3839
+
3840
+ #### Using the update_business_agent_website_with_http_info variant
3841
+
3842
+ This returns an Array which contains the response data, status code and headers.
3843
+
3844
+ > <Array(<BusinessAgentWebsite>, Integer, Hash)> update_business_agent_website_with_http_info(account_id, website_id, business_agent_website_input)
3845
+
3846
+ ```ruby
3847
+ begin
3848
+ # Update a crawled website
3849
+ data, status_code, headers = api_instance.update_business_agent_website_with_http_info(account_id, website_id, business_agent_website_input)
3850
+ p status_code # => 2xx
3851
+ p headers # => { ... }
3852
+ p data # => <BusinessAgentWebsite>
3853
+ rescue Zernio::ApiError => e
3854
+ puts "Error when calling BusinessAgentApi->update_business_agent_website_with_http_info: #{e}"
3855
+ end
3856
+ ```
3857
+
3858
+ ### Parameters
3859
+
3860
+ | Name | Type | Description | Notes |
3861
+ | ---- | ---- | ----------- | ----- |
3862
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3863
+ | **website_id** | **String** | | |
3864
+ | **business_agent_website_input** | [**BusinessAgentWebsiteInput**](BusinessAgentWebsiteInput.md) | | |
3865
+
3866
+ ### Return type
3867
+
3868
+ [**BusinessAgentWebsite**](BusinessAgentWebsite.md)
3869
+
3870
+ ### Authorization
3871
+
3872
+ [bearerAuth](../README.md#bearerAuth)
3873
+
3874
+ ### HTTP request headers
3875
+
3876
+ - **Content-Type**: application/json
3877
+ - **Accept**: application/json
3878
+
3879
+
3880
+ ## upload_business_agent_file
3881
+
3882
+ > <BusinessAgentKnowledgeFile> upload_business_agent_file(account_id, upload_business_agent_file_request)
3883
+
3884
+ Upload a knowledge file
3885
+
3886
+ 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.
3887
+
3888
+ ### Examples
3889
+
3890
+ ```ruby
3891
+ require 'time'
3892
+ require 'zernio-sdk'
3893
+ # setup authorization
3894
+ Zernio.configure do |config|
3895
+ # Configure Bearer authorization (JWT): bearerAuth
3896
+ config.access_token = 'YOUR_BEARER_TOKEN'
3897
+ end
3898
+
3899
+ api_instance = Zernio::BusinessAgentApi.new
3900
+ account_id = 'account_id_example' # String | WhatsApp social account id (the number must be managed through the Cloud API).
3901
+ upload_business_agent_file_request = Zernio::UploadBusinessAgentFileRequest.new({url: 'url_example'}) # UploadBusinessAgentFileRequest |
3902
+
3903
+ begin
3904
+ # Upload a knowledge file
3905
+ result = api_instance.upload_business_agent_file(account_id, upload_business_agent_file_request)
3906
+ p result
3907
+ rescue Zernio::ApiError => e
3908
+ puts "Error when calling BusinessAgentApi->upload_business_agent_file: #{e}"
3909
+ end
3910
+ ```
3911
+
3912
+ #### Using the upload_business_agent_file_with_http_info variant
3913
+
3914
+ This returns an Array which contains the response data, status code and headers.
3915
+
3916
+ > <Array(<BusinessAgentKnowledgeFile>, Integer, Hash)> upload_business_agent_file_with_http_info(account_id, upload_business_agent_file_request)
3917
+
3918
+ ```ruby
3919
+ begin
3920
+ # Upload a knowledge file
3921
+ data, status_code, headers = api_instance.upload_business_agent_file_with_http_info(account_id, upload_business_agent_file_request)
3922
+ p status_code # => 2xx
3923
+ p headers # => { ... }
3924
+ p data # => <BusinessAgentKnowledgeFile>
3925
+ rescue Zernio::ApiError => e
3926
+ puts "Error when calling BusinessAgentApi->upload_business_agent_file_with_http_info: #{e}"
3927
+ end
3928
+ ```
3929
+
3930
+ ### Parameters
3931
+
3932
+ | Name | Type | Description | Notes |
3933
+ | ---- | ---- | ----------- | ----- |
3934
+ | **account_id** | **String** | WhatsApp social account id (the number must be managed through the Cloud API). | |
3935
+ | **upload_business_agent_file_request** | [**UploadBusinessAgentFileRequest**](UploadBusinessAgentFileRequest.md) | | |
3936
+
3937
+ ### Return type
3938
+
3939
+ [**BusinessAgentKnowledgeFile**](BusinessAgentKnowledgeFile.md)
3940
+
3941
+ ### Authorization
3942
+
3943
+ [bearerAuth](../README.md#bearerAuth)
3944
+
3945
+ ### HTTP request headers
3946
+
3947
+ - **Content-Type**: application/json, multipart/form-data
3948
+ - **Accept**: application/json
3949
+