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.
- checksums.yaml +4 -4
- data/README.md +118 -3
- data/docs/AddBusinessAgentAllowlistEntryRequest.md +18 -0
- data/docs/BusinessAgentAllowlistEntry.md +20 -0
- data/docs/BusinessAgentApi.md +3949 -0
- data/docs/BusinessAgentApiKeyConfig.md +22 -0
- data/docs/BusinessAgentApiKeyParamsInner.md +22 -0
- data/docs/BusinessAgentBudget.md +24 -0
- data/docs/BusinessAgentBusinessInformation.md +28 -0
- data/docs/BusinessAgentBusinessInformationContactInfo.md +22 -0
- data/docs/BusinessAgentConnector.md +40 -0
- data/docs/BusinessAgentConnectorAllOfConnectionStatus.md +20 -0
- data/docs/BusinessAgentConnectorInput.md +32 -0
- data/docs/BusinessAgentConnectorInputAuthConfig.md +20 -0
- data/docs/BusinessAgentConnectorInputUserAuthInjectionConfig.md +22 -0
- data/docs/BusinessAgentConnectorTool.md +30 -0
- data/docs/BusinessAgentConnectorToolInput.md +28 -0
- data/docs/BusinessAgentEventStatus.md +28 -0
- data/docs/BusinessAgentFaq.md +26 -0
- data/docs/BusinessAgentFaqInput.md +22 -0
- data/docs/BusinessAgentKnowledgeFile.md +20 -0
- data/docs/BusinessAgentOAuthClientCredentials.md +26 -0
- data/docs/BusinessAgentSettings.md +30 -0
- data/docs/BusinessAgentSettingsFollowup.md +22 -0
- data/docs/BusinessAgentSettingsHandoff.md +22 -0
- data/docs/BusinessAgentSettingsRollout.md +18 -0
- data/docs/BusinessAgentSkill.md +30 -0
- data/docs/BusinessAgentSkillInput.md +22 -0
- data/docs/BusinessAgentStatus.md +32 -0
- data/docs/BusinessAgentStatusManualStepsInner.md +22 -0
- data/docs/BusinessAgentStatusUnverifiedStepsInner.md +22 -0
- data/docs/BusinessAgentTestMessageResponse.md +32 -0
- data/docs/BusinessAgentUiSkill.md +32 -0
- data/docs/BusinessAgentUiSkillInput.md +26 -0
- data/docs/BusinessAgentWebsite.md +40 -0
- data/docs/BusinessAgentWebsiteInput.md +28 -0
- data/docs/ConnectApi.md +1 -68
- data/docs/ConnectWhatsAppEmbeddedSignupRequest.md +4 -4
- data/docs/GetBusinessAgentBudget200Response.md +18 -0
- data/docs/GetBusinessAgentConnectorLogs200Response.md +20 -0
- data/docs/InlineObject.md +2 -2
- data/docs/InlineObject1.md +1 -1
- data/docs/InlineObject2.md +1 -5
- data/docs/InlineObject3.md +5 -11
- data/docs/InlineObject4.md +28 -0
- data/docs/{InlineObject3Details.md → InlineObject4Details.md} +2 -2
- data/docs/ListBusinessAgentAllowlist200Response.md +18 -0
- data/docs/ListBusinessAgentConnectorTools200Response.md +18 -0
- data/docs/ListBusinessAgentConnectors200Response.md +18 -0
- data/docs/ListBusinessAgentFaqs200Response.md +18 -0
- data/docs/ListBusinessAgentFiles200Response.md +18 -0
- data/docs/ListBusinessAgentSettings200Response.md +18 -0
- data/docs/ListBusinessAgentSkills200Response.md +18 -0
- data/docs/ListBusinessAgentUiSkills200Response.md +20 -0
- data/docs/ListBusinessAgentWebsites200Response.md +18 -0
- data/docs/MessagesApi.md +1 -1
- data/docs/OnboardBusinessAgent201Response.md +18 -0
- data/docs/RunBusinessAgentConnectorTool200Response.md +20 -0
- data/docs/RunBusinessAgentConnectorToolRequest.md +18 -0
- data/docs/SendBusinessAgentEvent202Response.md +20 -0
- data/docs/SendBusinessAgentEventRequest.md +24 -0
- data/docs/SendBusinessAgentTestMessageRequest.md +20 -0
- data/docs/SetBusinessAgentConnectorCredentialsRequest.md +51 -0
- data/docs/SetBusinessAgentConnectorCredentialsRequestOneOf.md +20 -0
- data/docs/SetBusinessAgentConnectorCredentialsRequestOneOf1.md +20 -0
- data/docs/SetBusinessAgentConnectorCredentialsRequestOneOf2.md +24 -0
- data/docs/StartBusinessAgentEvalRun202Response.md +20 -0
- data/docs/StartBusinessAgentEvalRunRequest.md +18 -0
- data/docs/UpdateBusinessAgentSettingsRequest.md +26 -0
- data/docs/UpdateBusinessAgentSettingsRequestFollowup.md +22 -0
- data/docs/UpdateBusinessAgentSettingsRequestHandoff.md +22 -0
- data/docs/UpdateBusinessAgentSettingsRequestRollout.md +18 -0
- data/docs/UploadBusinessAgentFileRequest.md +20 -0
- data/lib/zernio-sdk/api/business_agent_api.rb +3934 -0
- data/lib/zernio-sdk/api/connect_api.rb +2 -59
- data/lib/zernio-sdk/api/messages_api.rb +2 -2
- data/lib/zernio-sdk/models/add_business_agent_allowlist_entry_request.rb +164 -0
- data/lib/zernio-sdk/models/business_agent_allowlist_entry.rb +174 -0
- data/lib/zernio-sdk/models/business_agent_api_key_config.rb +172 -0
- data/lib/zernio-sdk/models/business_agent_api_key_params_inner.rb +199 -0
- data/lib/zernio-sdk/models/business_agent_budget.rb +263 -0
- data/lib/zernio-sdk/models/business_agent_business_information.rb +193 -0
- data/lib/zernio-sdk/models/business_agent_business_information_contact_info.rb +165 -0
- data/lib/zernio-sdk/models/business_agent_connector.rb +352 -0
- data/lib/zernio-sdk/models/business_agent_connector_all_of_connection_status.rb +157 -0
- data/lib/zernio-sdk/models/business_agent_connector_input.rb +288 -0
- data/lib/zernio-sdk/models/business_agent_connector_input_auth_config.rb +156 -0
- data/lib/zernio-sdk/models/business_agent_connector_input_user_auth_injection_config.rb +199 -0
- data/lib/zernio-sdk/models/business_agent_connector_tool.rb +284 -0
- data/lib/zernio-sdk/models/business_agent_connector_tool_input.rb +251 -0
- data/lib/zernio-sdk/models/business_agent_event_status.rb +284 -0
- data/lib/zernio-sdk/models/business_agent_faq.rb +264 -0
- data/lib/zernio-sdk/models/business_agent_faq_input.rb +221 -0
- data/lib/zernio-sdk/models/business_agent_knowledge_file.rb +190 -0
- data/lib/zernio-sdk/models/business_agent_o_auth_client_credentials.rb +236 -0
- data/lib/zernio-sdk/models/business_agent_settings.rb +292 -0
- data/lib/zernio-sdk/models/business_agent_settings_followup.rb +199 -0
- data/lib/zernio-sdk/models/business_agent_settings_handoff.rb +200 -0
- data/lib/zernio-sdk/models/business_agent_settings_rollout.rb +165 -0
- data/lib/zernio-sdk/models/business_agent_skill.rb +339 -0
- data/lib/zernio-sdk/models/business_agent_skill_input.rb +243 -0
- data/lib/zernio-sdk/models/business_agent_status.rb +315 -0
- data/lib/zernio-sdk/models/business_agent_status_manual_steps_inner.rb +240 -0
- data/lib/zernio-sdk/models/business_agent_status_unverified_steps_inner.rb +240 -0
- data/lib/zernio-sdk/models/business_agent_test_message_response.rb +267 -0
- data/lib/zernio-sdk/models/business_agent_ui_skill.rb +315 -0
- data/lib/zernio-sdk/models/business_agent_ui_skill_input.rb +262 -0
- data/lib/zernio-sdk/models/business_agent_website.rb +302 -0
- data/lib/zernio-sdk/models/business_agent_website_input.rb +221 -0
- data/lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb +3 -4
- data/lib/zernio-sdk/models/get_business_agent_budget200_response.rb +166 -0
- data/lib/zernio-sdk/models/get_business_agent_connector_logs200_response.rb +160 -0
- data/lib/zernio-sdk/models/inline_object.rb +24 -7
- data/lib/zernio-sdk/models/inline_object2.rb +4 -69
- data/lib/zernio-sdk/models/inline_object3.rb +18 -80
- data/lib/zernio-sdk/models/inline_object4.rb +274 -0
- data/lib/zernio-sdk/models/{inline_object3_details.rb → inline_object4_details.rb} +3 -3
- data/lib/zernio-sdk/models/list_business_agent_allowlist200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_connector_tools200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_connectors200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_faqs200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_files200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_settings200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_skills200_response.rb +166 -0
- data/lib/zernio-sdk/models/list_business_agent_ui_skills200_response.rb +177 -0
- data/lib/zernio-sdk/models/list_business_agent_websites200_response.rb +166 -0
- data/lib/zernio-sdk/models/onboard_business_agent201_response.rb +164 -0
- data/lib/zernio-sdk/models/run_business_agent_connector_tool200_response.rb +156 -0
- data/lib/zernio-sdk/models/run_business_agent_connector_tool_request.rb +165 -0
- data/lib/zernio-sdk/models/send_business_agent_event202_response.rb +173 -0
- data/lib/zernio-sdk/models/send_business_agent_event_request.rb +271 -0
- data/lib/zernio-sdk/models/send_business_agent_test_message_request.rb +182 -0
- data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request.rb +105 -0
- data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request_one_of.rb +214 -0
- data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request_one_of1.rb +214 -0
- data/lib/zernio-sdk/models/set_business_agent_connector_credentials_request_one_of2.rb +252 -0
- data/lib/zernio-sdk/models/{get_whats_app_sdk_config200_response.rb → start_business_agent_eval_run202_response.rb} +34 -63
- data/lib/zernio-sdk/models/start_business_agent_eval_run_request.rb +184 -0
- data/lib/zernio-sdk/models/update_business_agent_settings_request.rb +220 -0
- data/lib/zernio-sdk/models/update_business_agent_settings_request_followup.rb +235 -0
- data/lib/zernio-sdk/models/update_business_agent_settings_request_handoff.rb +235 -0
- data/lib/zernio-sdk/models/update_business_agent_settings_request_rollout.rb +164 -0
- data/lib/zernio-sdk/models/upload_business_agent_file_request.rb +175 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +64 -2
- data/openapi.yaml +1718 -55
- data/spec/api/business_agent_api_spec.rb +736 -0
- data/spec/api/connect_api_spec.rb +1 -12
- data/spec/api/messages_api_spec.rb +1 -1
- data/spec/models/add_business_agent_allowlist_entry_request_spec.rb +36 -0
- data/spec/models/business_agent_allowlist_entry_spec.rb +42 -0
- data/spec/models/{get_whats_app_sdk_config200_response_spec.rb → business_agent_api_key_config_spec.rb} +9 -9
- data/spec/models/business_agent_api_key_params_inner_spec.rb +48 -0
- data/spec/models/business_agent_budget_spec.rb +62 -0
- data/spec/models/business_agent_business_information_contact_info_spec.rb +48 -0
- data/spec/models/business_agent_business_information_spec.rb +66 -0
- data/spec/models/business_agent_connector_all_of_connection_status_spec.rb +42 -0
- data/spec/models/business_agent_connector_input_auth_config_spec.rb +42 -0
- data/spec/models/business_agent_connector_input_spec.rb +82 -0
- data/spec/models/business_agent_connector_input_user_auth_injection_config_spec.rb +48 -0
- data/spec/models/business_agent_connector_spec.rb +106 -0
- data/spec/models/business_agent_connector_tool_input_spec.rb +66 -0
- data/spec/models/business_agent_connector_tool_spec.rb +72 -0
- data/spec/models/business_agent_event_status_spec.rb +70 -0
- data/spec/models/business_agent_faq_input_spec.rb +48 -0
- data/spec/models/business_agent_faq_spec.rb +60 -0
- data/spec/models/business_agent_knowledge_file_spec.rb +42 -0
- data/spec/models/business_agent_o_auth_client_credentials_spec.rb +60 -0
- data/spec/models/business_agent_settings_followup_spec.rb +52 -0
- data/spec/models/business_agent_settings_handoff_spec.rb +52 -0
- data/spec/models/business_agent_settings_rollout_spec.rb +36 -0
- data/spec/models/business_agent_settings_spec.rb +76 -0
- data/spec/models/business_agent_skill_input_spec.rb +48 -0
- data/spec/models/business_agent_skill_spec.rb +76 -0
- data/spec/models/business_agent_status_manual_steps_inner_spec.rb +52 -0
- data/spec/models/business_agent_status_spec.rb +78 -0
- data/spec/models/business_agent_status_unverified_steps_inner_spec.rb +52 -0
- data/spec/models/business_agent_test_message_response_spec.rb +78 -0
- data/spec/models/business_agent_ui_skill_input_spec.rb +68 -0
- data/spec/models/business_agent_ui_skill_spec.rb +86 -0
- data/spec/models/business_agent_website_input_spec.rb +66 -0
- data/spec/models/business_agent_website_spec.rb +102 -0
- data/spec/models/get_business_agent_budget200_response_spec.rb +36 -0
- data/spec/models/get_business_agent_connector_logs200_response_spec.rb +42 -0
- data/spec/models/inline_object2_spec.rb +0 -20
- data/spec/models/inline_object3_spec.rb +4 -22
- data/spec/models/{inline_object3_details_spec.rb → inline_object4_details_spec.rb} +6 -6
- data/spec/models/inline_object4_spec.rb +74 -0
- data/spec/models/inline_object_spec.rb +1 -1
- data/spec/models/list_business_agent_allowlist200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_connector_tools200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_connectors200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_faqs200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_files200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_settings200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_skills200_response_spec.rb +36 -0
- data/spec/models/list_business_agent_ui_skills200_response_spec.rb +42 -0
- data/spec/models/list_business_agent_websites200_response_spec.rb +36 -0
- data/spec/models/onboard_business_agent201_response_spec.rb +36 -0
- data/spec/models/run_business_agent_connector_tool200_response_spec.rb +42 -0
- data/spec/models/run_business_agent_connector_tool_request_spec.rb +36 -0
- data/spec/models/send_business_agent_event202_response_spec.rb +42 -0
- data/spec/models/send_business_agent_event_request_spec.rb +54 -0
- data/spec/models/send_business_agent_test_message_request_spec.rb +42 -0
- data/spec/models/set_business_agent_connector_credentials_request_one_of1_spec.rb +46 -0
- data/spec/models/set_business_agent_connector_credentials_request_one_of2_spec.rb +58 -0
- data/spec/models/set_business_agent_connector_credentials_request_one_of_spec.rb +46 -0
- data/spec/models/set_business_agent_connector_credentials_request_spec.rb +32 -0
- data/spec/models/start_business_agent_eval_run202_response_spec.rb +42 -0
- data/spec/models/start_business_agent_eval_run_request_spec.rb +36 -0
- data/spec/models/update_business_agent_settings_request_followup_spec.rb +52 -0
- data/spec/models/update_business_agent_settings_request_handoff_spec.rb +52 -0
- data/spec/models/update_business_agent_settings_request_rollout_spec.rb +36 -0
- data/spec/models/update_business_agent_settings_request_spec.rb +64 -0
- data/spec/models/upload_business_agent_file_request_spec.rb +42 -0
- data/zernio-sdk-0.0.877.gem +0 -0
- metadata +258 -10
- data/docs/GetWhatsAppSdkConfig200Response.md +0 -22
- data/zernio-sdk-0.0.875.gem +0 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zernio::BusinessAgentTestMessageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message_id** | **String** | | |
|
|
8
|
+
| **agent_response** | **String** | | |
|
|
9
|
+
| **conversation_id** | **String** | Pass it back as conversationId to continue the thread. | |
|
|
10
|
+
| **timestamp** | **Integer** | Unix seconds. | [optional] |
|
|
11
|
+
| **handoff_reason** | **String** | | [optional] |
|
|
12
|
+
| **no_response_reason** | **String** | | [optional] |
|
|
13
|
+
| **quick_replies** | **Array<String>** | | [optional] |
|
|
14
|
+
| **product_variant_ids** | **Array<String>** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zernio-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Zernio::BusinessAgentTestMessageResponse.new(
|
|
22
|
+
message_id: null,
|
|
23
|
+
agent_response: null,
|
|
24
|
+
conversation_id: null,
|
|
25
|
+
timestamp: null,
|
|
26
|
+
handoff_reason: null,
|
|
27
|
+
no_response_reason: null,
|
|
28
|
+
quick_replies: null,
|
|
29
|
+
product_variant_ids: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zernio::BusinessAgentUiSkill
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **component_type** | **String** | | |
|
|
9
|
+
| **status** | **String** | | |
|
|
10
|
+
| **instruction** | **String** | When to send the component and everything needed to fill its fields. | |
|
|
11
|
+
| **flow_id** | **Integer** | Required for component_type flow, rejected otherwise. | [optional] |
|
|
12
|
+
| **id** | **String** | | |
|
|
13
|
+
| **created_at** | **Integer** | Unix seconds. | [optional] |
|
|
14
|
+
| **updated_at** | **Integer** | Unix seconds. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zernio-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Zernio::BusinessAgentUiSkill.new(
|
|
22
|
+
title: null,
|
|
23
|
+
component_type: null,
|
|
24
|
+
status: null,
|
|
25
|
+
instruction: null,
|
|
26
|
+
flow_id: null,
|
|
27
|
+
id: null,
|
|
28
|
+
created_at: null,
|
|
29
|
+
updated_at: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zernio::BusinessAgentUiSkillInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **component_type** | **String** | | |
|
|
9
|
+
| **status** | **String** | | |
|
|
10
|
+
| **instruction** | **String** | When to send the component and everything needed to fill its fields. | |
|
|
11
|
+
| **flow_id** | **Integer** | Required for component_type flow, rejected otherwise. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zernio-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Zernio::BusinessAgentUiSkillInput.new(
|
|
19
|
+
title: null,
|
|
20
|
+
component_type: null,
|
|
21
|
+
status: null,
|
|
22
|
+
instruction: null,
|
|
23
|
+
flow_id: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Zernio::BusinessAgentWebsite
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | | |
|
|
8
|
+
| **included_sub_domains** | **Array<String>** | | [optional] |
|
|
9
|
+
| **included_url_patterns** | **Array<String>** | Only URLs containing one of these substrings are ingested. | [optional] |
|
|
10
|
+
| **excluded_sub_domains** | **Array<String>** | | [optional] |
|
|
11
|
+
| **excluded_url_patterns** | **Array<String>** | | [optional] |
|
|
12
|
+
| **single_urls** | **Array<String>** | Crawl only these exact pages instead of the whole site. | [optional] |
|
|
13
|
+
| **id** | **String** | | |
|
|
14
|
+
| **crawl_status** | **String** | not_started, pending, in_progress, completed, completed_no_data or failed (see crawl_error). | [optional] |
|
|
15
|
+
| **crawl_error** | **String** | | [optional] |
|
|
16
|
+
| **pages_crawled** | **Integer** | | [optional] |
|
|
17
|
+
| **last_crawled_at** | **Integer** | Unix seconds. | [optional] |
|
|
18
|
+
| **created_at** | **Integer** | Unix seconds. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'zernio-sdk'
|
|
24
|
+
|
|
25
|
+
instance = Zernio::BusinessAgentWebsite.new(
|
|
26
|
+
url: null,
|
|
27
|
+
included_sub_domains: null,
|
|
28
|
+
included_url_patterns: null,
|
|
29
|
+
excluded_sub_domains: null,
|
|
30
|
+
excluded_url_patterns: null,
|
|
31
|
+
single_urls: null,
|
|
32
|
+
id: null,
|
|
33
|
+
crawl_status: null,
|
|
34
|
+
crawl_error: null,
|
|
35
|
+
pages_crawled: null,
|
|
36
|
+
last_crawled_at: null,
|
|
37
|
+
created_at: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zernio::BusinessAgentWebsiteInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | | |
|
|
8
|
+
| **included_sub_domains** | **Array<String>** | | [optional] |
|
|
9
|
+
| **included_url_patterns** | **Array<String>** | Only URLs containing one of these substrings are ingested. | [optional] |
|
|
10
|
+
| **excluded_sub_domains** | **Array<String>** | | [optional] |
|
|
11
|
+
| **excluded_url_patterns** | **Array<String>** | | [optional] |
|
|
12
|
+
| **single_urls** | **Array<String>** | Crawl only these exact pages instead of the whole site. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zernio-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Zernio::BusinessAgentWebsiteInput.new(
|
|
20
|
+
url: null,
|
|
21
|
+
included_sub_domains: null,
|
|
22
|
+
included_url_patterns: null,
|
|
23
|
+
excluded_sub_domains: null,
|
|
24
|
+
excluded_url_patterns: null,
|
|
25
|
+
single_urls: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/ConnectApi.md
CHANGED
|
@@ -28,7 +28,6 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
28
28
|
| [**get_shopify_connect_url**](ConnectApi.md#get_shopify_connect_url) | **GET** /v1/connect/shopify | Get Shopify OAuth connect URL |
|
|
29
29
|
| [**get_subreddit_rules**](ConnectApi.md#get_subreddit_rules) | **GET** /v1/accounts/{accountId}/reddit-subreddits/{subreddit}/rules | Get subreddit rules |
|
|
30
30
|
| [**get_telegram_connect_status**](ConnectApi.md#get_telegram_connect_status) | **GET** /v1/connect/telegram | Generate Telegram code |
|
|
31
|
-
| [**get_whats_app_sdk_config**](ConnectApi.md#get_whats_app_sdk_config) | **GET** /v1/connect/whatsapp/sdk-config | Get Embedded Signup SDK config |
|
|
32
31
|
| [**get_youtube_captions**](ConnectApi.md#get_youtube_captions) | **GET** /v1/accounts/{accountId}/youtube-captions | Get a YouTube video transcript |
|
|
33
32
|
| [**get_youtube_playlists**](ConnectApi.md#get_youtube_playlists) | **GET** /v1/accounts/{accountId}/youtube-playlists | List YouTube playlists |
|
|
34
33
|
| [**handle_o_auth_callback**](ConnectApi.md#handle_o_auth_callback) | **POST** /v1/connect/{platform} | Complete OAuth callback |
|
|
@@ -842,7 +841,7 @@ end
|
|
|
842
841
|
|
|
843
842
|
Connect WhatsApp from Embedded Signup
|
|
844
843
|
|
|
845
|
-
|
|
844
|
+
Exchange the authorization code Meta Embedded Signup returns to your browser SDK. This is the headless completion path for WhatsApp: the code never passes through a redirect_uri, so POST /v1/connect/{platform} cannot accept it.
|
|
846
845
|
|
|
847
846
|
### Examples
|
|
848
847
|
|
|
@@ -1768,72 +1767,6 @@ end
|
|
|
1768
1767
|
- **Accept**: application/json
|
|
1769
1768
|
|
|
1770
1769
|
|
|
1771
|
-
## get_whats_app_sdk_config
|
|
1772
|
-
|
|
1773
|
-
> <GetWhatsAppSdkConfig200Response> get_whats_app_sdk_config
|
|
1774
|
-
|
|
1775
|
-
Get Embedded Signup SDK config
|
|
1776
|
-
|
|
1777
|
-
The public values needed to run Meta's Embedded Signup inside your own page with the Facebook JavaScript SDK instead of the redirect flow: pass `appId` and `graphApiVersion` to `FB.init`, and `configId` as `config_id` to `FB.login`. The popup then reports the WhatsApp Business Account and phone number the user picked through the `WA_EMBEDDED_SIGNUP` message event, and you finish the connection with `POST /v1/connect/whatsapp/embedded-signup`. Because the number comes back from the popup, the user never sees a second number picker. Available on request: `FB.login` only opens on HTTPS domains listed in the Zernio Meta app, so send the domains that will host the popup to support before going live.
|
|
1778
|
-
|
|
1779
|
-
### Examples
|
|
1780
|
-
|
|
1781
|
-
```ruby
|
|
1782
|
-
require 'time'
|
|
1783
|
-
require 'zernio-sdk'
|
|
1784
|
-
# setup authorization
|
|
1785
|
-
Zernio.configure do |config|
|
|
1786
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
1787
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1788
|
-
end
|
|
1789
|
-
|
|
1790
|
-
api_instance = Zernio::ConnectApi.new
|
|
1791
|
-
|
|
1792
|
-
begin
|
|
1793
|
-
# Get Embedded Signup SDK config
|
|
1794
|
-
result = api_instance.get_whats_app_sdk_config
|
|
1795
|
-
p result
|
|
1796
|
-
rescue Zernio::ApiError => e
|
|
1797
|
-
puts "Error when calling ConnectApi->get_whats_app_sdk_config: #{e}"
|
|
1798
|
-
end
|
|
1799
|
-
```
|
|
1800
|
-
|
|
1801
|
-
#### Using the get_whats_app_sdk_config_with_http_info variant
|
|
1802
|
-
|
|
1803
|
-
This returns an Array which contains the response data, status code and headers.
|
|
1804
|
-
|
|
1805
|
-
> <Array(<GetWhatsAppSdkConfig200Response>, Integer, Hash)> get_whats_app_sdk_config_with_http_info
|
|
1806
|
-
|
|
1807
|
-
```ruby
|
|
1808
|
-
begin
|
|
1809
|
-
# Get Embedded Signup SDK config
|
|
1810
|
-
data, status_code, headers = api_instance.get_whats_app_sdk_config_with_http_info
|
|
1811
|
-
p status_code # => 2xx
|
|
1812
|
-
p headers # => { ... }
|
|
1813
|
-
p data # => <GetWhatsAppSdkConfig200Response>
|
|
1814
|
-
rescue Zernio::ApiError => e
|
|
1815
|
-
puts "Error when calling ConnectApi->get_whats_app_sdk_config_with_http_info: #{e}"
|
|
1816
|
-
end
|
|
1817
|
-
```
|
|
1818
|
-
|
|
1819
|
-
### Parameters
|
|
1820
|
-
|
|
1821
|
-
This endpoint does not need any parameter.
|
|
1822
|
-
|
|
1823
|
-
### Return type
|
|
1824
|
-
|
|
1825
|
-
[**GetWhatsAppSdkConfig200Response**](GetWhatsAppSdkConfig200Response.md)
|
|
1826
|
-
|
|
1827
|
-
### Authorization
|
|
1828
|
-
|
|
1829
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
1830
|
-
|
|
1831
|
-
### HTTP request headers
|
|
1832
|
-
|
|
1833
|
-
- **Content-Type**: Not defined
|
|
1834
|
-
- **Accept**: application/json
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
1770
|
## get_youtube_captions
|
|
1838
1771
|
|
|
1839
1772
|
> <GetYoutubeCaptions200Response> get_youtube_captions(account_id, video_id, opts)
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **code** | **String** | Authorization code from the
|
|
7
|
+
| **code** | **String** | Authorization code from the WA_EMBEDDED_SIGNUP postMessage | |
|
|
8
8
|
| **profile_id** | **String** | | |
|
|
9
|
-
| **waba_id** | **String** |
|
|
10
|
-
| **phone_number_id** | **String** |
|
|
11
|
-
| **is_coexistence** | **Boolean** |
|
|
9
|
+
| **waba_id** | **String** | WhatsApp Business Account id, when the SDK reported one | [optional] |
|
|
10
|
+
| **phone_number_id** | **String** | | [optional] |
|
|
11
|
+
| **is_coexistence** | **Boolean** | Number is also live in the WhatsApp Business app | [optional] |
|
|
12
12
|
| **expected_phone_number** | **String** | Rejects the connect when Meta returns a different number | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::GetBusinessAgentBudget200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **budgets** | [**Array<BusinessAgentBudget>**](BusinessAgentBudget.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::GetBusinessAgentBudget200Response.new(
|
|
15
|
+
budgets: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::GetBusinessAgentConnectorLogs200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | **Array<Hash<String, Object>>** | | [optional] |
|
|
8
|
+
| **stats** | **Hash<String, Object>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::GetBusinessAgentConnectorLogs200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
stats: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/InlineObject.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
require 'zernio-sdk'
|
|
13
13
|
|
|
14
14
|
instance = Zernio::InlineObject.new(
|
|
15
|
-
|
|
15
|
+
success: null
|
|
16
16
|
)
|
|
17
17
|
```
|
|
18
18
|
|
data/docs/InlineObject1.md
CHANGED
data/docs/InlineObject2.md
CHANGED
|
@@ -5,8 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **error** | **String** | | [optional] |
|
|
8
|
-
| **code** | **String** | | [optional] |
|
|
9
|
-
| **required_group** | **String** | The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials. | [optional] |
|
|
10
8
|
|
|
11
9
|
## Example
|
|
12
10
|
|
|
@@ -14,9 +12,7 @@
|
|
|
14
12
|
require 'zernio-sdk'
|
|
15
13
|
|
|
16
14
|
instance = Zernio::InlineObject2.new(
|
|
17
|
-
error:
|
|
18
|
-
code: null,
|
|
19
|
-
required_group: null
|
|
15
|
+
error: Not found
|
|
20
16
|
)
|
|
21
17
|
```
|
|
22
18
|
|
data/docs/InlineObject3.md
CHANGED
|
@@ -4,12 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **error** | **String** |
|
|
8
|
-
| **code** | **String** |
|
|
9
|
-
| **
|
|
10
|
-
| **documentation_url** | **String** | Link to the relevant documentation page. | [optional] |
|
|
11
|
-
| **dashboard_url** | **String** | Deep-link to send the end-user to. For `free_tier_exceeded` and `twitter_passthrough` this is the Zernio billing tab. For `enterprise_required` this is the Zernio enterprise contact page. | [optional] |
|
|
12
|
-
| **details** | [**InlineObject3Details**](InlineObject3Details.md) | | [optional] |
|
|
7
|
+
| **error** | **String** | | [optional] |
|
|
8
|
+
| **code** | **String** | | [optional] |
|
|
9
|
+
| **required_group** | **String** | The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials. | [optional] |
|
|
13
10
|
|
|
14
11
|
## Example
|
|
15
12
|
|
|
@@ -17,12 +14,9 @@
|
|
|
17
14
|
require 'zernio-sdk'
|
|
18
15
|
|
|
19
16
|
instance = Zernio::InlineObject3.new(
|
|
20
|
-
error:
|
|
17
|
+
error: This API key has the 'messages' resource group disabled. GET /api/v1/inbox/conversations requires it. Create a key with 'messages' enabled in the dashboard API keys tab.,
|
|
21
18
|
code: null,
|
|
22
|
-
|
|
23
|
-
documentation_url: https://docs.zernio.com/billing/payment-method-required,
|
|
24
|
-
dashboard_url: https://zernio.com/dashboard?tab=billing,
|
|
25
|
-
details: null
|
|
19
|
+
required_group: null
|
|
26
20
|
)
|
|
27
21
|
```
|
|
28
22
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zernio::InlineObject4
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | **String** | Human-readable error message suitable for end-user display. | |
|
|
8
|
+
| **code** | **String** | Machine-readable error code. Stable across versions. | |
|
|
9
|
+
| **reason** | **String** | Discriminator for which gate fired. | |
|
|
10
|
+
| **documentation_url** | **String** | Link to the relevant documentation page. | [optional] |
|
|
11
|
+
| **dashboard_url** | **String** | Deep-link to send the end-user to. For `free_tier_exceeded` and `twitter_passthrough` this is the Zernio billing tab. For `enterprise_required` this is the Zernio enterprise contact page. | [optional] |
|
|
12
|
+
| **details** | [**InlineObject4Details**](InlineObject4Details.md) | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zernio-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Zernio::InlineObject4.new(
|
|
20
|
+
error: X (Twitter) requires a payment method due to API pass-through costs. Add a payment method to connect an X account.,
|
|
21
|
+
code: null,
|
|
22
|
+
reason: null,
|
|
23
|
+
documentation_url: https://docs.zernio.com/billing/payment-method-required,
|
|
24
|
+
dashboard_url: https://zernio.com/dashboard?tab=billing,
|
|
25
|
+
details: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::InlineObject4Details
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'zernio-sdk'
|
|
16
16
|
|
|
17
|
-
instance = Zernio::
|
|
17
|
+
instance = Zernio::InlineObject4Details.new(
|
|
18
18
|
free_tier_account_limit: 2,
|
|
19
19
|
current_account_count: 5,
|
|
20
20
|
has_payment_method: null,
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentAllowlist200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **entries** | [**Array<BusinessAgentAllowlistEntry>**](BusinessAgentAllowlistEntry.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentAllowlist200Response.new(
|
|
15
|
+
entries: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentConnectorTools200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **tools** | [**Array<BusinessAgentConnectorTool>**](BusinessAgentConnectorTool.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentConnectorTools200Response.new(
|
|
15
|
+
tools: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentConnectors200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **connectors** | [**Array<BusinessAgentConnector>**](BusinessAgentConnector.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentConnectors200Response.new(
|
|
15
|
+
connectors: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentFaqs200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **faqs** | [**Array<BusinessAgentFaq>**](BusinessAgentFaq.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentFaqs200Response.new(
|
|
15
|
+
faqs: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentFiles200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **files** | [**Array<BusinessAgentKnowledgeFile>**](BusinessAgentKnowledgeFile.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentFiles200Response.new(
|
|
15
|
+
files: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentSettings200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **settings** | [**Array<BusinessAgentSettings>**](BusinessAgentSettings.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentSettings200Response.new(
|
|
15
|
+
settings: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentSkills200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **skills** | [**Array<BusinessAgentSkill>**](BusinessAgentSkill.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentSkills200Response.new(
|
|
15
|
+
skills: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentUiSkills200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ui_skills** | [**Array<BusinessAgentUiSkill>**](BusinessAgentUiSkill.md) | | |
|
|
8
|
+
| **paging** | **Hash<String, Object>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListBusinessAgentUiSkills200Response.new(
|
|
16
|
+
ui_skills: null,
|
|
17
|
+
paging: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::ListBusinessAgentWebsites200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **websites** | [**Array<BusinessAgentWebsite>**](BusinessAgentWebsite.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::ListBusinessAgentWebsites200Response.new(
|
|
15
|
+
websites: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/MessagesApi.md
CHANGED
|
@@ -1001,7 +1001,7 @@ end
|
|
|
1001
1001
|
|
|
1002
1002
|
Hand a conversation to or from Meta Business Agent
|
|
1003
1003
|
|
|
1004
|
-
WhatsApp only, on numbers with Meta Business Agent enabled. Wraps Meta's thread control: - `release`: hand the conversation back to the agent so it resumes answering. You must currently hold control (sending any message takes it implicitly). - `take`: take control before sending anything, so the agent stops replying while an operator reads the thread. Meta accepts this only from the business configured as the number's escalation partner; other apps take control by sending a message. - `pass`: transfer control to the number's configured escalation partner, or to the agent with `target: ai_agent`. The conversation's `threadControl` follows the result; a `conversation.control_changed` webhook fires when Meta later reports the change.
|
|
1004
|
+
WhatsApp only, on numbers with Meta Business Agent enabled. Wraps Meta's thread control: - `release`: hand the conversation back to the agent so it resumes answering. You must currently hold control (sending any message takes it implicitly). - `take`: take control before sending anything, so the agent stops replying while an operator reads the thread. Meta accepts this only from the business configured as the number's escalation partner; other apps take control by sending a message. - `pass`: transfer control to the number's configured escalation partner, or to the agent with `target: ai_agent`. Meta's Cloud API currently rejects it (\"Pass action is not supported\", verified 2026-09-08); use `release` to hand a thread back to the agent. The conversation's `threadControl` follows the result; a `conversation.control_changed` webhook fires when Meta later reports the change.
|
|
1005
1005
|
|
|
1006
1006
|
### Examples
|
|
1007
1007
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::OnboardBusinessAgent201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **agent_id** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::OnboardBusinessAgent201Response.new(
|
|
15
|
+
agent_id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::RunBusinessAgentConnectorTool200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **output** | **String** | | [optional] |
|
|
8
|
+
| **status** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::RunBusinessAgentConnectorTool200Response.new(
|
|
16
|
+
output: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|