sunshine-conversations-client 9.5.6 → 9.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG_RB.md +21 -0
- data/README.md +9 -5
- data/docs/Content.md +2 -0
- data/docs/Instagram.md +1 -1
- data/docs/InstagramAllOf.md +1 -1
- data/docs/Messenger.md +6 -2
- data/docs/MessengerAllOf.md +6 -2
- data/docs/SwitchboardActionsApi.md +61 -0
- data/docs/TextMessage.md +3 -1
- data/docs/UserUpdateEvent.md +23 -0
- data/docs/UserUpdateEventAllOf.md +17 -0
- data/docs/UserUpdateEventAllOfPayload.md +21 -0
- data/lib/sunshine-conversations-client/api/activities_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/app_keys_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/apps_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/attachments_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/clients_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/conversations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/integrations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/messages_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/participants_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +69 -1
- data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboards_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/users_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/webhooks_api.rb +1 -1
- data/lib/sunshine-conversations-client/api_client.rb +1 -1
- data/lib/sunshine-conversations-client/api_error.rb +1 -1
- data/lib/sunshine-conversations-client/configuration.rb +1 -1
- data/lib/sunshine-conversations-client/models/accept_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/action.rb +1 -1
- data/lib/sunshine-conversations-client/models/action_subset.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_post.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_post_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_types.rb +1 -1
- data/lib/sunshine-conversations-client/models/android.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/api_key.rb +1 -1
- data/lib/sunshine-conversations-client/models/app.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_list_filter.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_settings.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_delete_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_media_token_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_media_token_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_upload_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/author.rb +1 -1
- data/lib/sunshine-conversations-client/models/author_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/buy.rb +1 -1
- data/lib/sunshine-conversations-client/models/carousel_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/carousel_message_display_settings.rb +1 -1
- data/lib/sunshine-conversations-client/models/client.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_add_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_add_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_add_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_association.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_create.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_remove_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_remove_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_remove_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_type.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_update_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_update_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_update_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/confirmation.rb +1 -1
- data/lib/sunshine-conversations-client/models/content.rb +12 -2
- data/lib/sunshine-conversations-client/models/conversation.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_join_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_join_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_join_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_leave_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_list_filter.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_destination.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_external_messages.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_user_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_postback_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_read_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_remove_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_truncated.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_type.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_typing_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/custom.rb +1 -1
- data/lib/sunshine-conversations-client/models/custom_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/custom_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/destination.rb +1 -1
- data/lib/sunshine-conversations-client/models/device.rb +1 -1
- data/lib/sunshine-conversations-client/models/event_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/extra_channel_options.rb +1 -1
- data/lib/sunshine-conversations-client/models/extra_channel_options_messenger.rb +1 -1
- data/lib/sunshine-conversations-client/models/field.rb +1 -1
- data/lib/sunshine-conversations-client/models/file_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/image_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/inline_object.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram.rb +2 -2
- data/lib/sunshine-conversations-client/models/instagram_all_of.rb +2 -2
- data/lib/sunshine-conversations-client/models/instagram_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_api_key.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_api_key_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_api_key_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_list_filter.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_type.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_update_base.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/item.rb +1 -1
- data/lib/sunshine-conversations-client/models/line.rb +1 -1
- data/lib/sunshine-conversations-client/models/line_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/line_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/link.rb +1 -1
- data/lib/sunshine-conversations-client/models/links.rb +1 -1
- data/lib/sunshine-conversations-client/models/list_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_message_coordinates.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_message_location.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_request.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_base.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_twilio.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_twilio_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/message.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_bird_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_apple.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_line.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_messenger.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_post.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_post_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/messagebird.rb +1 -1
- data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/messenger.rb +26 -6
- data/lib/sunshine-conversations-client/models/messenger_all_of.rb +26 -6
- data/lib/sunshine-conversations-client/models/messenger_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/meta.rb +1 -1
- data/lib/sunshine-conversations-client/models/offer_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/page.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_join_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/pass_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/postback.rb +1 -1
- data/lib/sunshine-conversations-client/models/postback_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/prechat_capture.rb +1 -1
- data/lib/sunshine-conversations-client/models/profile.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/referral.rb +1 -1
- data/lib/sunshine-conversations-client/models/referral_details.rb +1 -1
- data/lib/sunshine-conversations-client/models/reply.rb +1 -1
- data/lib/sunshine-conversations-client/models/source.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/status.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/target.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/template_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/text_message.rb +15 -5
- data/lib/sunshine-conversations-client/models/twilio.rb +1 -1
- data/lib/sunshine-conversations-client/models/twilio_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/twilio_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/twitter.rb +1 -1
- data/lib/sunshine-conversations-client/models/twitter_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/twitter_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/user.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_clients.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_conversations.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_users.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_truncated.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/user_update_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/user_update_event_all_of_payload.rb +259 -0
- data/lib/sunshine-conversations-client/models/viber.rb +1 -1
- data/lib/sunshine-conversations-client/models/viber_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/viber_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/web.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/webview.rb +1 -1
- data/lib/sunshine-conversations-client/models/whats_app_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/whatsapp_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/version.rb +2 -2
- data/lib/sunshine-conversations-client.rb +4 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/sunshine-conversations-client.gemspec +1 -1
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 76db2ba92eafdc4ed548376b4192285f113ae36e
|
4
|
+
data.tar.gz: 882fd3faa9b0dd8a0ae5753359af755102dea01a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 45a8910ecb27c061c8e4c34b584c568bad634dd811b6f993ac73244f15b76e7f1f0a44231fb7b5a0836ec3488c4cbdef280c64763fb949376e950dfbc851acce
|
7
|
+
data.tar.gz: fa9d7ec01328cbeb0f786cd4a1a2e88f4d13e4d53d0bb99f02b7c26ff77ffc1c3183683f7ba90fba9b21afe052a1e9b1971ab27476338cb4a68fc2427f2eef9a
|
data/CHANGELOG_RB.md
CHANGED
@@ -1,5 +1,26 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [9.7.0] - 2022-05-05
|
4
|
+
|
5
|
+
### Added
|
6
|
+
|
7
|
+
- Added a `releaseControl` action endpoint to the Switchboard Actions API.
|
8
|
+
|
9
|
+
## [9.6.0] - 2022-03-23
|
10
|
+
|
11
|
+
### Added
|
12
|
+
|
13
|
+
- Added `user:update` event. This event currently fires when an anonymous user is converted to an authenticated user.
|
14
|
+
- Added missing `reason` in the `user:merge` webhook payload example.
|
15
|
+
|
16
|
+
## [9.5.7] - 2022-01-04
|
17
|
+
|
18
|
+
- Added missing pageId and pageName properties on Messenger integration.
|
19
|
+
|
20
|
+
## [9.5.6] - 2021-11-30
|
21
|
+
|
22
|
+
- Dependencies security update; Ruby wrapper not affected.
|
23
|
+
|
3
24
|
## [9.4.6] - 2021-09-28
|
4
25
|
|
5
26
|
- Added channel linking events
|
data/README.md
CHANGED
@@ -4,8 +4,8 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
|
|
4
4
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
|
6
6
|
|
7
|
-
- API version: 9.
|
8
|
-
- Package version: 9.
|
7
|
+
- API version: 9.7.0
|
8
|
+
- Package version: 9.7.0
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
10
10
|
|
11
11
|
## Sunshine Conversations API Version
|
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
|
|
32
32
|
Then either install the gem locally:
|
33
33
|
|
34
34
|
```shell
|
35
|
-
gem install ./sunshine-conversations-client-9.
|
35
|
+
gem install ./sunshine-conversations-client-9.7.0.gem
|
36
36
|
```
|
37
37
|
|
38
|
-
(for development, run `gem install --dev ./sunshine-conversations-client-9.
|
38
|
+
(for development, run `gem install --dev ./sunshine-conversations-client-9.7.0.gem` to install the development dependencies)
|
39
39
|
|
40
40
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
41
41
|
|
42
42
|
Finally add this to the Gemfile:
|
43
43
|
|
44
|
-
gem 'sunshine-conversations-client', '~> 9.
|
44
|
+
gem 'sunshine-conversations-client', '~> 9.7.0'
|
45
45
|
|
46
46
|
### Install from Git
|
47
47
|
|
@@ -175,6 +175,7 @@ Class | Method | HTTP request | Description
|
|
175
175
|
*SunshineConversationsClient::SwitchboardActionsApi* | [**accept_control**](docs/SwitchboardActionsApi.md#accept_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/acceptControl | Accept Control
|
176
176
|
*SunshineConversationsClient::SwitchboardActionsApi* | [**offer_control**](docs/SwitchboardActionsApi.md#offer_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/offerControl | Offer Control
|
177
177
|
*SunshineConversationsClient::SwitchboardActionsApi* | [**pass_control**](docs/SwitchboardActionsApi.md#pass_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/passControl | Pass Control
|
178
|
+
*SunshineConversationsClient::SwitchboardActionsApi* | [**release_control**](docs/SwitchboardActionsApi.md#release_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/releaseControl | Release Control
|
178
179
|
*SunshineConversationsClient::SwitchboardIntegrationsApi* | [**create_switchboard_integration**](docs/SwitchboardIntegrationsApi.md#create_switchboard_integration) | **POST** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations | Create Switchboard Integration
|
179
180
|
*SunshineConversationsClient::SwitchboardIntegrationsApi* | [**delete_switchboard_integration**](docs/SwitchboardIntegrationsApi.md#delete_switchboard_integration) | **DELETE** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId} | Delete Switchboard Integration
|
180
181
|
*SunshineConversationsClient::SwitchboardIntegrationsApi* | [**list_switchboard_integrations**](docs/SwitchboardIntegrationsApi.md#list_switchboard_integrations) | **GET** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations | List Switchboard Integrations
|
@@ -446,6 +447,9 @@ Class | Method | HTTP request | Description
|
|
446
447
|
- [SunshineConversationsClient::UserResponse](docs/UserResponse.md)
|
447
448
|
- [SunshineConversationsClient::UserTruncated](docs/UserTruncated.md)
|
448
449
|
- [SunshineConversationsClient::UserUpdateBody](docs/UserUpdateBody.md)
|
450
|
+
- [SunshineConversationsClient::UserUpdateEvent](docs/UserUpdateEvent.md)
|
451
|
+
- [SunshineConversationsClient::UserUpdateEventAllOf](docs/UserUpdateEventAllOf.md)
|
452
|
+
- [SunshineConversationsClient::UserUpdateEventAllOfPayload](docs/UserUpdateEventAllOfPayload.md)
|
449
453
|
- [SunshineConversationsClient::Viber](docs/Viber.md)
|
450
454
|
- [SunshineConversationsClient::ViberAllOf](docs/ViberAllOf.md)
|
451
455
|
- [SunshineConversationsClient::ViberUpdate](docs/ViberUpdate.md)
|
data/docs/Content.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**type** | **String** | The type of message. | [default to 'template']
|
8
8
|
**text** | **String** | The fallback text message used when location messages are not supported by the channel. | [optional] [readonly]
|
9
9
|
**actions** | [**Array<ActionSubset>**](ActionSubset.md) | An array of objects representing the actions associated with the message. The array length is limited by the third party channel. | [optional]
|
10
|
+
**payload** | **String** | The payload of a [reply button](https://docs.smooch.io/guide/structured-messages/#reply-buttons) response message. | [optional]
|
10
11
|
**items** | [**Array<Item>**](Item.md) | An array of objects representing the items associated with the message. Only present in carousel and list type messages. |
|
11
12
|
**display_settings** | [**CarouselMessageDisplaySettings**](CarouselMessageDisplaySettings.md) | | [optional]
|
12
13
|
**media_url** | **String** | The URL for media, such as an image, attached to the message. |
|
@@ -28,6 +29,7 @@ require 'SunshineConversationsClient'
|
|
28
29
|
instance = SunshineConversationsClient::Content.new(type: null,
|
29
30
|
text: null,
|
30
31
|
actions: null,
|
32
|
+
payload: null,
|
31
33
|
items: null,
|
32
34
|
display_settings: null,
|
33
35
|
media_url: null,
|
data/docs/Instagram.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Instagram Direct setup steps: - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](https://developer.facebook.com)); - The Facebook app must have been submitted to
|
7
|
+
**type** | **String** | Instagram Direct setup steps: - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](https://developer.facebook.com)); - The Facebook app must have been submitted to Meta for app review with the \"pages_manage_metadata\" (to retrieve Page Access Tokens for the Pages and apps that the app user administers and to set a webhook), \"instagram_basic\", and \"instagram_manage_messages\" (to retrieve basic Instagram account information and send messages) permissions. - In order to integrate an Instagram Direct app, you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token. | [optional] [default to 'instagram']
|
8
8
|
**page_access_token** | **String** | The Facebook Page Access Token of the Facebook page that is linked to your Instagram account. |
|
9
9
|
**app_id** | **String** | Your Facebook App ID. |
|
10
10
|
**app_secret** | **String** | Your Facebook App secret. |
|
data/docs/InstagramAllOf.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Instagram Direct setup steps: - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](https://developer.facebook.com)); - The Facebook app must have been submitted to
|
7
|
+
**type** | **String** | Instagram Direct setup steps: - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](https://developer.facebook.com)); - The Facebook app must have been submitted to Meta for app review with the \"pages_manage_metadata\" (to retrieve Page Access Tokens for the Pages and apps that the app user administers and to set a webhook), \"instagram_basic\", and \"instagram_manage_messages\" (to retrieve basic Instagram account information and send messages) permissions. - In order to integrate an Instagram Direct app, you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token. | [optional] [default to 'instagram']
|
8
8
|
**page_access_token** | **String** | The Facebook Page Access Token of the Facebook page that is linked to your Instagram account. |
|
9
9
|
**app_id** | **String** | Your Facebook App ID. |
|
10
10
|
**app_secret** | **String** | Your Facebook App secret. |
|
data/docs/Messenger.md
CHANGED
@@ -4,10 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to
|
7
|
+
**type** | **String** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to Meta for app review with the “pages_manage_metadata” (to retrieve Page Access Tokens for the Pages, apps that the app user administers and set a webhook) and “pages_messaging” (to send messages) permissions. - In order to integrate a Facebook Messenger app you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token. | [optional] [default to 'messenger']
|
8
8
|
**page_access_token** | **String** | A Facebook Page Access Token. |
|
9
9
|
**app_id** | **String** | A Facebook App ID. |
|
10
10
|
**app_secret** | **String** | A Facebook App Secret. |
|
11
|
+
**page_id** | **Float** | A Facebook page ID. | [optional]
|
12
|
+
**page_name** | **String** | A Facebook page name. | [optional]
|
11
13
|
|
12
14
|
## Code Sample
|
13
15
|
|
@@ -17,7 +19,9 @@ require 'SunshineConversationsClient'
|
|
17
19
|
instance = SunshineConversationsClient::Messenger.new(type: null,
|
18
20
|
page_access_token: your_access_token,
|
19
21
|
app_id: your_facebook_app_id,
|
20
|
-
app_secret: your_facebook_app_secret
|
22
|
+
app_secret: your_facebook_app_secret,
|
23
|
+
page_id: 123212323432123,
|
24
|
+
page_name: An Awesome Page)
|
21
25
|
```
|
22
26
|
|
23
27
|
|
data/docs/MessengerAllOf.md
CHANGED
@@ -4,10 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to
|
7
|
+
**type** | **String** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to Meta for app review with the “pages_manage_metadata” (to retrieve Page Access Tokens for the Pages, apps that the app user administers and set a webhook) and “pages_messaging” (to send messages) permissions. - In order to integrate a Facebook Messenger app you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token. | [optional] [default to 'messenger']
|
8
8
|
**page_access_token** | **String** | A Facebook Page Access Token. |
|
9
9
|
**app_id** | **String** | A Facebook App ID. |
|
10
10
|
**app_secret** | **String** | A Facebook App Secret. |
|
11
|
+
**page_id** | **Float** | A Facebook page ID. | [optional]
|
12
|
+
**page_name** | **String** | A Facebook page name. | [optional]
|
11
13
|
|
12
14
|
## Code Sample
|
13
15
|
|
@@ -17,7 +19,9 @@ require 'SunshineConversationsClient'
|
|
17
19
|
instance = SunshineConversationsClient::MessengerAllOf.new(type: null,
|
18
20
|
page_access_token: your_access_token,
|
19
21
|
app_id: your_facebook_app_id,
|
20
|
-
app_secret: your_facebook_app_secret
|
22
|
+
app_secret: your_facebook_app_secret,
|
23
|
+
page_id: 123212323432123,
|
24
|
+
page_name: An Awesome Page)
|
21
25
|
```
|
22
26
|
|
23
27
|
|
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**accept_control**](SwitchboardActionsApi.md#accept_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/acceptControl | Accept Control
|
8
8
|
[**offer_control**](SwitchboardActionsApi.md#offer_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/offerControl | Offer Control
|
9
9
|
[**pass_control**](SwitchboardActionsApi.md#pass_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/passControl | Pass Control
|
10
|
+
[**release_control**](SwitchboardActionsApi.md#release_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/releaseControl | Release Control
|
10
11
|
|
11
12
|
|
12
13
|
|
@@ -195,3 +196,63 @@ Name | Type | Description | Notes
|
|
195
196
|
- **Content-Type**: application/json
|
196
197
|
- **Accept**: application/json
|
197
198
|
|
199
|
+
|
200
|
+
## release_control
|
201
|
+
|
202
|
+
> Object release_control(app_id, conversation_id)
|
203
|
+
|
204
|
+
Release Control
|
205
|
+
|
206
|
+
The releaseControl action releases the control of the conversation by nullifying its switchboard state. When using integration auth scope, a 403 is returned if the active switchboard integration is not the authenticated integration.
|
207
|
+
|
208
|
+
### Example
|
209
|
+
|
210
|
+
```ruby
|
211
|
+
# load the gem
|
212
|
+
require 'sunshine-conversations-client'
|
213
|
+
# setup authorization
|
214
|
+
SunshineConversationsClient.configure do |config|
|
215
|
+
# Configure HTTP basic authorization: basicAuth
|
216
|
+
config.username = 'YOUR_USERNAME'
|
217
|
+
config.password = 'YOUR_PASSWORD'
|
218
|
+
|
219
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
220
|
+
# Uncomment this line to use JWTs
|
221
|
+
# config.access_token = 'YOUR_JWT'
|
222
|
+
end
|
223
|
+
|
224
|
+
api_instance = SunshineConversationsClient::SwitchboardActionsApi.new
|
225
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
226
|
+
conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
|
227
|
+
# Be sure to add the required body parameters
|
228
|
+
|
229
|
+
begin
|
230
|
+
#Release Control
|
231
|
+
result = api_instance.release_control(app_id, conversation_id)
|
232
|
+
p result
|
233
|
+
rescue SunshineConversationsClient::ApiError => e
|
234
|
+
puts "Exception when calling SwitchboardActionsApi->release_control: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
### Parameters
|
239
|
+
|
240
|
+
|
241
|
+
Name | Type | Description | Notes
|
242
|
+
------------- | ------------- | ------------- | -------------
|
243
|
+
**app_id** | **String**| Identifies the app. |
|
244
|
+
**conversation_id** | **String**| Identifies the conversation. |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
**Object**
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: Not defined
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
data/docs/TextMessage.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**type** | **String** | The type of message. | [default to 'text']
|
8
8
|
**text** | **String** | The text content of the message. Optional only if actions are provided. | [optional]
|
9
9
|
**actions** | [**Array<Action>**](Action.md) | Array of message actions. | [optional]
|
10
|
+
**payload** | **String** | The payload of a [reply button](https://docs.smooch.io/guide/structured-messages/#reply-buttons) response message. | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'SunshineConversationsClient'
|
|
15
16
|
|
16
17
|
instance = SunshineConversationsClient::TextMessage.new(type: null,
|
17
18
|
text: Hello!,
|
18
|
-
actions: null
|
19
|
+
actions: null,
|
20
|
+
payload: null)
|
19
21
|
```
|
20
22
|
|
21
23
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# SunshineConversationsClient::UserUpdateEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional]
|
8
|
+
**type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional]
|
9
|
+
**created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional]
|
10
|
+
**payload** | [**UserUpdateEventAllOfPayload**](UserUpdateEventAllOfPayload.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'SunshineConversationsClient'
|
16
|
+
|
17
|
+
instance = SunshineConversationsClient::UserUpdateEvent.new(id: null,
|
18
|
+
type: null,
|
19
|
+
created_at: null,
|
20
|
+
payload: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SunshineConversationsClient::UserUpdateEventAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**payload** | [**UserUpdateEventAllOfPayload**](UserUpdateEventAllOfPayload.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SunshineConversationsClient'
|
13
|
+
|
14
|
+
instance = SunshineConversationsClient::UserUpdateEventAllOf.new(payload: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# SunshineConversationsClient::UserUpdateEventAllOfPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**user** | [**User**](User.md) | The updated user. | [optional]
|
8
|
+
**reason** | **String** | The reason why the user was updated, if applicable. * `authentication` - An anonymous user became an [identified](https://docs.smooch.io/guide/intro-to-users/) user. | [optional]
|
9
|
+
**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the creation. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'SunshineConversationsClient'
|
15
|
+
|
16
|
+
instance = SunshineConversationsClient::UserUpdateEventAllOfPayload.new(user: null,
|
17
|
+
reason: null,
|
18
|
+
source: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Sunshine Conversations API
|
3
3
|
|
4
|
-
The version of the OpenAPI document: 9.
|
4
|
+
The version of the OpenAPI document: 9.7.0
|
5
5
|
|
6
6
|
Generated by: https://openapi-generator.tech
|
7
7
|
OpenAPI Generator version: 4.3.1
|
@@ -243,5 +243,73 @@ module SunshineConversationsClient
|
|
243
243
|
end
|
244
244
|
return data, status_code, headers
|
245
245
|
end
|
246
|
+
|
247
|
+
# Release Control
|
248
|
+
# The releaseControl action releases the control of the conversation by nullifying its switchboard state. When using integration auth scope, a 403 is returned if the active switchboard integration is not the authenticated integration.
|
249
|
+
# @param app_id [String] Identifies the app.
|
250
|
+
# @param conversation_id [String] Identifies the conversation.
|
251
|
+
# @param [Hash] opts the optional parameters
|
252
|
+
# @return [Object]
|
253
|
+
def release_control(app_id, conversation_id, opts = {})
|
254
|
+
data, _status_code, _headers = release_control_with_http_info(app_id, conversation_id, opts)
|
255
|
+
data
|
256
|
+
end
|
257
|
+
|
258
|
+
# Release Control
|
259
|
+
# The releaseControl action releases the control of the conversation by nullifying its switchboard state. When using integration auth scope, a 403 is returned if the active switchboard integration is not the authenticated integration.
|
260
|
+
# @param app_id [String] Identifies the app.
|
261
|
+
# @param conversation_id [String] Identifies the conversation.
|
262
|
+
# @param [Hash] opts the optional parameters
|
263
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
264
|
+
def release_control_with_http_info(app_id, conversation_id, opts = {})
|
265
|
+
if @api_client.config.debugging
|
266
|
+
@api_client.config.logger.debug 'Calling API: SwitchboardActionsApi.release_control ...'
|
267
|
+
end
|
268
|
+
# verify the required parameter 'app_id' is set
|
269
|
+
if @api_client.config.client_side_validation && app_id.nil?
|
270
|
+
fail ArgumentError, "Missing the required parameter 'app_id' when calling SwitchboardActionsApi.release_control"
|
271
|
+
end
|
272
|
+
# verify the required parameter 'conversation_id' is set
|
273
|
+
if @api_client.config.client_side_validation && conversation_id.nil?
|
274
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SwitchboardActionsApi.release_control"
|
275
|
+
end
|
276
|
+
# resource path
|
277
|
+
local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/releaseControl'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))
|
278
|
+
|
279
|
+
# query parameters
|
280
|
+
query_params = opts[:query_params] || {}
|
281
|
+
|
282
|
+
# header parameters
|
283
|
+
header_params = opts[:header_params] || {}
|
284
|
+
# HTTP header 'Accept' (if needed)
|
285
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
286
|
+
|
287
|
+
# form parameters
|
288
|
+
form_params = opts[:form_params] || {}
|
289
|
+
|
290
|
+
# http body (model)
|
291
|
+
post_body = opts[:body]
|
292
|
+
|
293
|
+
# return_type
|
294
|
+
return_type = opts[:return_type] || 'Object'
|
295
|
+
|
296
|
+
# auth_names
|
297
|
+
auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
|
298
|
+
|
299
|
+
new_options = opts.merge(
|
300
|
+
:header_params => header_params,
|
301
|
+
:query_params => query_params,
|
302
|
+
:form_params => form_params,
|
303
|
+
:body => post_body,
|
304
|
+
:auth_names => auth_names,
|
305
|
+
:return_type => return_type
|
306
|
+
)
|
307
|
+
|
308
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
309
|
+
if @api_client.config.debugging
|
310
|
+
@api_client.config.logger.debug "API called: SwitchboardActionsApi#release_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
311
|
+
end
|
312
|
+
return data, status_code, headers
|
313
|
+
end
|
246
314
|
end
|
247
315
|
end
|