sunshine-conversations-client 15.4.0 → 15.5.1
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/CHANGELOG_RB.md +12 -2
- data/README.md +10 -8
- data/docs/Android.md +1 -1
- data/docs/AndroidUpdate.md +1 -1
- data/docs/AppSettings.md +1 -1
- data/docs/Apple.md +1 -1
- data/docs/AppleUpdate.md +1 -1
- data/docs/Content.md +3 -3
- data/docs/ConversationReferralEventAllOfPayload.md +1 -1
- data/docs/DefaultResponderId.md +1 -1
- data/docs/Destination.md +1 -1
- data/docs/FileMessage.md +2 -2
- data/docs/ImageMessage.md +2 -2
- data/docs/InlineObject.md +3 -3
- data/docs/Instagram.md +1 -1
- data/docs/InstagramUpdate.md +1 -1
- data/docs/IntegrationType.md +1 -1
- data/docs/IntegrationUpdate.md +1 -1
- data/docs/IntegrationUpdateBase.md +1 -1
- data/docs/Ios.md +1 -1
- data/docs/IosUpdate.md +1 -1
- data/docs/Line.md +1 -1
- data/docs/Mailgun.md +1 -1
- data/docs/MailgunUpdate.md +1 -1
- data/docs/Messagebird.md +1 -1
- data/docs/Messenger.md +1 -1
- data/docs/MessengerUpdate.md +1 -1
- data/docs/OAuthEndpointsApi.md +48 -3
- data/docs/PassControlBody.md +2 -0
- data/docs/ReleaseControlBody.md +19 -0
- data/docs/SwitchboardActionsApi.md +8 -4
- data/docs/Telegram.md +1 -1
- data/docs/TextMessage.md +3 -3
- data/docs/Twilio.md +1 -1
- data/docs/Twitter.md +1 -1
- data/docs/Unity.md +1 -1
- data/docs/UnityUpdate.md +1 -1
- data/docs/UserCreateBody.md +1 -1
- data/docs/UserUpdateEventAllOfPayload.md +1 -1
- data/docs/Viber.md +1 -1
- data/docs/Web.md +1 -1
- data/docs/WebUpdate.md +1 -1
- data/docs/WhatsAppUpdate.md +1 -1
- data/docs/Whatsapp.md +1 -1
- 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/devices_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 +63 -7
- data/lib/sunshine-conversations-client/api/participants_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +8 -4
- 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_message.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 +2 -2
- data/lib/sunshine-conversations-client/models/android_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_update.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/apple_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_message_override_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_update.rb +2 -2
- data/lib/sunshine-conversations-client/models/apple_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_delete_body.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/campaign.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 +4 -4
- 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_referral_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of_payload.rb +2 -2
- 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/default_responder.rb +1 -1
- data/lib/sunshine-conversations-client/models/default_responder_default_responder.rb +2 -2
- data/lib/sunshine-conversations-client/models/default_responder_id.rb +2 -2
- data/lib/sunshine-conversations-client/models/destination.rb +3 -3
- data/lib/sunshine-conversations-client/models/device.rb +1 -1
- data/lib/sunshine-conversations-client/models/device_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/device_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple_interactive_data_ref.rb +1 -1
- data/lib/sunshine-conversations-client/models/error.rb +1 -1
- data/lib/sunshine-conversations-client/models/error_response.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 +3 -3
- data/lib/sunshine-conversations-client/models/form_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_message_field.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_message_field_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message_field.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message_field_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/identity.rb +1 -1
- data/lib/sunshine-conversations-client/models/image_message.rb +3 -3
- data/lib/sunshine-conversations-client/models/inline_object.rb +4 -4
- data/lib/sunshine-conversations-client/models/instagram.rb +2 -2
- data/lib/sunshine-conversations-client/models/instagram_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram_update.rb +2 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/integration_update.rb +2 -2
- data/lib/sunshine-conversations-client/models/integration_update_base.rb +2 -2
- data/lib/sunshine-conversations-client/models/ios.rb +2 -2
- data/lib/sunshine-conversations-client/models/ios_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_update.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_update.rb +2 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/messenger.rb +2 -2
- data/lib/sunshine-conversations-client/models/messenger_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/messenger_update.rb +2 -2
- 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 +46 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/referral_details.rb +1 -1
- data/lib/sunshine-conversations-client/models/release_control_body.rb +248 -0
- 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/source_with_campaign_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook_all_of.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/sync_user_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/target.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram.rb +2 -2
- 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 +4 -4
- data/lib/sunshine-conversations-client/models/ticket_closed.rb +1 -1
- data/lib/sunshine-conversations-client/models/transfer_to_email.rb +1 -1
- data/lib/sunshine-conversations-client/models/twilio.rb +2 -2
- 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 +2 -2
- 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/unity.rb +2 -2
- data/lib/sunshine-conversations-client/models/unity_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/unity_update.rb +2 -2
- data/lib/sunshine-conversations-client/models/unity_update_all_of.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 +2 -2
- 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_remove_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_remove_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_remove_event_all_of_payload.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 +1 -1
- data/lib/sunshine-conversations-client/models/user_update_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_event_all_of_payload.rb +2 -2
- data/lib/sunshine-conversations-client/models/viber.rb +2 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/web_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_update.rb +2 -2
- 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 +2 -2
- data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/whatsapp.rb +2 -2
- 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 +2 -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 +4 -2
@@ -141,7 +141,7 @@ Name | Type | Description | Notes
|
|
141
141
|
|
142
142
|
Pass Control
|
143
143
|
|
144
|
-
The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://
|
144
|
+
The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
|
145
145
|
|
146
146
|
### Example
|
147
147
|
|
@@ -199,7 +199,7 @@ Name | Type | Description | Notes
|
|
199
199
|
|
200
200
|
## release_control
|
201
201
|
|
202
|
-
> Object release_control(app_id, conversation_id)
|
202
|
+
> Object release_control(app_id, conversation_id, opts)
|
203
203
|
|
204
204
|
Release Control
|
205
205
|
|
@@ -225,10 +225,13 @@ api_instance = SunshineConversationsClient::SwitchboardActionsApi.new
|
|
225
225
|
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
226
226
|
conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
|
227
227
|
# Be sure to add the required body parameters
|
228
|
+
opts = {
|
229
|
+
release_control_body: SunshineConversationsClient::ReleaseControlBody.new # ReleaseControlBody |
|
230
|
+
}
|
228
231
|
|
229
232
|
begin
|
230
233
|
#Release Control
|
231
|
-
result = api_instance.release_control(app_id, conversation_id)
|
234
|
+
result = api_instance.release_control(app_id, conversation_id, opts)
|
232
235
|
p result
|
233
236
|
rescue SunshineConversationsClient::ApiError => e
|
234
237
|
puts "Exception when calling SwitchboardActionsApi->release_control: #{e}"
|
@@ -242,6 +245,7 @@ Name | Type | Description | Notes
|
|
242
245
|
------------- | ------------- | ------------- | -------------
|
243
246
|
**app_id** | **String**| Identifies the app. |
|
244
247
|
**conversation_id** | **String**| Identifies the conversation. |
|
248
|
+
**release_control_body** | [**ReleaseControlBody**](ReleaseControlBody.md)| | [optional]
|
245
249
|
|
246
250
|
### Return type
|
247
251
|
|
@@ -253,6 +257,6 @@ Name | Type | Description | Notes
|
|
253
257
|
|
254
258
|
### HTTP request headers
|
255
259
|
|
256
|
-
- **Content-Type**:
|
260
|
+
- **Content-Type**: application/json
|
257
261
|
- **Accept**: application/json
|
258
262
|
|
data/docs/Telegram.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**token** | **String** | Telegram Bot Token. |
|
9
9
|
**username** | **String** | Username of the botId | [optional] [readonly]
|
10
10
|
**bot_id** | **String** | A human-friendly name used to identify the integration. | [optional] [readonly]
|
11
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
11
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
12
12
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
data/docs/TextMessage.md
CHANGED
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**type** | **String** | The type of message. | [default to 'text']
|
8
8
|
**text** | **String** | The text content of the message. Required unless `actions`, `htmlText` or `markdownText` is provided. | [optional]
|
9
|
-
**html_text** | **String** | HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://
|
9
|
+
**html_text** | **String** | HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) documentation for more information. | [optional]
|
10
10
|
**block_chat_input** | **Boolean** | When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation. | [optional]
|
11
|
-
**markdown_text** | **String** | Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://
|
11
|
+
**markdown_text** | **String** | Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) documentation for more information. | [optional]
|
12
12
|
**actions** | [**Array<Action>**](Action.md) | Array of message actions. | [optional]
|
13
|
-
**payload** | **String** | The payload of a [reply button](https://
|
13
|
+
**payload** | **String** | The payload of a [reply button](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#reply-buttons) response message. | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|
data/docs/Twilio.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**auth_token** | **String** | Twilio Auth Token. |
|
10
10
|
**phone_number_sid** | **String** | SID for specific phone number. One of `messagingServiceSid` or `phoneNumberSid` must be provided when creating a Twilio integration. | [optional]
|
11
11
|
**messaging_service_sid** | **String** | SID for specific messaging service. One of `messagingServiceSid` or `phoneNumberSid` must be provided when creating a Twilio integration. | [optional]
|
12
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
12
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
13
13
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
data/docs/Twitter.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**consumer_secret** | **String** | The consumer key secret for your Twitter app. |
|
12
12
|
**access_token_key** | **String** | The access token key obtained from your user via oauth. |
|
13
13
|
**access_token_secret** | **String** | The access token secret obtained from your user via oauth. |
|
14
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
14
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
15
15
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
16
16
|
|
17
17
|
## Code Sample
|
data/docs/Unity.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*. | [optional]
|
9
9
|
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the Unity integration. | [optional]
|
10
10
|
**attachments_enabled** | **Boolean** | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center. | [optional] [readonly]
|
11
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
11
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
12
12
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
data/docs/UnityUpdate.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional]
|
8
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
8
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
9
9
|
**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*. | [optional]
|
10
10
|
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the Unity integration. | [optional]
|
11
11
|
|
data/docs/UserCreateBody.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**external_id** | **String** | A unique identifier for the user. The `externalId` can be used to link a user to the same conversation [across multiple devices](https://
|
7
|
+
**external_id** | **String** | A unique identifier for the user. The `externalId` can be used to link a user to the same conversation [across multiple devices](https://developer.zendesk.com/documentation/conversations/messaging-platform/users/authenticating-users/). |
|
8
8
|
**signed_up_at** | **String** | The date at which the user signed up. Must be ISO 8601 time format `YYYY-MM-DDThh:mm:ss.sssZ`. | [optional]
|
9
9
|
**to_be_retained** | **Boolean** | Flag indicating whether a user should be retained after they have passed their inactive expiry. See [creating deletion schedules for bot-only conversations](https://support.zendesk.com/hc/en-us/articles/8499219792154) for more information. | [optional]
|
10
10
|
**profile** | [**Profile**](Profile.md) | | [optional]
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**user** | [**User**](User.md) | The updated user. | [optional]
|
8
|
-
**reason** | **String** | The reason why the user was updated, if applicable. * `authentication` - An
|
8
|
+
**reason** | **String** | The reason why the user was updated, if applicable. * `authentication` - An unauthenticated user became an [authenticated](https://developer.zendesk.com/documentation/conversations/messaging-platform/users/intro-to-users/) user. * `localeDetection` - A user was updated as a result of automated locale detection on messages sent. | [optional]
|
9
9
|
**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the creation. | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
data/docs/Viber.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**token** | **String** | Viber Public Account token. |
|
9
9
|
**uri** | **String** | Unique URI of the Viber account. | [optional] [readonly]
|
10
10
|
**account_id** | **String** | Unique ID of the Viber account. | [optional] [readonly]
|
11
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
11
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
12
12
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
data/docs/Web.md
CHANGED
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
|
|
22
22
|
**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*. | [optional]
|
23
23
|
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
|
24
24
|
**attachments_enabled** | **Boolean** | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center. | [optional] [readonly]
|
25
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
25
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
26
26
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
27
27
|
|
28
28
|
## Code Sample
|
data/docs/WebUpdate.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional]
|
8
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
8
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
9
9
|
**brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
|
10
10
|
**fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
|
11
11
|
**conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
data/docs/WhatsAppUpdate.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional]
|
8
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
8
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
9
9
|
**hsm_fallback_language** | **String** | Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info. | [optional] [default to 'en_US']
|
10
10
|
**account_id** | **String** | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional]
|
11
11
|
**account_management_access_token** | **String** | An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction. | [optional]
|
data/docs/Whatsapp.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**account_id** | **String** | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional]
|
10
10
|
**account_management_access_token** | **String** | An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction. | [optional]
|
11
11
|
**phone_number** | **String** | The phone number that is associated with the deployment of this integration, if one exists. | [optional] [readonly]
|
12
|
-
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://
|
12
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional]
|
13
13
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Sunshine Conversations API
|
3
3
|
|
4
|
-
The version of the OpenAPI document: 15.
|
4
|
+
The version of the OpenAPI document: 15.5.1
|
5
5
|
|
6
6
|
Generated by: https://openapi-generator.tech
|
7
7
|
OpenAPI Generator version: 4.3.1
|
@@ -17,7 +17,7 @@ module SunshineConversationsClient
|
|
17
17
|
@api_client = api_client
|
18
18
|
end
|
19
19
|
# Authorize
|
20
|
-
# This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to
|
20
|
+
# This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to Zendesk they will be redirected to the login page. If the user has many Zendesk accounts, they will first be prompted to select the one they wish to integrate with. They will then be presented with an Allow/Deny dialog, describing details of the access your integration is requesting. Use `oauth-bridge.zendesk.com/sc` as the base URL when redirecting the user to this endpoint. ``` https://oauth-bridge.zendesk.com/sc/oauth/authorize?response_type=code&client_id={client_id} ```
|
21
21
|
# @param client_id [String] Your integration’s unique identifier
|
22
22
|
# @param response_type [String] For now the only acceptable value is code.
|
23
23
|
# @param [Hash] opts the optional parameters
|
@@ -30,7 +30,7 @@ module SunshineConversationsClient
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Authorize
|
33
|
-
# This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to
|
33
|
+
# This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to Zendesk they will be redirected to the login page. If the user has many Zendesk accounts, they will first be prompted to select the one they wish to integrate with. They will then be presented with an Allow/Deny dialog, describing details of the access your integration is requesting. Use `oauth-bridge.zendesk.com/sc` as the base URL when redirecting the user to this endpoint. ``` https://oauth-bridge.zendesk.com/sc/oauth/authorize?response_type=code&client_id={client_id} ```
|
34
34
|
# @param client_id [String] Your integration’s unique identifier
|
35
35
|
# @param response_type [String] For now the only acceptable value is code.
|
36
36
|
# @param [Hash] opts the optional parameters
|
@@ -93,7 +93,7 @@ module SunshineConversationsClient
|
|
93
93
|
end
|
94
94
|
|
95
95
|
# Get Token
|
96
|
-
# This endpoint is used to exchange an authorization code for an access token.
|
96
|
+
# This endpoint is used to exchange an authorization code for an access token. It should only be used in server-to-server calls. Use `oauth-bridge.zendesk.com/sc` as the base URL when invoking this endpoint. ``` POST https://oauth-bridge.zendesk.com/sc/oauth/token ```
|
97
97
|
# @param inline_object [InlineObject]
|
98
98
|
# @param [Hash] opts the optional parameters
|
99
99
|
# @return [Object]
|
@@ -103,7 +103,7 @@ module SunshineConversationsClient
|
|
103
103
|
end
|
104
104
|
|
105
105
|
# Get Token
|
106
|
-
# This endpoint is used to exchange an authorization code for an access token.
|
106
|
+
# This endpoint is used to exchange an authorization code for an access token. It should only be used in server-to-server calls. Use `oauth-bridge.zendesk.com/sc` as the base URL when invoking this endpoint. ``` POST https://oauth-bridge.zendesk.com/sc/oauth/token ```
|
107
107
|
# @param inline_object [InlineObject]
|
108
108
|
# @param [Hash] opts the optional parameters
|
109
109
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
@@ -156,8 +156,64 @@ module SunshineConversationsClient
|
|
156
156
|
return data, status_code, headers
|
157
157
|
end
|
158
158
|
|
159
|
+
# Get Token Info
|
160
|
+
# This endpoint can be used to retrieve the app linked to the OAuth token. Typically used after receiving an access token via OAuth, in order to retrieve the app's `id` and `subdomain` to be used in future calls. May also be used to confirm that the credentials are still valid. Use `oauth-bridge.zendesk.com/sc` as the base URL when invoking this endpoint. ``` GET https://oauth-bridge.zendesk.com/sc/v2/tokenInfo ```
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [AppResponse]
|
163
|
+
def get_token_info(opts = {})
|
164
|
+
data, _status_code, _headers = get_token_info_with_http_info(opts)
|
165
|
+
data
|
166
|
+
end
|
167
|
+
|
168
|
+
# Get Token Info
|
169
|
+
# This endpoint can be used to retrieve the app linked to the OAuth token. Typically used after receiving an access token via OAuth, in order to retrieve the app's `id` and `subdomain` to be used in future calls. May also be used to confirm that the credentials are still valid. Use `oauth-bridge.zendesk.com/sc` as the base URL when invoking this endpoint. ``` GET https://oauth-bridge.zendesk.com/sc/v2/tokenInfo ```
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @return [Array<(AppResponse, Integer, Hash)>] AppResponse data, response status code and response headers
|
172
|
+
def get_token_info_with_http_info(opts = {})
|
173
|
+
if @api_client.config.debugging
|
174
|
+
@api_client.config.logger.debug 'Calling API: OAuthEndpointsApi.get_token_info ...'
|
175
|
+
end
|
176
|
+
# resource path
|
177
|
+
local_var_path = '/v2/tokenInfo'
|
178
|
+
|
179
|
+
# query parameters
|
180
|
+
query_params = opts[:query_params] || {}
|
181
|
+
|
182
|
+
# header parameters
|
183
|
+
header_params = opts[:header_params] || {}
|
184
|
+
# HTTP header 'Accept' (if needed)
|
185
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
186
|
+
|
187
|
+
# form parameters
|
188
|
+
form_params = opts[:form_params] || {}
|
189
|
+
|
190
|
+
# http body (model)
|
191
|
+
post_body = opts[:body]
|
192
|
+
|
193
|
+
# return_type
|
194
|
+
return_type = opts[:return_type] || 'AppResponse'
|
195
|
+
|
196
|
+
# auth_names
|
197
|
+
auth_names = opts[:auth_names] || []
|
198
|
+
|
199
|
+
new_options = opts.merge(
|
200
|
+
:header_params => header_params,
|
201
|
+
:query_params => query_params,
|
202
|
+
:form_params => form_params,
|
203
|
+
:body => post_body,
|
204
|
+
:auth_names => auth_names,
|
205
|
+
:return_type => return_type
|
206
|
+
)
|
207
|
+
|
208
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
209
|
+
if @api_client.config.debugging
|
210
|
+
@api_client.config.logger.debug "API called: OAuthEndpointsApi#get_token_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
211
|
+
end
|
212
|
+
return data, status_code, headers
|
213
|
+
end
|
214
|
+
|
159
215
|
# Revoke Access
|
160
|
-
# This endpoint is used to revoke your integration
|
216
|
+
# This endpoint is used to revoke your integration's access to the user's app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed. Calling this endpoint is equivalent to the user removing your integration manually. Your integration's `removeUrl` (if configured) will also be called when an integration is removed in this way.
|
161
217
|
# @param [Hash] opts the optional parameters
|
162
218
|
# @return [Object]
|
163
219
|
def revoke_access(opts = {})
|
@@ -166,7 +222,7 @@ module SunshineConversationsClient
|
|
166
222
|
end
|
167
223
|
|
168
224
|
# Revoke Access
|
169
|
-
# This endpoint is used to revoke your integration
|
225
|
+
# This endpoint is used to revoke your integration's access to the user's app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed. Calling this endpoint is equivalent to the user removing your integration manually. Your integration's `removeUrl` (if configured) will also be called when an integration is removed in this way.
|
170
226
|
# @param [Hash] opts the optional parameters
|
171
227
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
172
228
|
def revoke_access_with_http_info(opts = {})
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Sunshine Conversations API
|
3
3
|
|
4
|
-
The version of the OpenAPI document: 15.
|
4
|
+
The version of the OpenAPI document: 15.5.1
|
5
5
|
|
6
6
|
Generated by: https://openapi-generator.tech
|
7
7
|
OpenAPI Generator version: 4.3.1
|
@@ -169,7 +169,7 @@ module SunshineConversationsClient
|
|
169
169
|
end
|
170
170
|
|
171
171
|
# Pass Control
|
172
|
-
# The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://
|
172
|
+
# The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
|
173
173
|
# @param app_id [String] Identifies the app.
|
174
174
|
# @param conversation_id [String] Identifies the conversation.
|
175
175
|
# @param pass_control_body [PassControlBody]
|
@@ -181,7 +181,7 @@ module SunshineConversationsClient
|
|
181
181
|
end
|
182
182
|
|
183
183
|
# Pass Control
|
184
|
-
# The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://
|
184
|
+
# The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
|
185
185
|
# @param app_id [String] Identifies the app.
|
186
186
|
# @param conversation_id [String] Identifies the conversation.
|
187
187
|
# @param pass_control_body [PassControlBody]
|
@@ -249,6 +249,7 @@ module SunshineConversationsClient
|
|
249
249
|
# @param app_id [String] Identifies the app.
|
250
250
|
# @param conversation_id [String] Identifies the conversation.
|
251
251
|
# @param [Hash] opts the optional parameters
|
252
|
+
# @option opts [ReleaseControlBody] :release_control_body
|
252
253
|
# @return [Object]
|
253
254
|
def release_control(app_id, conversation_id, opts = {})
|
254
255
|
data, _status_code, _headers = release_control_with_http_info(app_id, conversation_id, opts)
|
@@ -260,6 +261,7 @@ module SunshineConversationsClient
|
|
260
261
|
# @param app_id [String] Identifies the app.
|
261
262
|
# @param conversation_id [String] Identifies the conversation.
|
262
263
|
# @param [Hash] opts the optional parameters
|
264
|
+
# @option opts [ReleaseControlBody] :release_control_body
|
263
265
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
264
266
|
def release_control_with_http_info(app_id, conversation_id, opts = {})
|
265
267
|
if @api_client.config.debugging
|
@@ -283,12 +285,14 @@ module SunshineConversationsClient
|
|
283
285
|
header_params = opts[:header_params] || {}
|
284
286
|
# HTTP header 'Accept' (if needed)
|
285
287
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
288
|
+
# HTTP header 'Content-Type'
|
289
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
286
290
|
|
287
291
|
# form parameters
|
288
292
|
form_params = opts[:form_params] || {}
|
289
293
|
|
290
294
|
# http body (model)
|
291
|
-
post_body = opts[:body]
|
295
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'release_control_body'])
|
292
296
|
|
293
297
|
# return_type
|
294
298
|
return_type = opts[:return_type] || 'Object'
|