sunshine-conversations-client 15.5.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 +6 -2
- data/README.md +8 -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 +4 -4
- data/docs/SwitchboardActionsApi.md +1 -1
- 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 +9 -9
- data/lib/sunshine-conversations-client/api/participants_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +3 -3
- 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 +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 +2 -2
- data/lib/sunshine-conversations-client/models/referral_details.rb +1 -1
- data/lib/sunshine-conversations-client/models/release_control_body.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/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 +1 -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 +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a8dc6044d02bc648be675c74b45ee17f5ca895289e496400cd84c6a0f625b609
|
4
|
+
data.tar.gz: b9d81a451b842d55360210285defe885005017526aae1284b37de340cb07106b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2e7acc67c4003b4462d74d5221990566a4b452af5fa5fc3d095816a96fbe3b05be59597598f54f507cba512a0e0d17924f26dd2f110e0a94cde178fdc55cd558
|
7
|
+
data.tar.gz: e1244ccbfa2628eb27736e528db9464e2b27be193486ef3c93eb3f9db62fb95bd1df89aa926dd2204bb99198a2b2ae3a9912b8c30c259faa3785ff6662585e04
|
data/CHANGELOG_RB.md
CHANGED
@@ -1,5 +1,9 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [15.5.1] - 2025-06-02
|
4
|
+
|
5
|
+
- Fix various docs links
|
6
|
+
|
3
7
|
## [15.5.0] - 2025-05-06
|
4
8
|
|
5
9
|
- Added new optional field `metadata` to release control.
|
@@ -55,7 +59,7 @@
|
|
55
59
|
|
56
60
|
- Add `can_user_see_conversation_list` to all SDK integrations and their update schemas
|
57
61
|
- Added new fields `html_text`, `markdown_text` to [Text](https://github.com/zendesk/sunshine-conversations-ruby/blob/master/docs/TextMessage.md), [Image](https://github.com/zendesk/sunshine-conversations-ruby/blob/master/docs/ImageMessage.md) and [File](https://github.com/zendesk/sunshine-conversations-javascript/blob/master/docs/FileMessage.md) messages.
|
58
|
-
- See our [rich text](https://
|
62
|
+
- See our [rich text](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) guide for more information.
|
59
63
|
- Add definitions for ErrorResponse and Error
|
60
64
|
|
61
65
|
## [14.3.5] - 2025-02-01
|
@@ -249,7 +253,7 @@
|
|
249
253
|
## [9.12.0] - 2022-08-30
|
250
254
|
|
251
255
|
- The Switchboard `passControl` action is now 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.
|
252
|
-
- For more information, see [Switchboard passControl](https://
|
256
|
+
- For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
|
253
257
|
|
254
258
|
## [9.11.0] - 2022-07-28
|
255
259
|
|
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: 15.5.
|
8
|
-
- Package version: 15.5.
|
7
|
+
- API version: 15.5.1
|
8
|
+
- Package version: 15.5.1
|
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-15.5.
|
35
|
+
gem install ./sunshine-conversations-client-15.5.1.gem
|
36
36
|
```
|
37
37
|
|
38
|
-
(for development, run `gem install --dev ./sunshine-conversations-client-15.5.
|
38
|
+
(for development, run `gem install --dev ./sunshine-conversations-client-15.5.1.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', '~> 15.5.
|
44
|
+
gem 'sunshine-conversations-client', '~> 15.5.1'
|
45
45
|
|
46
46
|
### Install from Git
|
47
47
|
|
@@ -59,15 +59,15 @@ ruby -Ilib script.rb
|
|
59
59
|
|
60
60
|
## Getting Started
|
61
61
|
|
62
|
-
Familiarity with [Sunshine Conversations API authentication](https://
|
62
|
+
Familiarity with [Sunshine Conversations API authentication](https://developer.zendesk.com/documentation/conversations/getting-started/api-authentication/) is recommended.
|
63
63
|
|
64
64
|
### Basic Authentication (recommended)
|
65
65
|
|
66
|
-
With [basic authentication](https://
|
66
|
+
With [basic authentication](https://developer.zendesk.com/documentation/conversations/getting-started/api-authentication/#basic-authentication), you can use your API key ID and secret to authenticate API requests. See below for a code sample.
|
67
67
|
|
68
68
|
### Authentication with JSON Web Tokens (JWTs)
|
69
69
|
|
70
|
-
See the [JSON Web Tokens (JWTs)](https://
|
70
|
+
See the [JSON Web Tokens (JWTs)](https://developer.zendesk.com/documentation/conversations/getting-started/api-authentication/#jwt-authentication) guide for more information and guidelines on when to use this method. In general, you'll want to favor using basic authentication.
|
71
71
|
|
72
72
|
To generate a JWT, use your API key ID and secret.
|
73
73
|
|
data/docs/Android.md
CHANGED
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**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]
|
14
14
|
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional]
|
15
15
|
**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]
|
16
|
-
**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://
|
16
|
+
**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]
|
17
17
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
18
18
|
|
19
19
|
## Code Sample
|
data/docs/AndroidUpdate.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
|
**project_id** | **String** | Your project ID from your generated private key file. | [optional]
|
10
10
|
**client_email** | **String** | Your client email from your generated private key file. | [optional]
|
11
11
|
**private_key** | **String** | Your private key from your generated private key file. | [optional]
|
data/docs/AppSettings.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**conversation_retention_seconds** | **Integer** | Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](https://docs.smooch.io/guide/creating-and-managing-apps/#conversation-retention-seconds) for more information. | [optional]
|
8
8
|
**mask_credit_card_numbers** | **Boolean** | A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations. | [optional]
|
9
|
-
**use_animal_names** | **Boolean** | A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](https://
|
9
|
+
**use_animal_names** | **Boolean** | A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/receiving-messages/#message-author-name) for details. | [optional]
|
10
10
|
**echo_postback** | **Boolean** | A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/guide/creating-and-managing-apps/#echo-postbacks) for more information. | [optional]
|
11
11
|
**ignore_auto_conversation_start** | **Boolean** | A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](https://docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class=\"notice\">Calling <code>startConversation()</code> (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside> | [optional]
|
12
12
|
**multi_convo_enabled** | **Boolean** | A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is **irreversible**. | [optional]
|
data/docs/Apple.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. |
|
10
10
|
**msp_id** | **String** | Your Messaging Service Provider ID. |
|
11
11
|
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [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/AppleUpdate.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
|
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
data/docs/Content.md
CHANGED
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
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
|
-
**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<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]
|
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
|
**items** | [**Array<Item>**](Item.md) | An array of objects representing the items associated with the message. Only present in carousel and list type messages. |
|
15
15
|
**display_settings** | [**CarouselMessageDisplaySettings**](CarouselMessageDisplaySettings.md) | | [optional]
|
16
16
|
**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See [configuring private attachments for messaging](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/) guide for more details.</aside> |
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation a user lands in after being referred. See the <a href=\"https://
|
7
|
+
**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation a user lands in after being referred. See the <a href=\"https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/conversation-referrals/\">conversation referrals</a> guide for more details. | [optional]
|
8
8
|
**user** | [**User**](User.md) | The user associated with the conversation. | [optional]
|
9
9
|
**source** | [**SourceWithCampaignWebhook**](SourceWithCampaignWebhook.md) | The source of the referral. | [optional]
|
10
10
|
**referral** | [**Referral**](Referral.md) | | [optional]
|
data/docs/DefaultResponderId.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**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://
|
7
|
+
**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]
|
8
8
|
|
9
9
|
## Code Sample
|
10
10
|
|
data/docs/Destination.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**integration_id** | **String** | The id of the integration to deliver the message to. Will return an error if the integration does not exist or if the user does not have a client for the integration attached to the conversation. | [optional]
|
8
|
-
**integration_type** | **String** | The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](https://
|
8
|
+
**integration_type** | **String** | The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/sending-messages/#silent-messages). Will return an error if the user does not have a client of that type attached to the conversation. | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/FileMessage.md
CHANGED
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
|
|
11
11
|
**alt_text** | **String** | An optional description of the file for accessibility purposes. The field will be saved by default with the file name as the value. | [optional]
|
12
12
|
**text** | **String** | The text content of the message. | [optional]
|
13
13
|
**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]
|
14
|
-
**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://
|
15
|
-
**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://
|
14
|
+
**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]
|
15
|
+
**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]
|
16
16
|
**attachment_id** | **String** | An identifier used by Sunshine Conversations for internal purposes. | [optional]
|
17
17
|
|
18
18
|
## Code Sample
|
data/docs/ImageMessage.md
CHANGED
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
|
|
11
11
|
**alt_text** | **String** | An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value. | [optional]
|
12
12
|
**text** | **String** | The text content of the message. | [optional]
|
13
13
|
**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]
|
14
|
-
**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://
|
15
|
-
**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://
|
14
|
+
**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]
|
15
|
+
**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]
|
16
16
|
**actions** | [**Array<Action>**](Action.md) | Array of message actions. | [optional]
|
17
17
|
**attachment_id** | **String** | An identifier used by Sunshine Conversations for internal purposes. | [optional]
|
18
18
|
|
data/docs/InlineObject.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**code** | **String** | The authorization code received via
|
7
|
+
**code** | **String** | The authorization code received via the OAuth flow |
|
8
8
|
**grant_type** | **String** | Must be set to the string `authorization_code` |
|
9
|
-
**client_id** | **String** | Your
|
10
|
-
**client_secret** | **String** | Your
|
9
|
+
**client_id** | **String** | Your OAuth client ID, provisioned during the partner application process |
|
10
|
+
**client_secret** | **String** | Your OAuth client secret, provisioned during the partner application process |
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
data/docs/Instagram.md
CHANGED
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**business_id** | **String** | The ID of the Instagram Business account | [optional] [readonly]
|
15
15
|
**username** | **String** | The Facebook user's username. This is returned when integrating through the Dashboard | [optional] [readonly]
|
16
16
|
**user_id** | **String** | The Facebook user's user ID. This is returned when integrating through the Dashboard | [optional] [readonly]
|
17
|
-
**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://
|
17
|
+
**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]
|
18
18
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
19
19
|
|
20
20
|
## Code Sample
|
data/docs/InstagramUpdate.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
|
**page_access_token** | **String** | A Facebook Page Access Token. | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
data/docs/IntegrationType.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**integration_type** | **String** | The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](https://
|
7
|
+
**integration_type** | **String** | The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/sending-messages/#silent-messages). Will return an error if the user does not have a client of that type attached to the conversation. | [optional]
|
8
8
|
|
9
9
|
## Code Sample
|
10
10
|
|
data/docs/IntegrationUpdate.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
|
**project_id** | **String** | Your project ID from your generated private key file. | [optional]
|
10
10
|
**client_email** | **String** | Your client email from your generated private key file. | [optional]
|
11
11
|
**private_key** | **String** | Your private key from your generated private key file. | [optional]
|
@@ -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
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/Ios.md
CHANGED
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**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]
|
13
13
|
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional]
|
14
14
|
**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]
|
15
|
-
**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://
|
15
|
+
**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]
|
16
16
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
17
17
|
|
18
18
|
## Code Sample
|
data/docs/IosUpdate.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
|
**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional]
|
10
10
|
**password** | **String** | The password for your APN certificate. | [optional]
|
11
11
|
**production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional]
|
data/docs/Line.md
CHANGED
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**switcher_secret** | **String** | LINE Switcher Secret. | [optional]
|
13
13
|
**qr_code_url** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/). | [optional]
|
14
14
|
**line_id** | **String** | LINE Basic ID. Is automatically set when qrCodeUrl is updated. | [optional] [readonly]
|
15
|
-
**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://
|
15
|
+
**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]
|
16
16
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
17
17
|
|
18
18
|
## Code Sample
|
data/docs/Mailgun.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**incoming_address** | **String** | Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address. |
|
11
11
|
**hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional]
|
12
12
|
**from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional]
|
13
|
-
**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://
|
13
|
+
**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]
|
14
14
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
15
15
|
|
16
16
|
## Code Sample
|
data/docs/MailgunUpdate.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
|
**hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional]
|
10
10
|
**from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional]
|
11
11
|
|
data/docs/Messagebird.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**signing_key** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. |
|
10
10
|
**originator** | **String** | Sunshine Conversations will receive all messages sent to this phone number. |
|
11
11
|
**webhook_secret** | **String** | The secret that is used to configure webhooks in MessageBird. | [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
|
data/docs/Messenger.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**app_secret** | **String** | A Facebook App Secret. |
|
11
11
|
**page_id** | **Float** | A Facebook page ID. | [optional]
|
12
12
|
**page_name** | **String** | A Facebook page name. | [optional]
|
13
|
-
**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://
|
13
|
+
**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]
|
14
14
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
15
15
|
|
16
16
|
## Code Sample
|
data/docs/MessengerUpdate.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
|
**page_access_token** | **String** | A Facebook Page Access Token. | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
data/docs/OAuthEndpointsApi.md
CHANGED
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
17
17
|
|
18
18
|
Authorize
|
19
19
|
|
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
|
|
22
22
|
### Example
|
23
23
|
|
@@ -72,7 +72,7 @@ No authorization required
|
|
72
72
|
|
73
73
|
Get Token
|
74
74
|
|
75
|
-
This endpoint is used to exchange an authorization code for an access token.
|
75
|
+
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 ```
|
76
76
|
|
77
77
|
### Example
|
78
78
|
|
@@ -120,7 +120,7 @@ No authorization required
|
|
120
120
|
|
121
121
|
Get Token Info
|
122
122
|
|
123
|
-
This endpoint can be used to retrieve the app linked to the OAuth token.
|
123
|
+
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 ```
|
124
124
|
|
125
125
|
### Example
|
126
126
|
|
@@ -164,7 +164,7 @@ No authorization required
|
|
164
164
|
|
165
165
|
Revoke Access
|
166
166
|
|
167
|
-
This endpoint is used to revoke your integration
|
167
|
+
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.
|
168
168
|
|
169
169
|
### Example
|
170
170
|
|
@@ -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
|
|
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
|