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,22 @@
1
+ # Zernio::BusinessAgentApiKeyConfig
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **headers** | [**Array<BusinessAgentApiKeyParamsInner>**](BusinessAgentApiKeyParamsInner.md) | | [optional] |
8
+ | **_query_params** | [**Array<BusinessAgentApiKeyParamsInner>**](BusinessAgentApiKeyParamsInner.md) | | [optional] |
9
+ | **body_params** | [**Array<BusinessAgentApiKeyParamsInner>**](BusinessAgentApiKeyParamsInner.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentApiKeyConfig.new(
17
+ headers: null,
18
+ _query_params: null,
19
+ body_params: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentApiKeyParamsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **field_name** | **String** | | |
8
+ | **value** | **String** | | |
9
+ | **prefix** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentApiKeyParamsInner.new(
17
+ field_name: null,
18
+ value: null,
19
+ prefix: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # Zernio::BusinessAgentBudget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **budget_id** | **String** | Pass it back to edit an existing budget; omit to add one. | [optional] |
8
+ | **unit_type** | **String** | Tokens count across the Business Manager, AI turns per conversation. | |
9
+ | **time_window** | **String** | Rolling window in the WABA timezone. | |
10
+ | **max_budget** | **Integer** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zernio-sdk'
16
+
17
+ instance = Zernio::BusinessAgentBudget.new(
18
+ budget_id: null,
19
+ unit_type: null,
20
+ time_window: null,
21
+ max_budget: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,28 @@
1
+ # Zernio::BusinessAgentBusinessInformation
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payment_method** | **String** | | [optional] |
8
+ | **return_policy** | **String** | | [optional] |
9
+ | **purchase_info** | **String** | | [optional] |
10
+ | **delivery_and_shipping** | **String** | | [optional] |
11
+ | **business_description** | **String** | | [optional] |
12
+ | **contact_info** | [**BusinessAgentBusinessInformationContactInfo**](BusinessAgentBusinessInformationContactInfo.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zernio-sdk'
18
+
19
+ instance = Zernio::BusinessAgentBusinessInformation.new(
20
+ payment_method: null,
21
+ return_policy: null,
22
+ purchase_info: null,
23
+ delivery_and_shipping: null,
24
+ business_description: null,
25
+ contact_info: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentBusinessInformationContactInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | | [optional] |
8
+ | **hours_of_operation** | **String** | | [optional] |
9
+ | **address** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentBusinessInformationContactInfo.new(
17
+ email: null,
18
+ hours_of_operation: null,
19
+ address: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,40 @@
1
+ # Zernio::BusinessAgentConnector
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Unique per number. | |
8
+ | **description** | **String** | Tell the agent what the service provides. | [optional] |
9
+ | **base_url** | **String** | Public HTTPS URL reachable from Meta. | |
10
+ | **connector_protocol** | **String** | | [optional] |
11
+ | **auth_type** | **String** | | |
12
+ | **auth_config** | [**BusinessAgentConnectorInputAuthConfig**](BusinessAgentConnectorInputAuthConfig.md) | | [optional] |
13
+ | **user_auth_injection_config** | [**BusinessAgentConnectorInputUserAuthInjectionConfig**](BusinessAgentConnectorInputUserAuthInjectionConfig.md) | | [optional] |
14
+ | **requires_certificate** | **Boolean** | | [optional] |
15
+ | **id** | **String** | | |
16
+ | **mcp_tool_sync** | **Hash<String, Object>** | | [optional] |
17
+ | **mtls_config** | **Hash<String, Object>** | | [optional] |
18
+ | **connection_status** | [**BusinessAgentConnectorAllOfConnectionStatus**](BusinessAgentConnectorAllOfConnectionStatus.md) | | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'zernio-sdk'
24
+
25
+ instance = Zernio::BusinessAgentConnector.new(
26
+ name: null,
27
+ description: null,
28
+ base_url: null,
29
+ connector_protocol: HTTP,
30
+ auth_type: null,
31
+ auth_config: null,
32
+ user_auth_injection_config: null,
33
+ requires_certificate: null,
34
+ id: null,
35
+ mcp_tool_sync: null,
36
+ mtls_config: null,
37
+ connection_status: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,20 @@
1
+ # Zernio::BusinessAgentConnectorAllOfConnectionStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | ACTIVE, PENDING_OAUTH, EXPIRED or ERROR. | [optional] |
8
+ | **error_message** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zernio-sdk'
14
+
15
+ instance = Zernio::BusinessAgentConnectorAllOfConnectionStatus.new(
16
+ status: null,
17
+ error_message: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,32 @@
1
+ # Zernio::BusinessAgentConnectorInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Unique per number. | |
8
+ | **description** | **String** | Tell the agent what the service provides. | [optional] |
9
+ | **base_url** | **String** | Public HTTPS URL reachable from Meta. | |
10
+ | **connector_protocol** | **String** | | [optional] |
11
+ | **auth_type** | **String** | | |
12
+ | **auth_config** | [**BusinessAgentConnectorInputAuthConfig**](BusinessAgentConnectorInputAuthConfig.md) | | [optional] |
13
+ | **user_auth_injection_config** | [**BusinessAgentConnectorInputUserAuthInjectionConfig**](BusinessAgentConnectorInputUserAuthInjectionConfig.md) | | [optional] |
14
+ | **requires_certificate** | **Boolean** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'zernio-sdk'
20
+
21
+ instance = Zernio::BusinessAgentConnectorInput.new(
22
+ name: null,
23
+ description: null,
24
+ base_url: null,
25
+ connector_protocol: HTTP,
26
+ auth_type: null,
27
+ auth_config: null,
28
+ user_auth_injection_config: null,
29
+ requires_certificate: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,20 @@
1
+ # Zernio::BusinessAgentConnectorInputAuthConfig
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **oauth2_client_credentials** | [**BusinessAgentOAuthClientCredentials**](BusinessAgentOAuthClientCredentials.md) | | [optional] |
8
+ | **api_key** | [**BusinessAgentApiKeyConfig**](BusinessAgentApiKeyConfig.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zernio-sdk'
14
+
15
+ instance = Zernio::BusinessAgentConnectorInputAuthConfig.new(
16
+ oauth2_client_credentials: null,
17
+ api_key: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentConnectorInputUserAuthInjectionConfig
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **location** | **String** | | |
8
+ | **field_name** | **String** | | |
9
+ | **prefix** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentConnectorInputUserAuthInjectionConfig.new(
17
+ location: headers,
18
+ field_name: null,
19
+ prefix: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,30 @@
1
+ # Zernio::BusinessAgentConnectorTool
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **description** | **String** | When and how the agent should use the operation. | |
9
+ | **request_definition** | **Hash<String, Object>** | Meta request definition: method, path, path_parameters, query_parameters, headers and a typed body schema (content_type, params, required). | |
10
+ | **user_auth_required** | **Boolean** | | [optional] |
11
+ | **user_auth_action_config** | **Hash<String, Object>** | | [optional] |
12
+ | **transformation_spec** | **Hash<String, Object>** | | [optional] |
13
+ | **id** | **String** | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zernio-sdk'
19
+
20
+ instance = Zernio::BusinessAgentConnectorTool.new(
21
+ name: null,
22
+ description: null,
23
+ request_definition: null,
24
+ user_auth_required: null,
25
+ user_auth_action_config: null,
26
+ transformation_spec: null,
27
+ id: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,28 @@
1
+ # Zernio::BusinessAgentConnectorToolInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **description** | **String** | When and how the agent should use the operation. | |
9
+ | **request_definition** | **Hash<String, Object>** | Meta request definition: method, path, path_parameters, query_parameters, headers and a typed body schema (content_type, params, required). | |
10
+ | **user_auth_required** | **Boolean** | | [optional] |
11
+ | **user_auth_action_config** | **Hash<String, Object>** | | [optional] |
12
+ | **transformation_spec** | **Hash<String, Object>** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zernio-sdk'
18
+
19
+ instance = Zernio::BusinessAgentConnectorToolInput.new(
20
+ name: null,
21
+ description: null,
22
+ request_definition: null,
23
+ user_auth_required: null,
24
+ user_auth_action_config: null,
25
+ transformation_spec: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # Zernio::BusinessAgentEventStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **event_type** | **String** | | |
9
+ | **error_message** | **String** | | [optional] |
10
+ | **skipped_reason** | **String** | | [optional] |
11
+ | **created_at** | **Time** | | |
12
+ | **updated_at** | **Time** | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zernio-sdk'
18
+
19
+ instance = Zernio::BusinessAgentEventStatus.new(
20
+ status: null,
21
+ event_type: null,
22
+ error_message: null,
23
+ skipped_reason: null,
24
+ created_at: null,
25
+ updated_at: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # Zernio::BusinessAgentFaq
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **question** | **String** | Phrase it the way a customer would ask it; one topic per entry. | |
8
+ | **answer** | **String** | Self-contained; the agent retrieves entries independently. | |
9
+ | **metadata** | **Hash<String, String>** | | [optional] |
10
+ | **id** | **String** | | |
11
+ | **created_at** | **Integer** | Unix seconds. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zernio-sdk'
17
+
18
+ instance = Zernio::BusinessAgentFaq.new(
19
+ question: null,
20
+ answer: null,
21
+ metadata: null,
22
+ id: null,
23
+ created_at: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentFaqInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **question** | **String** | Phrase it the way a customer would ask it; one topic per entry. | |
8
+ | **answer** | **String** | Self-contained; the agent retrieves entries independently. | |
9
+ | **metadata** | **Hash<String, String>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentFaqInput.new(
17
+ question: null,
18
+ answer: null,
19
+ metadata: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # Zernio::BusinessAgentKnowledgeFile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **file_name** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zernio-sdk'
14
+
15
+ instance = Zernio::BusinessAgentKnowledgeFile.new(
16
+ id: null,
17
+ file_name: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # Zernio::BusinessAgentOAuthClientCredentials
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **token_url** | **String** | | |
8
+ | **scopes_to_request** | **Array<String>** | | [optional] |
9
+ | **token_request_content_type** | **String** | | [optional] |
10
+ | **client_id** | **String** | | |
11
+ | **client_secret** | **String** | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zernio-sdk'
17
+
18
+ instance = Zernio::BusinessAgentOAuthClientCredentials.new(
19
+ token_url: null,
20
+ scopes_to_request: null,
21
+ token_request_content_type: application/x-www-form-urlencoded,
22
+ client_id: null,
23
+ client_secret: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,30 @@
1
+ # Zernio::BusinessAgentSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **agent_id** | **String** | | |
8
+ | **channel** | **String** | | |
9
+ | **rollout** | [**BusinessAgentSettingsRollout**](BusinessAgentSettingsRollout.md) | | |
10
+ | **handoff** | [**BusinessAgentSettingsHandoff**](BusinessAgentSettingsHandoff.md) | | [optional] |
11
+ | **followup** | [**BusinessAgentSettingsFollowup**](BusinessAgentSettingsFollowup.md) | | [optional] |
12
+ | **ai_audience** | **String** | EVERYONE answers all consumers; ALLOWLISTED_ONLY answers only the allowlist and needs no payment method. | [optional] |
13
+ | **never_say_phrases** | **Array<String>** | Exact phrases the agent must never say. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zernio-sdk'
19
+
20
+ instance = Zernio::BusinessAgentSettings.new(
21
+ agent_id: null,
22
+ channel: whatsapp,
23
+ rollout: null,
24
+ handoff: null,
25
+ followup: null,
26
+ ai_audience: null,
27
+ never_say_phrases: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentSettingsFollowup
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | | [optional] |
8
+ | **followup_interval_in_seconds** | **Integer** | | [optional] |
9
+ | **message** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentSettingsFollowup.new(
17
+ enabled: null,
18
+ followup_interval_in_seconds: null,
19
+ message: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentSettingsHandoff
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | Whether the agent releases the thread after sending its handoff message. | [optional] |
8
+ | **message** | **String** | | [optional] |
9
+ | **message_selection** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentSettingsHandoff.new(
17
+ enabled: null,
18
+ message: null,
19
+ message_selection: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # Zernio::BusinessAgentSettingsRollout
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | Whether the agent answers live conversations. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zernio-sdk'
13
+
14
+ instance = Zernio::BusinessAgentSettingsRollout.new(
15
+ enabled: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,30 @@
1
+ # Zernio::BusinessAgentSkill
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **title** | **String** | Lowercase letters, digits and hyphens, e.g. greeting-skill. | [optional] |
8
+ | **description** | **String** | When the agent should apply the skill. | [optional] |
9
+ | **skill** | **String** | The instructions themselves. Avoid two skills that both claim priority for the same situation. | |
10
+ | **id** | **String** | | |
11
+ | **channel** | **String** | | [optional] |
12
+ | **created_at** | **Integer** | Unix seconds. | [optional] |
13
+ | **status** | **String** | pending_review right after a write; blocked means Meta content review rejected it and the agent never applies it. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zernio-sdk'
19
+
20
+ instance = Zernio::BusinessAgentSkill.new(
21
+ title: null,
22
+ description: null,
23
+ skill: null,
24
+ id: null,
25
+ channel: null,
26
+ created_at: null,
27
+ status: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentSkillInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **title** | **String** | Lowercase letters, digits and hyphens, e.g. greeting-skill. | [optional] |
8
+ | **description** | **String** | When the agent should apply the skill. | [optional] |
9
+ | **skill** | **String** | The instructions themselves. Avoid two skills that both claim priority for the same situation. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentSkillInput.new(
17
+ title: null,
18
+ description: null,
19
+ skill: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,32 @@
1
+ # Zernio::BusinessAgentStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **eligible** | **Boolean** | Whether the number can run the agent; null when the terms are not accepted yet (Meta refuses the check). | |
8
+ | **terms_accepted** | **Boolean** | False when Meta rejects calls because the merchant has not accepted the terms in WhatsApp Manager. | |
9
+ | **onboarded** | **Boolean** | An agent exists on the number (onboard was called). | |
10
+ | **enabled** | **Boolean** | The agent answers live conversations. | |
11
+ | **agent_id** | **String** | | |
12
+ | **settings** | [**BusinessAgentSettings**](BusinessAgentSettings.md) | | |
13
+ | **manual_steps** | [**Array<BusinessAgentStatusManualStepsInner>**](BusinessAgentStatusManualStepsInner.md) | Steps Meta keeps outside the API that Zernio can verify are still pending. | |
14
+ | **unverified_steps** | [**Array<BusinessAgentStatusUnverifiedStepsInner>**](BusinessAgentStatusUnverifiedStepsInner.md) | Steps Meta keeps outside the API and exposes no state for, listed once an agent exists. Informational: Zernio cannot tell whether the merchant already did them. | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'zernio-sdk'
20
+
21
+ instance = Zernio::BusinessAgentStatus.new(
22
+ eligible: null,
23
+ terms_accepted: null,
24
+ onboarded: null,
25
+ enabled: null,
26
+ agent_id: null,
27
+ settings: null,
28
+ manual_steps: null,
29
+ unverified_steps: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentStatusManualStepsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **step** | **String** | | |
8
+ | **url** | **String** | | |
9
+ | **description** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentStatusManualStepsInner.new(
17
+ step: null,
18
+ url: null,
19
+ description: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # Zernio::BusinessAgentStatusUnverifiedStepsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **step** | **String** | | |
8
+ | **url** | **String** | | |
9
+ | **description** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::BusinessAgentStatusUnverifiedStepsInner.new(
17
+ step: null,
18
+ url: null,
19
+ description: null
20
+ )
21
+ ```
22
+