├── .gitignore ├── .gitlab-ci.yml ├── .openapi-generator-ignore ├── .openapi-generator └── VERSION ├── CHANGELOG.md ├── LICENSE ├── README.md ├── docs ├── AcceptControlBody.md ├── Action.md ├── ActionSubset.md ├── ActivitiesApi.md ├── Activity.md ├── ActivityAllOf.md ├── ActivityMessage.md ├── ActivityPost.md ├── ActivityPostAllOf.md ├── ActivityTypes.md ├── Android.md ├── AndroidAllOf.md ├── AndroidUpdate.md ├── AndroidUpdateAllOf.md ├── ApiKey.md ├── App.md ├── AppCreateBody.md ├── AppKey.md ├── AppKeyCreateBody.md ├── AppKeyListResponse.md ├── AppKeyResponse.md ├── AppKeysApi.md ├── AppListFilter.md ├── AppListResponse.md ├── AppResponse.md ├── AppSettings.md ├── AppSubSchema.md ├── AppUpdateBody.md ├── Apple.md ├── AppleAllOf.md ├── AppleMessageOverridePayload.md ├── AppleUpdate.md ├── AppleUpdateAllOf.md ├── AppsApi.md ├── AttachmentDeleteBody.md ├── AttachmentResponse.md ├── AttachmentSchema.md ├── AttachmentUploadBody.md ├── AttachmentsApi.md ├── Author.md ├── AuthorWebhook.md ├── Buy.md ├── Campaign.md ├── CarouselMessage.md ├── CarouselMessageDisplaySettings.md ├── Client.md ├── ClientAddEvent.md ├── ClientAddEventAllOf.md ├── ClientAddEventAllOfPayload.md ├── ClientAssociation.md ├── ClientCreate.md ├── ClientListResponse.md ├── ClientRemoveEvent.md ├── ClientRemoveEventAllOf.md ├── ClientRemoveEventAllOfPayload.md ├── ClientResponse.md ├── ClientType.md ├── ClientUpdateEvent.md ├── ClientUpdateEventAllOf.md ├── ClientUpdateEventAllOfPayload.md ├── ClientsApi.md ├── Confirmation.md ├── Content.md ├── Conversation.md ├── ConversationAllOf.md ├── ConversationCreateBody.md ├── ConversationCreateEvent.md ├── ConversationCreateEventAllOf.md ├── ConversationCreateEventAllOfPayload.md ├── ConversationJoinEvent.md ├── ConversationJoinEventAllOf.md ├── ConversationJoinEventAllOfPayload.md ├── ConversationLeaveEvent.md ├── ConversationLeaveEventAllOf.md ├── ConversationLeaveEventAllOfPayload.md ├── ConversationListFilter.md ├── ConversationListResponse.md ├── ConversationMessageDeliveryChannelEvent.md ├── ConversationMessageDeliveryChannelEventAllOf.md ├── ConversationMessageDeliveryFailureEvent.md ├── ConversationMessageDeliveryFailureEventAllOf.md ├── ConversationMessageDeliveryPayload.md ├── ConversationMessageDeliveryPayloadDestination.md ├── ConversationMessageDeliveryPayloadExternalMessages.md ├── ConversationMessageDeliveryPayloadMessage.md ├── ConversationMessageDeliveryUserEvent.md ├── ConversationMessageEvent.md ├── ConversationMessageEventAllOf.md ├── ConversationMessageEventAllOfPayload.md ├── ConversationPostbackEvent.md ├── ConversationPostbackEventAllOf.md ├── ConversationPostbackEventAllOfPayload.md ├── ConversationReadEvent.md ├── ConversationReadEventAllOf.md ├── ConversationReadEventAllOfPayload.md ├── ConversationReferralEvent.md ├── ConversationReferralEventAllOf.md ├── ConversationReferralEventAllOfPayload.md ├── ConversationRemoveEvent.md ├── ConversationRemoveEventAllOf.md ├── ConversationRemoveEventAllOfPayload.md ├── ConversationResponse.md ├── ConversationTruncated.md ├── ConversationType.md ├── ConversationTypingEvent.md ├── ConversationTypingEventAllOf.md ├── ConversationTypingEventAllOfPayload.md ├── ConversationUpdateBody.md ├── ConversationsApi.md ├── Custom.md ├── CustomAllOf.md ├── CustomIntegrationApiKeysApi.md ├── CustomUpdate.md ├── DefaultResponder.md ├── DefaultResponderDefaultResponder.md ├── DefaultResponderId.md ├── Destination.md ├── Device.md ├── DeviceListResponse.md ├── DeviceResponse.md ├── DevicesApi.md ├── DownloadMessageRefBody.md ├── DownloadMessageRefBodyAllOf.md ├── DownloadMessageRefBodyAllOfApple.md ├── DownloadMessageRefBodyAllOfAppleInteractiveDataRef.md ├── Error.md ├── ErrorResponse.md ├── EventSubSchema.md ├── ExtraChannelOptions.md ├── ExtraChannelOptionsMessenger.md ├── Field.md ├── FileMessage.md ├── FormMessage.md ├── FormMessageField.md ├── FormMessageFieldAllOf.md ├── FormResponseMessage.md ├── FormResponseMessageField.md ├── FormResponseMessageFieldAllOf.md ├── Identity.md ├── ImageMessage.md ├── InlineObject.md ├── Instagram.md ├── InstagramAllOf.md ├── InstagramUpdate.md ├── InstagramUpdateAllOf.md ├── Integration.md ├── IntegrationApiKey.md ├── IntegrationApiKeyListResponse.md ├── IntegrationApiKeyResponse.md ├── IntegrationId.md ├── IntegrationListFilter.md ├── IntegrationListResponse.md ├── IntegrationResponse.md ├── IntegrationType.md ├── IntegrationUpdate.md ├── IntegrationUpdateBase.md ├── IntegrationsApi.md ├── Ios.md ├── IosAllOf.md ├── IosUpdate.md ├── IosUpdateAllOf.md ├── Item.md ├── Line.md ├── LineAllOf.md ├── LineUpdate.md ├── Link.md ├── Links.md ├── ListMessage.md ├── LocationMessage.md ├── LocationMessageCoordinates.md ├── LocationMessageLocation.md ├── LocationRequest.md ├── Mailgun.md ├── MailgunAllOf.md ├── MailgunUpdate.md ├── MailgunUpdateAllOf.md ├── MatchCriteria.md ├── MatchCriteriaBase.md ├── MatchCriteriaMailgun.md ├── MatchCriteriaMailgunAllOf.md ├── MatchCriteriaMessagebird.md ├── MatchCriteriaMessagebirdAllOf.md ├── MatchCriteriaTwilio.md ├── MatchCriteriaTwilioAllOf.md ├── MatchCriteriaWhatsapp.md ├── MatchCriteriaWhatsappAllOf.md ├── Message.md ├── MessageBirdUpdate.md ├── MessageListResponse.md ├── MessageOverride.md ├── MessageOverrideApple.md ├── MessageOverrideLine.md ├── MessageOverrideMessenger.md ├── MessageOverridePayload.md ├── MessageOverrideWhatsapp.md ├── MessagePost.md ├── MessagePostResponse.md ├── MessageWebhook.md ├── Messagebird.md ├── MessagebirdAllOf.md ├── MessagesApi.md ├── Messenger.md ├── MessengerAllOf.md ├── MessengerUpdate.md ├── Meta.md ├── OAuthEndpointsApi.md ├── OfferControlBody.md ├── Page.md ├── Participant.md ├── ParticipantJoinBody.md ├── ParticipantLeaveBody.md ├── ParticipantLeaveBodyParticipantId.md ├── ParticipantLeaveBodyUserExternalId.md ├── ParticipantLeaveBodyUserId.md ├── ParticipantListResponse.md ├── ParticipantResponse.md ├── ParticipantSubSchema.md ├── ParticipantWithUserExternalId.md ├── ParticipantWithUserId.md ├── ParticipantsApi.md ├── PassControlBody.md ├── Postback.md ├── PostbackWebhook.md ├── PrechatCapture.md ├── Profile.md ├── QuotedMessage.md ├── QuotedMessageExternalMessageId.md ├── QuotedMessageMessage.md ├── Referral.md ├── ReferralDetails.md ├── ReleaseControlBody.md ├── Reply.md ├── Source.md ├── SourceWebhook.md ├── SourceWithCampaignWebhook.md ├── SourceWithCampaignWebhookAllOf.md ├── Status.md ├── Switchboard.md ├── SwitchboardAcceptControl.md ├── SwitchboardAcceptControlAllOf.md ├── SwitchboardAcceptControlAllOfPayload.md ├── SwitchboardAcceptControlFailure.md ├── SwitchboardAcceptControlFailureAllOf.md ├── SwitchboardAcceptControlFailureAllOfPayload.md ├── SwitchboardActionsApi.md ├── SwitchboardIntegration.md ├── SwitchboardIntegrationCreateBody.md ├── SwitchboardIntegrationListResponse.md ├── SwitchboardIntegrationResponse.md ├── SwitchboardIntegrationUpdateBody.md ├── SwitchboardIntegrationWebhook.md ├── SwitchboardIntegrationsApi.md ├── SwitchboardListResponse.md ├── SwitchboardOfferControl.md ├── SwitchboardOfferControlAllOf.md ├── SwitchboardOfferControlAllOfPayload.md ├── SwitchboardOfferControlFailure.md ├── SwitchboardPassControl.md ├── SwitchboardPassControlAllOf.md ├── SwitchboardPassControlAllOfPayload.md ├── SwitchboardPassControlFailure.md ├── SwitchboardResponse.md ├── SwitchboardUpdateBody.md ├── SwitchboardsApi.md ├── SyncUserBody.md ├── Target.md ├── Telegram.md ├── TelegramAllOf.md ├── TelegramUpdate.md ├── TemplateMessage.md ├── TextMessage.md ├── TicketClosed.md ├── TransferToEmail.md ├── Twilio.md ├── TwilioAllOf.md ├── TwilioUpdate.md ├── Twitter.md ├── TwitterAllOf.md ├── TwitterUpdate.md ├── Unity.md ├── UnityAllOf.md ├── UnityUpdate.md ├── UnityUpdateAllOf.md ├── User.md ├── UserAllOf.md ├── UserCreateBody.md ├── UserMergeEvent.md ├── UserMergeEventAllOf.md ├── UserMergeEventAllOfPayload.md ├── UserMergeEventAllOfPayloadMergedClients.md ├── UserMergeEventAllOfPayloadMergedConversations.md ├── UserMergeEventAllOfPayloadMergedUsers.md ├── UserRemoveEvent.md ├── UserRemoveEventAllOf.md ├── UserRemoveEventAllOfPayload.md ├── UserResponse.md ├── UserTruncated.md ├── UserUpdateBody.md ├── UserUpdateEvent.md ├── UserUpdateEventAllOf.md ├── UserUpdateEventAllOfPayload.md ├── UsersApi.md ├── Viber.md ├── ViberAllOf.md ├── ViberUpdate.md ├── Web.md ├── WebAllOf.md ├── WebUpdate.md ├── WebUpdateAllOf.md ├── Webhook.md ├── WebhookBody.md ├── WebhookCreateBody.md ├── WebhookListResponse.md ├── WebhookResponse.md ├── WebhookSubSchema.md ├── WebhooksApi.md ├── Webview.md ├── WhatsAppUpdate.md ├── WhatsAppUpdateAllOf.md ├── Whatsapp.md └── WhatsappAllOf.md ├── requirements.txt ├── setup.cfg ├── setup.py ├── sunshine_conversations_client ├── __init__.py ├── api │ ├── __init__.py │ ├── activities_api.py │ ├── app_keys_api.py │ ├── apps_api.py │ ├── attachments_api.py │ ├── clients_api.py │ ├── conversations_api.py │ ├── custom_integration_api_keys_api.py │ ├── devices_api.py │ ├── integrations_api.py │ ├── messages_api.py │ ├── o_auth_endpoints_api.py │ ├── participants_api.py │ ├── switchboard_actions_api.py │ ├── switchboard_integrations_api.py │ ├── switchboards_api.py │ ├── users_api.py │ └── webhooks_api.py ├── api_client.py ├── configuration.py ├── exceptions.py ├── model │ ├── __init__.py │ ├── accept_control_body.py │ ├── action.py │ ├── action_subset.py │ ├── activity.py │ ├── activity_all_of.py │ ├── activity_message.py │ ├── activity_post.py │ ├── activity_post_all_of.py │ ├── activity_types.py │ ├── android.py │ ├── android_all_of.py │ ├── android_update.py │ ├── android_update_all_of.py │ ├── api_key.py │ ├── app.py │ ├── app_create_body.py │ ├── app_key.py │ ├── app_key_create_body.py │ ├── app_key_list_response.py │ ├── app_key_response.py │ ├── app_list_filter.py │ ├── app_list_response.py │ ├── app_response.py │ ├── app_settings.py │ ├── app_sub_schema.py │ ├── app_update_body.py │ ├── apple.py │ ├── apple_all_of.py │ ├── apple_message_override_payload.py │ ├── apple_update.py │ ├── apple_update_all_of.py │ ├── attachment_delete_body.py │ ├── attachment_response.py │ ├── attachment_schema.py │ ├── attachment_upload_body.py │ ├── author.py │ ├── author_webhook.py │ ├── buy.py │ ├── campaign.py │ ├── carousel_message.py │ ├── carousel_message_display_settings.py │ ├── client.py │ ├── client_add_event.py │ ├── client_add_event_all_of.py │ ├── client_add_event_all_of_payload.py │ ├── client_association.py │ ├── client_create.py │ ├── client_list_response.py │ ├── client_remove_event.py │ ├── client_remove_event_all_of.py │ ├── client_remove_event_all_of_payload.py │ ├── client_response.py │ ├── client_type.py │ ├── client_update_event.py │ ├── client_update_event_all_of.py │ ├── client_update_event_all_of_payload.py │ ├── confirmation.py │ ├── content.py │ ├── conversation.py │ ├── conversation_all_of.py │ ├── conversation_create_body.py │ ├── conversation_create_event.py │ ├── conversation_create_event_all_of.py │ ├── conversation_create_event_all_of_payload.py │ ├── conversation_join_event.py │ ├── conversation_join_event_all_of.py │ ├── conversation_join_event_all_of_payload.py │ ├── conversation_leave_event.py │ ├── conversation_leave_event_all_of.py │ ├── conversation_leave_event_all_of_payload.py │ ├── conversation_list_filter.py │ ├── conversation_list_response.py │ ├── conversation_message_delivery_channel_event.py │ ├── conversation_message_delivery_channel_event_all_of.py │ ├── conversation_message_delivery_failure_event.py │ ├── conversation_message_delivery_failure_event_all_of.py │ ├── conversation_message_delivery_payload.py │ ├── conversation_message_delivery_payload_destination.py │ ├── conversation_message_delivery_payload_external_messages.py │ ├── conversation_message_delivery_payload_message.py │ ├── conversation_message_delivery_user_event.py │ ├── conversation_message_event.py │ ├── conversation_message_event_all_of.py │ ├── conversation_message_event_all_of_payload.py │ ├── conversation_postback_event.py │ ├── conversation_postback_event_all_of.py │ ├── conversation_postback_event_all_of_payload.py │ ├── conversation_read_event.py │ ├── conversation_read_event_all_of.py │ ├── conversation_read_event_all_of_payload.py │ ├── conversation_referral_event.py │ ├── conversation_referral_event_all_of.py │ ├── conversation_referral_event_all_of_payload.py │ ├── conversation_remove_event.py │ ├── conversation_remove_event_all_of.py │ ├── conversation_remove_event_all_of_payload.py │ ├── conversation_response.py │ ├── conversation_truncated.py │ ├── conversation_type.py │ ├── conversation_typing_event.py │ ├── conversation_typing_event_all_of.py │ ├── conversation_typing_event_all_of_payload.py │ ├── conversation_update_body.py │ ├── custom.py │ ├── custom_all_of.py │ ├── custom_update.py │ ├── default_responder.py │ ├── default_responder_default_responder.py │ ├── default_responder_id.py │ ├── destination.py │ ├── device.py │ ├── device_list_response.py │ ├── device_response.py │ ├── download_message_ref_body.py │ ├── download_message_ref_body_all_of.py │ ├── download_message_ref_body_all_of_apple.py │ ├── download_message_ref_body_all_of_apple_interactive_data_ref.py │ ├── error.py │ ├── error_response.py │ ├── event_sub_schema.py │ ├── extra_channel_options.py │ ├── extra_channel_options_messenger.py │ ├── field.py │ ├── file_message.py │ ├── form_message.py │ ├── form_message_field.py │ ├── form_message_field_all_of.py │ ├── form_response_message.py │ ├── form_response_message_field.py │ ├── form_response_message_field_all_of.py │ ├── identity.py │ ├── image_message.py │ ├── inline_object.py │ ├── instagram.py │ ├── instagram_all_of.py │ ├── instagram_update.py │ ├── instagram_update_all_of.py │ ├── integration.py │ ├── integration_api_key.py │ ├── integration_api_key_list_response.py │ ├── integration_api_key_response.py │ ├── integration_id.py │ ├── integration_list_filter.py │ ├── integration_list_response.py │ ├── integration_response.py │ ├── integration_type.py │ ├── integration_update.py │ ├── integration_update_base.py │ ├── ios.py │ ├── ios_all_of.py │ ├── ios_update.py │ ├── ios_update_all_of.py │ ├── item.py │ ├── line.py │ ├── line_all_of.py │ ├── line_update.py │ ├── link.py │ ├── links.py │ ├── list_message.py │ ├── location_message.py │ ├── location_message_coordinates.py │ ├── location_message_location.py │ ├── location_request.py │ ├── mailgun.py │ ├── mailgun_all_of.py │ ├── mailgun_update.py │ ├── mailgun_update_all_of.py │ ├── match_criteria.py │ ├── match_criteria_base.py │ ├── match_criteria_mailgun.py │ ├── match_criteria_mailgun_all_of.py │ ├── match_criteria_messagebird.py │ ├── match_criteria_messagebird_all_of.py │ ├── match_criteria_twilio.py │ ├── match_criteria_twilio_all_of.py │ ├── match_criteria_whatsapp.py │ ├── match_criteria_whatsapp_all_of.py │ ├── message.py │ ├── message_bird_update.py │ ├── message_list_response.py │ ├── message_override.py │ ├── message_override_apple.py │ ├── message_override_line.py │ ├── message_override_messenger.py │ ├── message_override_payload.py │ ├── message_override_whatsapp.py │ ├── message_post.py │ ├── message_post_response.py │ ├── message_webhook.py │ ├── messagebird.py │ ├── messagebird_all_of.py │ ├── messenger.py │ ├── messenger_all_of.py │ ├── messenger_update.py │ ├── meta.py │ ├── offer_control_body.py │ ├── page.py │ ├── participant.py │ ├── participant_join_body.py │ ├── participant_leave_body.py │ ├── participant_leave_body_participant_id.py │ ├── participant_leave_body_user_external_id.py │ ├── participant_leave_body_user_id.py │ ├── participant_list_response.py │ ├── participant_response.py │ ├── participant_sub_schema.py │ ├── participant_with_user_external_id.py │ ├── participant_with_user_id.py │ ├── pass_control_body.py │ ├── postback.py │ ├── postback_webhook.py │ ├── prechat_capture.py │ ├── profile.py │ ├── quoted_message.py │ ├── quoted_message_external_message_id.py │ ├── quoted_message_message.py │ ├── referral.py │ ├── referral_details.py │ ├── release_control_body.py │ ├── reply.py │ ├── source.py │ ├── source_webhook.py │ ├── source_with_campaign_webhook.py │ ├── source_with_campaign_webhook_all_of.py │ ├── status.py │ ├── switchboard.py │ ├── switchboard_accept_control.py │ ├── switchboard_accept_control_all_of.py │ ├── switchboard_accept_control_all_of_payload.py │ ├── switchboard_accept_control_failure.py │ ├── switchboard_accept_control_failure_all_of.py │ ├── switchboard_accept_control_failure_all_of_payload.py │ ├── switchboard_integration.py │ ├── switchboard_integration_create_body.py │ ├── switchboard_integration_list_response.py │ ├── switchboard_integration_response.py │ ├── switchboard_integration_update_body.py │ ├── switchboard_integration_webhook.py │ ├── switchboard_list_response.py │ ├── switchboard_offer_control.py │ ├── switchboard_offer_control_all_of.py │ ├── switchboard_offer_control_all_of_payload.py │ ├── switchboard_offer_control_failure.py │ ├── switchboard_pass_control.py │ ├── switchboard_pass_control_all_of.py │ ├── switchboard_pass_control_all_of_payload.py │ ├── switchboard_pass_control_failure.py │ ├── switchboard_response.py │ ├── switchboard_update_body.py │ ├── sync_user_body.py │ ├── target.py │ ├── telegram.py │ ├── telegram_all_of.py │ ├── telegram_update.py │ ├── template_message.py │ ├── text_message.py │ ├── ticket_closed.py │ ├── transfer_to_email.py │ ├── twilio.py │ ├── twilio_all_of.py │ ├── twilio_update.py │ ├── twitter.py │ ├── twitter_all_of.py │ ├── twitter_update.py │ ├── unity.py │ ├── unity_all_of.py │ ├── unity_update.py │ ├── unity_update_all_of.py │ ├── user.py │ ├── user_all_of.py │ ├── user_create_body.py │ ├── user_merge_event.py │ ├── user_merge_event_all_of.py │ ├── user_merge_event_all_of_payload.py │ ├── user_merge_event_all_of_payload_merged_clients.py │ ├── user_merge_event_all_of_payload_merged_conversations.py │ ├── user_merge_event_all_of_payload_merged_users.py │ ├── user_remove_event.py │ ├── user_remove_event_all_of.py │ ├── user_remove_event_all_of_payload.py │ ├── user_response.py │ ├── user_truncated.py │ ├── user_update_body.py │ ├── user_update_event.py │ ├── user_update_event_all_of.py │ ├── user_update_event_all_of_payload.py │ ├── viber.py │ ├── viber_all_of.py │ ├── viber_update.py │ ├── web.py │ ├── web_all_of.py │ ├── web_update.py │ ├── web_update_all_of.py │ ├── webhook.py │ ├── webhook_body.py │ ├── webhook_create_body.py │ ├── webhook_list_response.py │ ├── webhook_response.py │ ├── webhook_sub_schema.py │ ├── webview.py │ ├── whats_app_update.py │ ├── whats_app_update_all_of.py │ ├── whatsapp.py │ └── whatsapp_all_of.py ├── rest.py └── undefined.py ├── test-requirements.txt └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .venv/ 49 | .python-version 50 | .pytest_cache 51 | 52 | # Translations 53 | *.mo 54 | *.pot 55 | 56 | # Django stuff: 57 | *.log 58 | 59 | # Sphinx documentation 60 | docs/_build/ 61 | 62 | # PyBuilder 63 | target/ 64 | 65 | #Ipython Notebook 66 | .ipynb_checkpoints 67 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.gitlab.com/ee/ci/README.html 2 | 3 | stages: 4 | - test 5 | 6 | .nosetest: 7 | stage: test 8 | script: 9 | - pip install -r requirements.txt 10 | - pip install -r test-requirements.txt 11 | - pytest --cov=sunshine_conversations_client 12 | 13 | nosetest-2.7: 14 | extends: .nosetest 15 | image: python:2.7-alpine 16 | nosetest-3.3: 17 | extends: .nosetest 18 | image: python:3.3-alpine 19 | nosetest-3.4: 20 | extends: .nosetest 21 | image: python:3.4-alpine 22 | nosetest-3.5: 23 | extends: .nosetest 24 | image: python:3.5-alpine 25 | nosetest-3.6: 26 | extends: .nosetest 27 | image: python:3.6-alpine 28 | nosetest-3.7: 29 | extends: .nosetest 30 | image: python:3.7-alpine 31 | nosetest-3.8: 32 | extends: .nosetest 33 | image: python:3.8-alpine 34 | -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # Prevent generator from creating these files: 2 | git_push.sh 3 | .travis.yml 4 | mocha.opts 5 | -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 4.3.1 -------------------------------------------------------------------------------- /docs/AcceptControlBody.md: -------------------------------------------------------------------------------- 1 | # AcceptControlBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **metadata** | **dict** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:acceptControl` and `switchboard:acceptControl:failure` webhooks. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Activity.md: -------------------------------------------------------------------------------- 1 | # Activity 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | If the author type is `user`, only `conversation:read` is supported. | [optional] 7 | **source** | [**SourceWebhook**](SourceWebhook.md) | The source of the activity. | [optional] 8 | **author** | [**AuthorWebhook**](AuthorWebhook.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ActivityAllOf.md: -------------------------------------------------------------------------------- 1 | # ActivityAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **source** | [**SourceWebhook**](SourceWebhook.md) | The source of the activity. | [optional] 7 | **author** | [**AuthorWebhook**](AuthorWebhook.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ActivityMessage.md: -------------------------------------------------------------------------------- 1 | # ActivityMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of system activity that generated the message. The value of this field determines the dynamic content that is rendered to the end-user / agent when viewing this message. Each `type` value will have a set of pre-defined, localized strings that describe the activity. | [default to 'ticket:transfer:email'] 7 | **data** | **dict(str, object)** | No additional data is supplied with the \"ticket:transfer:email\" activity type at this time. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ActivityPost.md: -------------------------------------------------------------------------------- 1 | # ActivityPost 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **author** | [**Author**](Author.md) | The author of the activity. | 7 | **type** | **str** | If the author type is `user`, only `conversation:read` is supported. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ActivityPostAllOf.md: -------------------------------------------------------------------------------- 1 | # ActivityPostAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **author** | [**Author**](Author.md) | The author of the activity. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ActivityTypes.md: -------------------------------------------------------------------------------- 1 | # ActivityTypes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | If the author type is `user`, only `conversation:read` is supported. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AndroidUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # AndroidUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **project_id** | **str** | Your project ID from your generated private key file. | [optional] 7 | **client_email** | **str** | Your client email from your generated private key file. | [optional] 8 | **private_key** | **str** | Your private key from your generated private key file. | [optional] 9 | **server_key** | **str** | Your server key from the fcm console. | [optional] 10 | **sender_id** | **str** | Your sender id from the fcm console. | [optional] 11 | **can_user_see_conversation_list** | **bool** | 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] 12 | **can_user_create_more_conversations** | **bool** | Allows users to create more than one conversation on the android integration. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ApiKey.md: -------------------------------------------------------------------------------- 1 | # ApiKey 2 | 3 | The integration key. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | The unique ID of the API key, used when signing JWTs or accessing the API using Basic Authentication. | [optional] 8 | **display_name** | **str** | The name of the API key. | [optional] 9 | **secret** | **str** | The secret of the API key, used when signing JWTs or accessing the API using Basic Authentication | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/App.md: -------------------------------------------------------------------------------- 1 | # App 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | A canonical ID that can be used to retrieve the Sunshine Conversations app. | [optional] 7 | **display_name** | **str** | The friendly name of the app. | [optional] 8 | **settings** | [**AppSettings**](AppSettings.md) | | [optional] 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AppCreateBody.md: -------------------------------------------------------------------------------- 1 | # AppCreateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | The friendly name of the app. | 7 | **settings** | [**AppSettings**](AppSettings.md) | | [optional] 8 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AppKey.md: -------------------------------------------------------------------------------- 1 | # AppKey 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the API key, used when signing JWTs or accessing the API using Basic Authentication. | [optional] 7 | **display_name** | **str** | The name of the API key. | [optional] 8 | **secret** | **str** | The secret of the API key, used when signing JWTs or accessing the API using Basic Authentication | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AppKeyCreateBody.md: -------------------------------------------------------------------------------- 1 | # AppKeyCreateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | The name of the API key. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AppKeyListResponse.md: -------------------------------------------------------------------------------- 1 | # AppKeyListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **keys** | [**list[AppKey]**](AppKey.md) | List of returned keys. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AppKeyResponse.md: -------------------------------------------------------------------------------- 1 | # AppKeyResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | [**AppKey**](AppKey.md) | The created key object. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AppListFilter.md: -------------------------------------------------------------------------------- 1 | # AppListFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **service_account_id** | **str** | When specified, lists only the apps that the service account has access to. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AppListResponse.md: -------------------------------------------------------------------------------- 1 | # AppListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **apps** | [**list[App]**](App.md) | List of returned apps. | [optional] 7 | **meta** | [**Meta**](Meta.md) | | [optional] 8 | **links** | [**Links**](Links.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AppResponse.md: -------------------------------------------------------------------------------- 1 | # AppResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **app** | [**App**](App.md) | The app. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AppSubSchema.md: -------------------------------------------------------------------------------- 1 | # AppSubSchema 2 | 3 | The app that triggered the events. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | The unique ID of the app. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AppUpdateBody.md: -------------------------------------------------------------------------------- 1 | # AppUpdateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | The friendly name of the app. | [optional] 7 | **settings** | [**AppSettings**](AppSettings.md) | | [optional] 8 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Apple.md: -------------------------------------------------------------------------------- 1 | # Apple 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure an Apple Messages for Business integration, acquire the required information and call the Create Integration endpoint. | [optional] [default to 'apple'] 7 | **business_id** | **str** | Apple Messages for Business ID. | 8 | **api_secret** | **str** | Your Apple API secret which is tied to your Messaging Service Provider. | 9 | **msp_id** | **str** | Your Messaging Service Provider ID. | 10 | **authentication_message_secret** | **str** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional] 11 | **default_responder_id** | **str** | 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 | **default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/AppleAllOf.md: -------------------------------------------------------------------------------- 1 | # AppleAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure an Apple Messages for Business integration, acquire the required information and call the Create Integration endpoint. | [optional] [default to 'apple'] 7 | **business_id** | **str** | Apple Messages for Business ID. | 8 | **api_secret** | **str** | Your Apple API secret which is tied to your Messaging Service Provider. | 9 | **msp_id** | **str** | Your Messaging Service Provider ID. | 10 | **authentication_message_secret** | **str** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/AppleMessageOverridePayload.md: -------------------------------------------------------------------------------- 1 | # AppleMessageOverridePayload 2 | 3 | The exact payload to send to the channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **payload** | [**object**](.md) | | [optional] 8 | **with_capabilities** | **list[str]** | List of capabilities needed for the override message to be received by the end user. `LIST` : for list picker; `TIME` : for time picker; `FORM` : for form; `QUICK` : for quick reply; `AUTH2` : for authentication | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AppleUpdate.md: -------------------------------------------------------------------------------- 1 | # AppleUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 7 | **default_responder_id** | **str** | 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 | **authentication_message_secret** | **str** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AppleUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # AppleUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **authentication_message_secret** | **str** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AttachmentDeleteBody.md: -------------------------------------------------------------------------------- 1 | # AttachmentDeleteBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **media_url** | **str** | The media URL used for a file or image message. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AttachmentResponse.md: -------------------------------------------------------------------------------- 1 | # AttachmentResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **attachment** | [**AttachmentSchema**](AttachmentSchema.md) | The uploaded attachment object. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AttachmentSchema.md: -------------------------------------------------------------------------------- 1 | # AttachmentSchema 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **media_url** | **str** | Uploaded attachment’s url. <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> | [optional] 7 | **media_type** | **str** | Uploaded attachment's media type | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AttachmentUploadBody.md: -------------------------------------------------------------------------------- 1 | # AttachmentUploadBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **source** | **file** | | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Author.md: -------------------------------------------------------------------------------- 1 | # Author 2 | 3 | The author of the message. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The author type. Either \"user\" (representing the end user) or \"business\" (sent on behalf of the business). | 8 | **subtypes** | **list[str]** | A string array that indicates the author's subtypes. Messages from \"business\" type with an \"AI\" subtype are generated by AI and a disclaimer is appended to the text of the message sent to the customer. For third-party channels, the disclaimer is applied for image, file, and text message types. Message with an \"activity\" subtype are generated by system activities. | [optional] 9 | **user_id** | **str** | The id of the user. Only supported when `type` is user. | [optional] 10 | **user_external_id** | **str** | The externalId of the user. Only supported when `type` is user. | [optional] 11 | **display_name** | **str** | The display name of the message author. | [optional] 12 | **avatar_url** | **str** | A custom message icon URL. The image must be JPG, PNG, or GIF format. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/AuthorWebhook.md: -------------------------------------------------------------------------------- 1 | # AuthorWebhook 2 | 3 | The author of the activity. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The `type` of the author. | 8 | **user_id** | **str** | The id of the user. Only supported when author `type` is `user`. | [optional] 9 | **user** | [**User**](User.md) | The user that authored the message or activity. `profile` is included in the payload if the `includeFullUser` option is enabled. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Buy.md: -------------------------------------------------------------------------------- 1 | # Buy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of action. | [default to 'buy'] 7 | **text** | **str** | The button text. | 8 | **amount** | **int** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 9 | **currency** | **str** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [optional] 10 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Campaign.md: -------------------------------------------------------------------------------- 1 | # Campaign 2 | 3 | The campaign the user interacted with (if applicable). 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | The unique ID of the campaign. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CarouselMessageDisplaySettings.md: -------------------------------------------------------------------------------- 1 | # CarouselMessageDisplaySettings 2 | 3 | Settings to adjust the carousel layout. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **image_aspect_ratio** | **str** | Specifies how to display all carousel images. Valid values are horizontal (default) and square. Only supported in Facebook Messenger, Web Messenger, Android SDK and iOS SDK carousels. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ClientAddEvent.md: -------------------------------------------------------------------------------- 1 | # ClientAddEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ClientAddEventAllOfPayload**](ClientAddEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ClientAddEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ClientAddEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ClientAddEventAllOfPayload**](ClientAddEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ClientAssociation.md: -------------------------------------------------------------------------------- 1 | # ClientAssociation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | [**ClientType**](ClientType.md) | | [optional] 7 | **client_id** | **str** | The id of the client being referenced. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ClientCreate.md: -------------------------------------------------------------------------------- 1 | # ClientCreate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **match_criteria** | [**MatchCriteria**](MatchCriteria.md) | | 7 | **confirmation** | [**Confirmation**](Confirmation.md) | | 8 | **target** | [**Target**](Target.md) | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ClientListResponse.md: -------------------------------------------------------------------------------- 1 | # ClientListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **clients** | [**list[Client]**](Client.md) | List of returned clients. | [optional] 7 | **meta** | [**Meta**](Meta.md) | | [optional] 8 | **links** | [**Links**](Links.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ClientRemoveEvent.md: -------------------------------------------------------------------------------- 1 | # ClientRemoveEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ClientRemoveEventAllOfPayload**](ClientRemoveEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ClientRemoveEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ClientRemoveEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ClientRemoveEventAllOfPayload**](ClientRemoveEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ClientResponse.md: -------------------------------------------------------------------------------- 1 | # ClientResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **client** | [**Client**](Client.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ClientType.md: -------------------------------------------------------------------------------- 1 | # ClientType 2 | 3 | The type of integration that the client represents. Can be any of the supported integration types, or sdk for integrations of type ios, android, unity and web. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ClientUpdateEvent.md: -------------------------------------------------------------------------------- 1 | # ClientUpdateEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ClientUpdateEventAllOfPayload**](ClientUpdateEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ClientUpdateEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ClientUpdateEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ClientUpdateEventAllOfPayload**](ClientUpdateEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ClientUpdateEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ClientUpdateEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation which triggered a change in the client. | [optional] 8 | **user** | [**UserTruncated**](UserTruncated.md) | The user associated with the client. | [optional] 9 | **client** | [**Client**](Client.md) | The updated client. | [optional] 10 | **reason** | **str** | The reason for which the client was updated. * `confirmed` - The client is now active and ready to use. * `blocked` - The user has unsubscribed from the conversation. * `unblocked` - A previously unsubscribed user resubscribed to the conversation. * `matched` - The channel found a user that matches the information provided. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Confirmation.md: -------------------------------------------------------------------------------- 1 | # Confirmation 2 | 3 | The confirmation options of the link request. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of confirmation. | 8 | **message** | [**MessagePost**](MessagePost.md) | The message used to reach out to the user, if desired. Messages sent via this method can only be of type text and image. If actions are included they can only be of type link. The confirmation message will not be added to the user’s conversation. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationCreateBody.md: -------------------------------------------------------------------------------- 1 | # ConversationCreateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | [**ConversationType**](ConversationType.md) | | 7 | **participants** | [**list[ParticipantSubSchema]**](ParticipantSubSchema.md) | The users participating in the conversation. For `personal` conversations, this field is required with a length of exactly 1. For `sdkGroup` conversations, must have a length less than or equal to 10. Can be omitted to have a conversation with no participants if the type is `sdkGroup`. | [optional] 8 | **display_name** | **str** | A friendly name for the conversation, may be displayed to the business or the user. | [optional] 9 | **description** | **str** | A short text describing the conversation. | [optional] 10 | **icon_url** | **str** | A custom conversation icon url. The image must be in either JPG, PNG, or GIF format | [optional] 11 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ConversationCreateEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationCreateEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationCreateEventAllOfPayload**](ConversationCreateEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationCreateEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationCreateEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationCreateEventAllOfPayload**](ConversationCreateEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationJoinEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationJoinEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationJoinEventAllOfPayload**](ConversationJoinEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationJoinEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationJoinEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationJoinEventAllOfPayload**](ConversationJoinEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationJoinEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationJoinEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the user was added. | [optional] 8 | **user** | [**UserTruncated**](UserTruncated.md) | The user that joined the conversation. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationLeaveEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationLeaveEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationLeaveEventAllOfPayload**](ConversationLeaveEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationLeaveEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationLeaveEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationLeaveEventAllOfPayload**](ConversationLeaveEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationLeaveEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationLeaveEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the user was removed. | [optional] 8 | **user** | [**UserTruncated**](UserTruncated.md) | The user that left the conversation. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationListFilter.md: -------------------------------------------------------------------------------- 1 | # ConversationListFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_id** | **str** | The user's id. One of `userId` or `userExternalId` is required, but not both. | [optional] 7 | **user_external_id** | **str** | The external Id of the user. One of `userId` or `userExternalId` is required, but not both. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ConversationListResponse.md: -------------------------------------------------------------------------------- 1 | # ConversationListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **conversations** | [**list[Conversation]**](Conversation.md) | List of returned conversations. | [optional] 7 | **meta** | [**Meta**](Meta.md) | | [optional] 8 | **links** | [**Links**](Links.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryChannelEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryChannelEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationMessageDeliveryPayload**](ConversationMessageDeliveryPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryChannelEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryChannelEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationMessageDeliveryPayload**](ConversationMessageDeliveryPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryFailureEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryFailureEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationMessageDeliveryPayload**](ConversationMessageDeliveryPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryFailureEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryFailureEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationMessageDeliveryPayload**](ConversationMessageDeliveryPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryPayloadDestination.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryPayloadDestination 2 | 3 | A nested object representing the destination of the message. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | An identifier for the channel to which a message was sent to. May include one of \"web\", \"ios\", \"android\", \"messenger\", \"viber\", \"telegram\", \"wechat\", \"line\", \"twilio\", \"api\", \"notification\", or any other channel. | [optional] 8 | **integration_id** | **str** | Identifier indicating which integration the message was sent to. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryPayloadExternalMessages.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryPayloadExternalMessages 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | A string representing the ID of the external message. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryPayloadMessage.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryPayloadMessage 2 | 3 | The message that was sent. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | A string representing the ID of the message. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ConversationMessageDeliveryUserEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageDeliveryUserEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationMessageDeliveryPayload**](ConversationMessageDeliveryPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationMessageEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationMessageEventAllOfPayload**](ConversationMessageEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationMessageEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationMessageEventAllOfPayload**](ConversationMessageEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationMessageEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationMessageEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the message was sent. | [optional] 8 | **message** | [**MessageWebhook**](MessageWebhook.md) | The message that was sent. | [optional] 9 | **recent_notifications** | [**list[MessageWebhook]**](MessageWebhook.md) | Messages sent with the Notification API since the last user message. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationPostbackEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationPostbackEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationPostbackEventAllOfPayload**](ConversationPostbackEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationPostbackEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationPostbackEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationPostbackEventAllOfPayload**](ConversationPostbackEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationPostbackEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationPostbackEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **postback** | [**PostbackWebhook**](PostbackWebhook.md) | The postback associated with the event. | [optional] 8 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation linked to the postback. | [optional] 9 | **user** | [**User**](User.md) | The user that triggered the postback. | [optional] 10 | **source** | [**SourceWithCampaignWebhook**](SourceWithCampaignWebhook.md) | The source of the postback. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ConversationReadEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationReadEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationReadEventAllOfPayload**](ConversationReadEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationReadEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationReadEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationReadEventAllOfPayload**](ConversationReadEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationReadEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationReadEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the message was read. | [optional] 8 | **activity** | [**Activity**](Activity.md) | The activity that was sent. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationReferralEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationReferralEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationReferralEventAllOfPayload**](ConversationReferralEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationReferralEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationReferralEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationReferralEventAllOfPayload**](ConversationReferralEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationReferralEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationReferralEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 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 | **user** | [**User**](User.md) | The user associated with the conversation. | [optional] 9 | **source** | [**SourceWithCampaignWebhook**](SourceWithCampaignWebhook.md) | The source of the referral. | [optional] 10 | **referral** | [**Referral**](Referral.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ConversationRemoveEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationRemoveEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationRemoveEventAllOfPayload**](ConversationRemoveEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationRemoveEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationRemoveEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationRemoveEventAllOfPayload**](ConversationRemoveEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationRemoveEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationRemoveEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that was deleted. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ConversationResponse.md: -------------------------------------------------------------------------------- 1 | # ConversationResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **conversation** | [**Conversation**](Conversation.md) | The conversation. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationTruncated.md: -------------------------------------------------------------------------------- 1 | # ConversationTruncated 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the conversation. | [optional] 7 | **type** | [**ConversationType**](ConversationType.md) | | [optional] 8 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 9 | **active_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation. | [optional] 10 | **pending_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ConversationType.md: -------------------------------------------------------------------------------- 1 | # ConversationType 2 | 3 | The type of the conversation. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationTypingEvent.md: -------------------------------------------------------------------------------- 1 | # ConversationTypingEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**ConversationTypingEventAllOfPayload**](ConversationTypingEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationTypingEventAllOf.md: -------------------------------------------------------------------------------- 1 | # ConversationTypingEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**ConversationTypingEventAllOfPayload**](ConversationTypingEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationTypingEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # ConversationTypingEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the activity was sent. | [optional] 8 | **activity** | [**Activity**](Activity.md) | The activity that was sent. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ConversationUpdateBody.md: -------------------------------------------------------------------------------- 1 | # ConversationUpdateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A friendly name for the conversation, may be displayed to the business or the user. | [optional] 7 | **description** | **str** | A short text describing the conversation. | [optional] 8 | **icon_url** | **str** | A custom conversation icon url. The image must be in either JPG, PNG, or GIF format | [optional] 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Custom.md: -------------------------------------------------------------------------------- 1 | # Custom 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a custom integration you need to setup a webhook with a set of triggers and target. | [optional] [default to 'custom'] 7 | **webhooks** | [**list[Webhook]**](Webhook.md) | An array of webhooks associated with the custom integration. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CustomAllOf.md: -------------------------------------------------------------------------------- 1 | # CustomAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a custom integration you need to setup a webhook with a set of triggers and target. | [optional] [default to 'custom'] 7 | **webhooks** | [**list[Webhook]**](Webhook.md) | An array of webhooks associated with the custom integration. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CustomUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DefaultResponder.md: -------------------------------------------------------------------------------- 1 | # DefaultResponder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DefaultResponderId.md: -------------------------------------------------------------------------------- 1 | # DefaultResponderId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **default_responder_id** | **str** | 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] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Destination.md: -------------------------------------------------------------------------------- 1 | # Destination 2 | 3 | The destination of the message, in the case of [channel targeting](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/sending-messages/#targeting-a-specific-channel) or sending [silent messages](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/sending-messages/#silent-messages). Only applicable if the author role is `business` and the conversation is of type `personal`. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **integration_id** | **str** | 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** | **str** | 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 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/DeviceListResponse.md: -------------------------------------------------------------------------------- 1 | # DeviceListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **devices** | [**list[Device]**](Device.md) | List of returned devices. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DeviceResponse.md: -------------------------------------------------------------------------------- 1 | # DeviceResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **device** | [**Device**](Device.md) | The device. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DownloadMessageRefBody.md: -------------------------------------------------------------------------------- 1 | # DownloadMessageRefBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DownloadMessageRefBodyAllOf.md: -------------------------------------------------------------------------------- 1 | # DownloadMessageRefBodyAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_id** | **str** | The id of the user. | [optional] 7 | **apple** | [**DownloadMessageRefBodyAllOfApple**](DownloadMessageRefBodyAllOfApple.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DownloadMessageRefBodyAllOfApple.md: -------------------------------------------------------------------------------- 1 | # DownloadMessageRefBodyAllOfApple 2 | 3 | The message ref returned by Apple. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **interactive_data_ref** | [**DownloadMessageRefBodyAllOfAppleInteractiveDataRef**](DownloadMessageRefBodyAllOfAppleInteractiveDataRef.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DownloadMessageRefBodyAllOfAppleInteractiveDataRef.md: -------------------------------------------------------------------------------- 1 | # DownloadMessageRefBodyAllOfAppleInteractiveDataRef 2 | 3 | interactiveDataRef can be found in the passthrough webhook. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **str** | | 8 | **bid** | **str** | | 9 | **key** | **str** | | 10 | **signature** | **str** | | 11 | **owner** | **str** | | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **str** | Error code used for classifying similar error types | [optional] 7 | **title** | **str** | Description of the error | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ErrorResponse.md: -------------------------------------------------------------------------------- 1 | # ErrorResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **errors** | [**list[Error]**](Error.md) | List of errors that occurred. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/EventSubSchema.md: -------------------------------------------------------------------------------- 1 | # EventSubSchema 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ExtraChannelOptions.md: -------------------------------------------------------------------------------- 1 | # ExtraChannelOptions 2 | 3 | Extra options to pass directly to the channel API. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messenger** | [**ExtraChannelOptionsMessenger**](ExtraChannelOptionsMessenger.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ExtraChannelOptionsMessenger.md: -------------------------------------------------------------------------------- 1 | # ExtraChannelOptionsMessenger 2 | 3 | Messenger channel options. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messenger_extensions** | **bool** | For webview type actions, a boolean value indicating whether the URL should be loaded with Messenger Extensions enabled. [More info](https://developers.facebook.com/docs/messenger-platform/send-api-reference/url-button). | [optional] [default to False] 8 | **webview_share_button** | **str** | For webview type actions, a string value indicating if the share button should be hidden. [More Info](https://developers.facebook.com/docs/messenger-platform/reference/buttons/url). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Field.md: -------------------------------------------------------------------------------- 1 | # Field 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The field type. | 7 | **name** | **str** | The name of the field. Must be unique per form or formResponse. | 8 | **label** | **str** | The label of the field. What the field is displayed as on Web Messenger. | 9 | **text** | **str** | Specifies the response for a text field. | [optional] 10 | **email** | **str** | Specifies the response for a email field. | [optional] 11 | **select** | **list[object]** | Array of objects representing the response for a field of type select. Form and formResponse messages only. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/FormMessage.md: -------------------------------------------------------------------------------- 1 | # FormMessage 2 | 3 | A form type message without text or actions. Only supported in the Web SDK. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of message. | [default to 'form'] 8 | **submitted** | **bool** | Flag which states whether the form is submitted. | [optional] [readonly] 9 | **block_chat_input** | **bool** | 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] 10 | **fields** | [**list[FormMessageField]**](FormMessageField.md) | An array of objects representing fields associated with the message. Only present in form and formResponse messages. | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/FormMessageField.md: -------------------------------------------------------------------------------- 1 | # FormMessageField 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The field type. | 7 | **name** | **str** | The name of the field. Must be unique per form or formResponse. | 8 | **label** | **str** | The label of the field. What the field is displayed as on Web Messenger. | 9 | **text** | **str** | Specifies the response for a text field. | [optional] 10 | **email** | **str** | Specifies the response for a email field. | [optional] 11 | **select** | **list[object]** | Array of objects representing the response for a field of type select. Form and formResponse messages only. | [optional] 12 | **placeholder** | **str** | Placeholder text for the field. Form message only. | [optional] 13 | **min_size** | **int** | The minimum allowed length for the response for a field of type text. Form message only. | [optional] [default to 1] 14 | **max_size** | **int** | The maximum allowed length for the response for a field of type text. Form message only. | [optional] [default to 128] 15 | **options** | **list[object]** | Array of objects representing options for a field of type select. | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/FormMessageFieldAllOf.md: -------------------------------------------------------------------------------- 1 | # FormMessageFieldAllOf 2 | 3 | Properties that can be expected to receive inside a form message field. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **placeholder** | **str** | Placeholder text for the field. Form message only. | [optional] 8 | **min_size** | **int** | The minimum allowed length for the response for a field of type text. Form message only. | [optional] [default to 1] 9 | **max_size** | **int** | The maximum allowed length for the response for a field of type text. Form message only. | [optional] [default to 128] 10 | **options** | **list[object]** | Array of objects representing options for a field of type select. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/FormResponseMessage.md: -------------------------------------------------------------------------------- 1 | # FormResponseMessage 2 | 3 | A formResponse type message is a response to a form type message. formResponse type messages are only supported as responses to form messages on Web Messenger and cannot be sent via the API. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of message. | [default to 'formResponse'] 8 | **fields** | [**list[FormResponseMessageField]**](FormResponseMessageField.md) | Array of field objects that contain the submitted fields. | 9 | **text_fallback** | **str** | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/FormResponseMessageField.md: -------------------------------------------------------------------------------- 1 | # FormResponseMessageField 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The field type. | 7 | **name** | **str** | The name of the field. Must be unique per form or formResponse. | 8 | **label** | **str** | The label of the field. What the field is displayed as on Web Messenger. | 9 | **text** | **str** | Specifies the response for a text field. | [optional] 10 | **email** | **str** | Specifies the response for a email field. | [optional] 11 | **select** | **list[object]** | Array of objects representing the response for a field of type select. Form and formResponse messages only. | [optional] 12 | **quoted_message_id** | **str** | The messageId for the form that this response belongs to. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/FormResponseMessageFieldAllOf.md: -------------------------------------------------------------------------------- 1 | # FormResponseMessageFieldAllOf 2 | 3 | Properties that can be expected to receive inside a form response message field. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **quoted_message_id** | **str** | The messageId for the form that this response belongs to. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Identity.md: -------------------------------------------------------------------------------- 1 | # Identity 2 | 3 | A connected user identity, such as an email. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of identity. | [optional] 8 | **value** | **str** | The identity value. | [optional] 9 | **verification** | **str** | The type of verification performed on the identity. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InlineObject.md: -------------------------------------------------------------------------------- 1 | # InlineObject 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **str** | The authorization code received via the OAuth flow | 7 | **grant_type** | **str** | Must be set to the string `authorization_code` | 8 | **client_id** | **str** | Your OAuth client ID, provisioned during the partner application process | 9 | **client_secret** | **str** | Your OAuth client secret, provisioned during the partner application process | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InstagramUpdate.md: -------------------------------------------------------------------------------- 1 | # InstagramUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 7 | **default_responder_id** | **str** | 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 | **page_access_token** | **str** | A Facebook Page Access Token. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InstagramUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # InstagramUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **page_access_token** | **str** | A Facebook Page Access Token. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Integration.md: -------------------------------------------------------------------------------- 1 | # Integration 2 | 3 | The integration. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | The unique ID of the integration. | [optional] [readonly] 8 | **type** | **str** | | 9 | **status** | [**Status**](Status.md) | | [optional] 10 | **display_name** | **str** | A human-friendly name used to identify the integration. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/IntegrationApiKey.md: -------------------------------------------------------------------------------- 1 | # IntegrationApiKey 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | The name of the API key. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationApiKeyListResponse.md: -------------------------------------------------------------------------------- 1 | # IntegrationApiKeyListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **keys** | [**list[ApiKey]**](ApiKey.md) | Integration keys of the supplied integration. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationApiKeyResponse.md: -------------------------------------------------------------------------------- 1 | # IntegrationApiKeyResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | [**ApiKey**](ApiKey.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationId.md: -------------------------------------------------------------------------------- 1 | # IntegrationId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **integration_id** | **str** | 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] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationListFilter.md: -------------------------------------------------------------------------------- 1 | # IntegrationListFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **types** | **str** | Comma-separated list of types to return. If omitted, all types are returned. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationListResponse.md: -------------------------------------------------------------------------------- 1 | # IntegrationListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **integrations** | [**list[Integration]**](Integration.md) | List of returned integrations. | [optional] 7 | **meta** | [**Meta**](Meta.md) | | [optional] 8 | **links** | [**Links**](Links.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/IntegrationResponse.md: -------------------------------------------------------------------------------- 1 | # IntegrationResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **integration** | [**Integration**](Integration.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationType.md: -------------------------------------------------------------------------------- 1 | # IntegrationType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **integration_type** | **str** | 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] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IntegrationUpdateBase.md: -------------------------------------------------------------------------------- 1 | # IntegrationUpdateBase 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 7 | **default_responder_id** | **str** | 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 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/IosUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # IosUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **certificate** | **str** | The binary of your APN certificate base64 encoded. | [optional] 7 | **password** | **str** | The password for your APN certificate. | [optional] 8 | **production** | **bool** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 9 | **auto_update_badge** | **bool** | Use the unread count of the conversation as the application badge. | [optional] 10 | **can_user_see_conversation_list** | **bool** | 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] 11 | **can_user_create_more_conversations** | **bool** | Allows users to create more than one conversation on the iOS integration. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Item.md: -------------------------------------------------------------------------------- 1 | # Item 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **title** | **str** | The title of the item. | 7 | **description** | **str** | The description of the item. | [optional] 8 | **media_url** | **str** | The image url attached to the item. | [optional] 9 | **media_type** | **str** | The MIME type for any image attached in the mediaUrl. | [optional] 10 | **alt_text** | **str** | An optional description of the media for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 11 | **size** | **str** | The size of the image. | [optional] 12 | **actions** | [**list[ActionSubset]**](ActionSubset.md) | An array of objects representing the actions associated with the item. | 13 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/LineUpdate.md: -------------------------------------------------------------------------------- 1 | # LineUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Link.md: -------------------------------------------------------------------------------- 1 | # Link 2 | 3 | A link action will open the provided URI when tapped. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of action. | [default to 'link'] 8 | **uri** | **str** | The action URI. This is the link that will be used in the clients when clicking the button. | 9 | **text** | **str** | The button text. | 10 | **default** | **bool** | Boolean value indicating whether the action is the default action for a message item in Facebook Messenger. | [optional] 11 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 12 | **extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Links.md: -------------------------------------------------------------------------------- 1 | # Links 2 | 3 | Previous and next page links, if they exist. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **prev** | **str** | A link to the previous page. Not specified if there are no previous pages. | [optional] 8 | **next** | **str** | A link to the next page. Not specified if there are no subsequent pages. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/LocationMessage.md: -------------------------------------------------------------------------------- 1 | # LocationMessage 2 | 3 | A location type message includes the coordinates (latitude and longitude) of a location and an optional location object which can include the name and address of the location. Typically sent in response to a Location Request. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of message. | [default to 'location'] 8 | **text** | **str** | The fallback text message used when location messages are not supported by the channel. | [optional] [readonly] 9 | **block_chat_input** | **bool** | 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] 10 | **coordinates** | [**LocationMessageCoordinates**](LocationMessageCoordinates.md) | | 11 | **location** | [**LocationMessageLocation**](LocationMessageLocation.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/LocationMessageCoordinates.md: -------------------------------------------------------------------------------- 1 | # LocationMessageCoordinates 2 | 3 | The coordinates of the location. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **lat** | **float** | Global latitude. | 8 | **long** | **float** | Global longitude. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/LocationMessageLocation.md: -------------------------------------------------------------------------------- 1 | # LocationMessageLocation 2 | 3 | Information about the location. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | **str** | A string representing the address of the location. | [optional] 8 | **name** | **str** | A string representing the name of the location. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/LocationRequest.md: -------------------------------------------------------------------------------- 1 | # LocationRequest 2 | 3 | A location request action will prompt the user to share their location. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The type of action. | [default to 'locationRequest'] 8 | **text** | **str** | The button text. | 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MailgunUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # MailgunUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **hide_unsubscribe_link** | **bool** | 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] 7 | **from_address** | **str** | 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] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MatchCriteria.md: -------------------------------------------------------------------------------- 1 | # MatchCriteria 2 | 3 | The set of criteria used to determine the user's identity on a third-party channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The channel type. | [default to 'whatsapp'] 8 | **integration_id** | **str** | The ID of the integration to link. Must match the provided type. | 9 | **primary** | **bool** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to True] 10 | **address** | **str** | The user’s email address. | 11 | **subject** | **str** | May be specified to set the subject for the outgoing email. | [optional] [default to 'New message from {appName}'] 12 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/MatchCriteriaBase.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaBase 2 | 3 | The set of criteria used to determine the user's identity on a third-party channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The channel type. | 8 | **integration_id** | **str** | The ID of the integration to link. Must match the provided type. | 9 | **primary** | **bool** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to True] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MatchCriteriaMailgun.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaMailgun 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The channel type. | [default to 'mailgun'] 7 | **integration_id** | **str** | The ID of the integration to link. Must match the provided type. | 8 | **primary** | **bool** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to True] 9 | **address** | **str** | The user’s email address. | 10 | **subject** | **str** | May be specified to set the subject for the outgoing email. | [optional] [default to 'New message from {appName}'] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/MatchCriteriaMailgunAllOf.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaMailgunAllOf 2 | 3 | The set of criteria used to determine the user's identity on a third-party channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The channel type. | [optional] [default to 'mailgun'] 8 | **address** | **str** | The user’s email address. | 9 | **subject** | **str** | May be specified to set the subject for the outgoing email. | [optional] [default to 'New message from {appName}'] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MatchCriteriaMessagebird.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaMessagebird 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The channel type. | [default to 'messagebird'] 7 | **integration_id** | **str** | The ID of the integration to link. Must match the provided type. | 8 | **primary** | **bool** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to True] 9 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MatchCriteriaMessagebirdAllOf.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaMessagebirdAllOf 2 | 3 | The set of criteria used to determine the user's identity on a third-party channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The channel type. | [optional] [default to 'messagebird'] 8 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MatchCriteriaTwilio.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaTwilio 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The channel type. | [default to 'twilio'] 7 | **integration_id** | **str** | The ID of the integration to link. Must match the provided type. | 8 | **primary** | **bool** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to True] 9 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MatchCriteriaTwilioAllOf.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaTwilioAllOf 2 | 3 | The set of criteria used to determine the user's identity on a third-party channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The channel type. | [optional] [default to 'twilio'] 8 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MatchCriteriaWhatsapp.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaWhatsapp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The channel type. | [default to 'whatsapp'] 7 | **integration_id** | **str** | The ID of the integration to link. Must match the provided type. | 8 | **primary** | **bool** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to True] 9 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MatchCriteriaWhatsappAllOf.md: -------------------------------------------------------------------------------- 1 | # MatchCriteriaWhatsappAllOf 2 | 3 | The set of criteria used to determine the user's identity on a third-party channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **str** | The channel type. | [optional] [default to 'whatsapp'] 8 | **phone_number** | **str** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MessageBirdUpdate.md: -------------------------------------------------------------------------------- 1 | # MessageBirdUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/MessageListResponse.md: -------------------------------------------------------------------------------- 1 | # MessageListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messages** | [**list[Message]**](Message.md) | List of returned messages. | [optional] 7 | **meta** | [**Meta**](Meta.md) | | [optional] 8 | **links** | [**Links**](Links.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MessageOverride.md: -------------------------------------------------------------------------------- 1 | # MessageOverride 2 | 3 | A raw payload containing a message that is sent directly to a channel. Messages for [Apple Messages for Business](https://docs.smooch.io/guide/apple-messages-for-business/#passthrough-api), [Line](https://docs.smooch.io/guide/line/#passthrough-api), [Messenger](https://docs.smooch.io/guide/facebook-messenger/#passthrough-api), [Whatsapp](https://docs.smooch.io/guide/whatsapp/#passthrough-api) channels are supported. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **apple** | [**AppleMessageOverridePayload**](AppleMessageOverridePayload.md) | | [optional] 8 | **line** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional] 9 | **messenger** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional] 10 | **whatsapp** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/MessageOverrideApple.md: -------------------------------------------------------------------------------- 1 | # MessageOverrideApple 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **apple** | [**AppleMessageOverridePayload**](AppleMessageOverridePayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MessageOverrideLine.md: -------------------------------------------------------------------------------- 1 | # MessageOverrideLine 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **line** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MessageOverrideMessenger.md: -------------------------------------------------------------------------------- 1 | # MessageOverrideMessenger 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messenger** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MessageOverridePayload.md: -------------------------------------------------------------------------------- 1 | # MessageOverridePayload 2 | 3 | The exact payload to send to the channel. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **payload** | [**object**](.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MessageOverrideWhatsapp.md: -------------------------------------------------------------------------------- 1 | # MessageOverrideWhatsapp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **whatsapp** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MessagePost.md: -------------------------------------------------------------------------------- 1 | # MessagePost 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **author** | [**Author**](Author.md) | The author of the message. | 7 | **content** | [**Content**](Content.md) | The content of the message. | 8 | **destination** | [**Destination**](Destination.md) | | [optional] 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | **override** | [**MessageOverride**](MessageOverride.md) | | [optional] 11 | **schema** | **str** | When `schema` is set to `\"whatsapp\"`, the `content` key is expected to conform to the [native WhatsApp schema](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates) for sending message templates. For more details, consult the documentation for [sending message templates on WhatsApp](https://docs.smooch.io/guide/whatsapp/#sending-message-templates). | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MessagePostResponse.md: -------------------------------------------------------------------------------- 1 | # MessagePostResponse 2 | 3 | The created messages. A single request may produce multiple messages when the shorthand syntax is used to send a template message with leading text. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messages** | [**list[Message]**](Message.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MessageWebhook.md: -------------------------------------------------------------------------------- 1 | # MessageWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the message. | [optional] 7 | **received** | **str** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when Sunshine Conversations received the message. | [optional] 8 | **author** | [**AuthorWebhook**](AuthorWebhook.md) | | [optional] 9 | **content** | [**Content**](Content.md) | The content of the message. | [optional] 10 | **source** | [**Source**](Source.md) | | [optional] 11 | **quoted_message** | [**QuotedMessage**](QuotedMessage.md) | The quoted message is currently only available for WhatsApp and Web Messenger `formResponse` messages. | [optional] 12 | **metadata** | **dict** | | [optional] 13 | **deleted** | **bool** | true if the message serves as a placeholder for one that has been deleted. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/MessengerAllOf.md: -------------------------------------------------------------------------------- 1 | # MessengerAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to Meta for app review with the “pages_manage_metadata” (to retrieve Page Access Tokens for the Pages, apps that the app user administers and set a webhook) and “pages_messaging” (to send messages) permissions. - In order to integrate a Facebook Messenger app you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token. | [optional] [default to 'messenger'] 7 | **page_access_token** | **str** | A Facebook Page Access Token. | 8 | **app_id** | **str** | A Facebook App ID. | 9 | **app_secret** | **str** | A Facebook App Secret. | 10 | **page_id** | **float** | A Facebook page ID. | [optional] 11 | **page_name** | **str** | A Facebook page name. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MessengerUpdate.md: -------------------------------------------------------------------------------- 1 | # MessengerUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 7 | **default_responder_id** | **str** | 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 | **page_access_token** | **str** | A Facebook Page Access Token. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Meta.md: -------------------------------------------------------------------------------- 1 | # Meta 2 | 3 | Response metadata. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | A flag that indicates if there are more records that can be fetched. | [optional] 8 | **after_cursor** | **str** | A record id that can be used as a `page[after]` parameter in a new request to get the next page. Not specified if there are no subsequent pages. | [optional] 9 | **before_cursor** | **str** | A record id that can be used as a `page[before]` parameter in a new request to get the previous page. Not specified if there are no previous pages. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/OfferControlBody.md: -------------------------------------------------------------------------------- 1 | # OfferControlBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **switchboard_integration** | **str** | The id or the name of the switchboard integration that will become pending. Also supports the `next` keyword to offer control to the next switchboard integration designated in the switchboard hierarchy configuration. This cannot match the active switchboard integration. | 7 | **metadata** | **dict** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:offerControl` and `switchboard:offerControl:failure` webhooks. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Page.md: -------------------------------------------------------------------------------- 1 | # Page 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **after** | **str** | A record id. Results will only contain the records that come after the specified record. Only one of `after` or `before` can be provided, not both. | [optional] 7 | **before** | **str** | A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both. | [optional] 8 | **size** | **int** | The number of records to return. Does not apply to the `listMessages` endpoint. | [optional] [default to 25] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Participant.md: -------------------------------------------------------------------------------- 1 | # Participant 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the participant. | [optional] 7 | **user_id** | **str** | The id of the associated user. | [optional] 8 | **unread_count** | **int** | Number of messages the user has not yet read. | [optional] 9 | **client_associations** | [**list[ClientAssociation]**](ClientAssociation.md) | Represents the clients that are active in the conversation for a particular user. A participant can have multiple clientAssociations in the case of channel transfer, business initiated conversations, or identified users. The order of the array indicates how recently a client has interacted with the conversation, with the most recent client first. The first item in the array is considered to be the user's primary client for that conversation, and will be selected first for message delivery. | [optional] 10 | **user_external_id** | **str** | The externalId of the associated user. | [optional] 11 | **last_read** | **str** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the latest message the user has read. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ParticipantJoinBody.md: -------------------------------------------------------------------------------- 1 | # ParticipantJoinBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ParticipantLeaveBody.md: -------------------------------------------------------------------------------- 1 | # ParticipantLeaveBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_id** | **str** | The id of the user that will be removed from the conversation. It will return 404 if the user can’t be found. | [optional] 7 | **user_external_id** | **str** | The externalId of the user that will be removed from the conversation. It will return 404 if the user can’t be found. | [optional] 8 | **participant_id** | **str** | The participantId of the user that will be removed from the conversation. It will return 404 if the user can’t be found. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ParticipantLeaveBodyParticipantId.md: -------------------------------------------------------------------------------- 1 | # ParticipantLeaveBodyParticipantId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **participant_id** | **str** | The participantId of the user that will be removed from the conversation. It will return 404 if the user can’t be found. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ParticipantLeaveBodyUserExternalId.md: -------------------------------------------------------------------------------- 1 | # ParticipantLeaveBodyUserExternalId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_external_id** | **str** | The externalId of the user that will be removed from the conversation. It will return 404 if the user can’t be found. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ParticipantLeaveBodyUserId.md: -------------------------------------------------------------------------------- 1 | # ParticipantLeaveBodyUserId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_id** | **str** | The id of the user that will be removed from the conversation. It will return 404 if the user can’t be found. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ParticipantListResponse.md: -------------------------------------------------------------------------------- 1 | # ParticipantListResponse 2 | 3 | List of returned participants. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **participants** | [**list[Participant]**](Participant.md) | | [optional] 8 | **meta** | [**Meta**](Meta.md) | | [optional] 9 | **links** | [**Links**](Links.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ParticipantResponse.md: -------------------------------------------------------------------------------- 1 | # ParticipantResponse 2 | 3 | The created participant. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **participant** | [**Participant**](Participant.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ParticipantSubSchema.md: -------------------------------------------------------------------------------- 1 | # ParticipantSubSchema 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_id** | **str** | The id of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 7 | **subscribe_sdk_client** | **bool** | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type `sdkGroup`. | [optional] 8 | **user_external_id** | **str** | The `externalId` of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ParticipantWithUserExternalId.md: -------------------------------------------------------------------------------- 1 | # ParticipantWithUserExternalId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_external_id** | **str** | The `externalId` of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 7 | **subscribe_sdk_client** | **bool** | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type `sdkGroup`. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ParticipantWithUserId.md: -------------------------------------------------------------------------------- 1 | # ParticipantWithUserId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_id** | **str** | The id of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 7 | **subscribe_sdk_client** | **bool** | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type `sdkGroup`. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PassControlBody.md: -------------------------------------------------------------------------------- 1 | # PassControlBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **switchboard_integration** | **str** | The id or the name of the switchboard integration that will become active. May also use the `next` keyword to transfer control to the next switchboard integration designated in the switchboard hierarchy configuration | 7 | **reason** | **str** | Reason for the pass control action. | [optional] 8 | **metadata** | **dict** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:passControl` webhook. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Postback.md: -------------------------------------------------------------------------------- 1 | # Postback 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of action. | [default to 'postback'] 7 | **text** | **str** | The button text. | 8 | **payload** | **str** | The payload of a postback or reply button. | 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PostbackWebhook.md: -------------------------------------------------------------------------------- 1 | # PostbackWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | **str** | The payload associated with the postback. | [optional] 7 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PrechatCapture.md: -------------------------------------------------------------------------------- 1 | # PrechatCapture 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **avatar_url** | **str** | Sets the URL of the avatar to use for the automatic reply to the prechat capture messages. | [optional] [default to 'undefined'] 7 | **enabled** | **bool** | If true, enables the Prechat Capture add-on when the Web Messenger is initialized. | [optional] [default to False] 8 | **enable_email_linking** | **bool** | f true and Mailgun is integrated, will automatically link submitted emails. | [optional] [default to False] 9 | **fields** | [**list[Field]**](Field.md) | Array of Fields. Overrides the default Prechat Capture fields to define a custom form. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Profile.md: -------------------------------------------------------------------------------- 1 | # Profile 2 | 3 | Object hosting user profile information. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **given_name** | **str** | The user's given name (first name). | [optional] 8 | **surname** | **str** | The user's surname (last name). | [optional] 9 | **email** | **str** | The user's email address. | [optional] 10 | **avatar_url** | **str** | The user's avatar. | [optional] 11 | **locale** | **str** | End-user's locale information in BCP 47 format. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/QuotedMessage.md: -------------------------------------------------------------------------------- 1 | # QuotedMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [default to 'externalMessageId'] 7 | **message** | [**Message**](Message.md) | | [optional] 8 | **external_message_id** | **str** | The external message Id of the quoted message. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/QuotedMessageExternalMessageId.md: -------------------------------------------------------------------------------- 1 | # QuotedMessageExternalMessageId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [default to 'externalMessageId'] 7 | **external_message_id** | **str** | The external message Id of the quoted message. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/QuotedMessageMessage.md: -------------------------------------------------------------------------------- 1 | # QuotedMessageMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of quotedMessage - a complete Sunshine Conversations message is provided. | [default to 'message'] 7 | **message** | [**Message**](Message.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Referral.md: -------------------------------------------------------------------------------- 1 | # Referral 2 | 3 | Data representing a referral object when a user is referred to a conversation. See the conversation referrals guide for more details. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **str** | The referral’s identifier. | [optional] 8 | **details** | [**ReferralDetails**](ReferralDetails.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReferralDetails.md: -------------------------------------------------------------------------------- 1 | # ReferralDetails 2 | 3 | Nested object containing additional information. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **source** | **str** | The source of the referral - MESSENGER_CODE, ADS etc… | [optional] 8 | **type** | **str** | The type of referral, typically OPEN-THREAD. | [optional] 9 | **ad_id** | **str** | If the referral came from an ad, this field will be present with the ad’s Id. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ReleaseControlBody.md: -------------------------------------------------------------------------------- 1 | # ReleaseControlBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reason** | **str** | Reason for the release control action. | [optional] 7 | **metadata** | **dict** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:releaseControl` webhook. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Reply.md: -------------------------------------------------------------------------------- 1 | # Reply 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of action. | 7 | **text** | **str** | The button text. We recommend a non-empty value because some channels may not support empty ones. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android. | 8 | **payload** | **str** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. | 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | **icon_url** | **str** | An icon to render next to the reply option. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SourceWebhook.md: -------------------------------------------------------------------------------- 1 | # SourceWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional] 7 | **integration_id** | **str** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] 8 | **original_message_id** | **str** | Message identifier assigned by the originating channel. | [optional] 9 | **original_message_timestamp** | **str** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional] 10 | **client** | [**Client**](Client.md) | The client from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook. | [optional] 11 | **device** | [**Device**](Device.md) | The device from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SourceWithCampaignWebhookAllOf.md: -------------------------------------------------------------------------------- 1 | # SourceWithCampaignWebhookAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign** | [**Campaign**](Campaign.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Status.md: -------------------------------------------------------------------------------- 1 | # Status 2 | 3 | The status of the integration. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Switchboard.md: -------------------------------------------------------------------------------- 1 | # Switchboard 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the switchboard. | 7 | **enabled** | **bool** | Whether the switchboard is enabled. Allows creating the switchboard in a disabled state so that messages don't get lost or misrouted during switchboard configuration. When a switchboard is disabled, integrations linked to the switchboard will receive all events. | 8 | **default_switchboard_integration_id** | **str** | The id of the switchboard integration that will be given control when a new conversation begins. It will also be used for conversations that existed before the switchboard was enabled. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SwitchboardAcceptControl.md: -------------------------------------------------------------------------------- 1 | # SwitchboardAcceptControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**SwitchboardAcceptControlAllOfPayload**](SwitchboardAcceptControlAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardAcceptControlAllOf.md: -------------------------------------------------------------------------------- 1 | # SwitchboardAcceptControlAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**SwitchboardAcceptControlAllOfPayload**](SwitchboardAcceptControlAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardAcceptControlAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # SwitchboardAcceptControlAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. Will include an `activeSwitchboardIntegration` representing the integration that has just accepted control. | [optional] 8 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SwitchboardAcceptControlFailure.md: -------------------------------------------------------------------------------- 1 | # SwitchboardAcceptControlFailure 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**SwitchboardAcceptControlFailureAllOfPayload**](SwitchboardAcceptControlFailureAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardAcceptControlFailureAllOf.md: -------------------------------------------------------------------------------- 1 | # SwitchboardAcceptControlFailureAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**SwitchboardAcceptControlFailureAllOfPayload**](SwitchboardAcceptControlFailureAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardAcceptControlFailureAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # SwitchboardAcceptControlFailureAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **error** | [**object**](.md) | Object containing details of what went wrong. | [optional] 8 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. | [optional] 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardIntegration.md: -------------------------------------------------------------------------------- 1 | # SwitchboardIntegration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the switchboard integration. | 7 | **name** | **str** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | 8 | **integration_id** | **str** | Id of the integration that should deliver events routed by the switchboard. | 9 | **integration_type** | **str** | Type of integration that should deliver events routed by the switchboard. If referencing an OAuth integration, the clientId issued by Sunshine Conversations during the OAuth partnership process will be the value of integrationType. | 10 | **deliver_standby_events** | **bool** | Setting to determine if webhooks should be sent when the switchboard integration is not in control of a conversation (standby status) | 11 | **next_switchboard_integration_id** | **str** | The switchboard integration id to which control of a conversation is passed / offered by default. | [optional] 12 | **message_history_count** | **int** | Number of messages to include in the message history context. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SwitchboardIntegrationCreateBody.md: -------------------------------------------------------------------------------- 1 | # SwitchboardIntegrationCreateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | 7 | **integration_id** | **str** | The id of the integration to link to the switchboard integration. Must be used when linking a custom integration. One of `integrationId` or `integrationType` must be provided. | [optional] 8 | **integration_type** | **str** | The type of the integration to link to the switchboard integration. Must be used when linking an OAuth integration. One of `integrationId` or `integrationType` must be provided. | [optional] 9 | **deliver_standby_events** | **bool** | | [optional] 10 | **next_switchboard_integration_id** | **str** | The switchboard integration id to which control of a conversation is passed / offered by default. | [optional] 11 | **message_history_count** | **int** | Number of messages to include in the message history context. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SwitchboardIntegrationListResponse.md: -------------------------------------------------------------------------------- 1 | # SwitchboardIntegrationListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **switchboard_integrations** | [**list[SwitchboardIntegration]**](SwitchboardIntegration.md) | List of returned switchboard integrations. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardIntegrationResponse.md: -------------------------------------------------------------------------------- 1 | # SwitchboardIntegrationResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **switchboard_integration** | [**SwitchboardIntegration**](SwitchboardIntegration.md) | The switchboard integration. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardIntegrationWebhook.md: -------------------------------------------------------------------------------- 1 | # SwitchboardIntegrationWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the switchboard integration. | [optional] 7 | **name** | **str** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | [optional] 8 | **integration_id** | **str** | Id of the integration that should deliver events routed by the switchboard. | [optional] 9 | **integration_type** | **str** | Type of integration that should deliver events routed by the switchboard. If referencing an OAuth integration, the clientId issued by Sunshine Conversations during the OAuth partnership process will be the value of integrationType. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardListResponse.md: -------------------------------------------------------------------------------- 1 | # SwitchboardListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **switchboards** | [**list[Switchboard]**](Switchboard.md) | List of returned switchboards. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardOfferControl.md: -------------------------------------------------------------------------------- 1 | # SwitchboardOfferControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**SwitchboardOfferControlAllOfPayload**](SwitchboardOfferControlAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardOfferControlAllOf.md: -------------------------------------------------------------------------------- 1 | # SwitchboardOfferControlAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**SwitchboardOfferControlAllOfPayload**](SwitchboardOfferControlAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardOfferControlAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # SwitchboardOfferControlAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the integration from which control is being offered, and a `pendingSwitchboardIntegration`, representing the integration being offered control. | [optional] 8 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SwitchboardOfferControlFailure.md: -------------------------------------------------------------------------------- 1 | # SwitchboardOfferControlFailure 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**SwitchboardAcceptControlFailureAllOfPayload**](SwitchboardAcceptControlFailureAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardPassControl.md: -------------------------------------------------------------------------------- 1 | # SwitchboardPassControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**SwitchboardPassControlAllOfPayload**](SwitchboardPassControlAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardPassControlAllOf.md: -------------------------------------------------------------------------------- 1 | # SwitchboardPassControlAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**SwitchboardPassControlAllOfPayload**](SwitchboardPassControlAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardPassControlAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # SwitchboardPassControlAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the switchboard integration that is now in control of the conversation. | [optional] 8 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SwitchboardPassControlFailure.md: -------------------------------------------------------------------------------- 1 | # SwitchboardPassControlFailure 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**SwitchboardAcceptControlFailureAllOfPayload**](SwitchboardAcceptControlFailureAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwitchboardResponse.md: -------------------------------------------------------------------------------- 1 | # SwitchboardResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **switchboard** | [**Switchboard**](Switchboard.md) | The switchboard. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SwitchboardUpdateBody.md: -------------------------------------------------------------------------------- 1 | # SwitchboardUpdateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **enabled** | **bool** | Whether the switchboard is enabled. Allows creating the switchboard in a disabled state so that messages don't get lost or misrouted during switchboard configuration. When a switchboard is disabled, integrations linked to the switchboard will receive all events. | [optional] 7 | **default_switchboard_integration_id** | **str** | The id of the switchboard integration that will be given control when a new conversation begins. It will also be used for conversations that existed before the switchboard was enabled. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SyncUserBody.md: -------------------------------------------------------------------------------- 1 | # SyncUserBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **surviving_zendesk_id** | **str** | Only used for synchronizing messaging users when their Support user counterparts have been merged. The user.id of the surviving Support user is specified here. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Target.md: -------------------------------------------------------------------------------- 1 | # Target 2 | 3 | The target conversation to attach the client to. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conversation_id** | **str** | The conversation ID of the target conversation. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Telegram.md: -------------------------------------------------------------------------------- 1 | # Telegram 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a Telegram integration, acquire the required information from the user and call the Create Integration endpoint. | [optional] [default to 'telegram'] 7 | **token** | **str** | Telegram Bot Token. | 8 | **username** | **str** | Username of the botId | [optional] [readonly] 9 | **bot_id** | **str** | A human-friendly name used to identify the integration. | [optional] [readonly] 10 | **default_responder_id** | **str** | 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] 11 | **default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TelegramAllOf.md: -------------------------------------------------------------------------------- 1 | # TelegramAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a Telegram integration, acquire the required information from the user and call the Create Integration endpoint. | [optional] [default to 'telegram'] 7 | **token** | **str** | Telegram Bot Token. | 8 | **username** | **str** | Username of the botId | [optional] [readonly] 9 | **bot_id** | **str** | A human-friendly name used to identify the integration. | [optional] [readonly] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/TelegramUpdate.md: -------------------------------------------------------------------------------- 1 | # TelegramUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TemplateMessage.md: -------------------------------------------------------------------------------- 1 | # TemplateMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of message. | [default to 'template'] 7 | **block_chat_input** | **bool** | 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] 8 | **template** | [**object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://docs.smooch.io/guide/whatsapp#sending-message-templates). `schema` must be set to `whatsapp`. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TicketClosed.md: -------------------------------------------------------------------------------- 1 | # TicketClosed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of system activity that generated the message. The value of this field determines the dynamic content that is rendered to the end-user / agent when viewing this message. Each `type` value will have a set of pre-defined, localized strings that describe the activity. | [default to 'ticket:closed'] 7 | **data** | **dict(str, object)** | No additional data is supplied with the \"ticket:closed\" activity type at this time. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TransferToEmail.md: -------------------------------------------------------------------------------- 1 | # TransferToEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | The type of system activity that generated the message. The value of this field determines the dynamic content that is rendered to the end-user / agent when viewing this message. Each `type` value will have a set of pre-defined, localized strings that describe the activity. | [default to 'ticket:transfer:email'] 7 | **data** | **dict(str, object)** | No additional data is supplied with the \"ticket:transfer:email\" activity type at this time. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TwilioAllOf.md: -------------------------------------------------------------------------------- 1 | # TwilioAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a Twilio integration, acquire the required information from the user and call the Create Integration endpoint. | [optional] [default to 'twilio'] 7 | **account_sid** | **str** | Twilio Account SID. | 8 | **auth_token** | **str** | Twilio Auth Token. | 9 | **phone_number_sid** | **str** | SID for specific phone number. One of `messagingServiceSid` or `phoneNumberSid` must be provided when creating a Twilio integration. | [optional] 10 | **messaging_service_sid** | **str** | SID for specific messaging service. One of `messagingServiceSid` or `phoneNumberSid` must be provided when creating a Twilio integration. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/TwilioUpdate.md: -------------------------------------------------------------------------------- 1 | # TwilioUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TwitterAllOf.md: -------------------------------------------------------------------------------- 1 | # TwitterAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To set up a Twitter integration, please follow the steps outlined in the [Twitter Setup Guide](https://docs.smooch.io/guide/twitter/#setup). | [optional] [default to 'twitter'] 7 | **tier** | **str** | Your Twitter app's tier. Only \"enterprise\" is supported for new integrations. | 8 | **env_name** | **str** | The Twitter dev environments label. Only required / used for sandbox and premium tiers. | [optional] [readonly] 9 | **consumer_key** | **str** | The consumer key for your Twitter app. | 10 | **consumer_secret** | **str** | The consumer key secret for your Twitter app. | 11 | **access_token_key** | **str** | The access token key obtained from your user via oauth. | 12 | **access_token_secret** | **str** | The access token secret obtained from your user via oauth. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TwitterUpdate.md: -------------------------------------------------------------------------------- 1 | # TwitterUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UnityAllOf.md: -------------------------------------------------------------------------------- 1 | # UnityAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a Unity integration, create an integration with type 'unity' by calling the Create Integration endpoint. | [optional] [default to 'unity'] 7 | **can_user_see_conversation_list** | **bool** | 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] 8 | **can_user_create_more_conversations** | **bool** | Allows users to create more than one conversation on the Unity integration. | [optional] 9 | **attachments_enabled** | **bool** | 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] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UnityUpdate.md: -------------------------------------------------------------------------------- 1 | # UnityUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 7 | **default_responder_id** | **str** | 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 | **can_user_see_conversation_list** | **bool** | 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 | **can_user_create_more_conversations** | **bool** | Allows users to create more than one conversation on the Unity integration. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UnityUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # UnityUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **can_user_see_conversation_list** | **bool** | 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] 7 | **can_user_create_more_conversations** | **bool** | Allows users to create more than one conversation on the Unity integration. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/User.md: -------------------------------------------------------------------------------- 1 | # User 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the user. | [optional] 7 | **authenticated** | **bool** | Whether or not the user has authenticated, either via JWT or via the Help Center | [optional] [readonly] 8 | **external_id** | **str** | An optional ID that can also be used to retrieve the user. | [optional] 9 | **zendesk_id** | **str** | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. | [optional] 10 | **signed_up_at** | **str** | | [optional] 11 | **to_be_retained** | **bool** | | [optional] 12 | **profile** | [**Profile**](Profile.md) | | [optional] 13 | **metadata** | **dict** | | [optional] 14 | **identities** | [**list[Identity]**](Identity.md) | The user's connected identities. | [optional] [readonly] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/UserAllOf.md: -------------------------------------------------------------------------------- 1 | # UserAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **signed_up_at** | **str** | | [optional] 7 | **to_be_retained** | **bool** | | [optional] 8 | **profile** | [**Profile**](Profile.md) | | [optional] 9 | **metadata** | **dict** | | [optional] 10 | **identities** | [**list[Identity]**](Identity.md) | The user's connected identities. | [optional] [readonly] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UserCreateBody.md: -------------------------------------------------------------------------------- 1 | # UserCreateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **external_id** | **str** | 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/). | 7 | **signed_up_at** | **str** | The date at which the user signed up. Must be ISO 8601 time format `YYYY-MM-DDThh:mm:ss.sssZ`. | [optional] 8 | **to_be_retained** | **bool** | 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] 9 | **profile** | [**Profile**](Profile.md) | | [optional] 10 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UserMergeEvent.md: -------------------------------------------------------------------------------- 1 | # UserMergeEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**UserMergeEventAllOfPayload**](UserMergeEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserMergeEventAllOf.md: -------------------------------------------------------------------------------- 1 | # UserMergeEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**UserMergeEventAllOfPayload**](UserMergeEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UserMergeEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # UserMergeEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **merged_users** | [**UserMergeEventAllOfPayloadMergedUsers**](UserMergeEventAllOfPayloadMergedUsers.md) | | [optional] 8 | **merged_conversations** | [**UserMergeEventAllOfPayloadMergedConversations**](UserMergeEventAllOfPayloadMergedConversations.md) | | [optional] 9 | **merged_clients** | [**UserMergeEventAllOfPayloadMergedClients**](UserMergeEventAllOfPayloadMergedClients.md) | | [optional] 10 | **discarded_metadata** | **dict** | A flat object with the set of metadata properties that were discarded when merging the two users. This should contain values only if the combined metadata fields exceed the 4KB limit. | [optional] 11 | **reason** | **str** | The reason for which the users merged. * `api` - The users were merged using the API. * `channelLinking` - The users were merged as a result of initiating a channel link. * `sdkLogin` - The users were merged as a result of logging into an SDK device. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UserMergeEventAllOfPayloadMergedClients.md: -------------------------------------------------------------------------------- 1 | # UserMergeEventAllOfPayloadMergedClients 2 | 3 | Contains information about the clients that were merged together as a result of the operation, if applicable. If no clients were merged, this property is omitted. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **surviving** | [**Client**](Client.md) | The client that already existed before the merge started. | [optional] 8 | **discarded** | [**Client**](Client.md) | The pending client that was discarded during the merge event. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UserMergeEventAllOfPayloadMergedConversations.md: -------------------------------------------------------------------------------- 1 | # UserMergeEventAllOfPayloadMergedConversations 2 | 3 | Contains information about the conversations that were merged together as a result of the operation, if applicable. If no conversations were merged, this property is omitted. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **surviving** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that now represents the merged conversation object. | [optional] 8 | **discarded** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that was unified into the surviving conversation object. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UserMergeEventAllOfPayloadMergedUsers.md: -------------------------------------------------------------------------------- 1 | # UserMergeEventAllOfPayloadMergedUsers 2 | 3 | Contains information about the users that were merged together. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **surviving** | [**User**](User.md) | The user that now represents the merged user object. | [optional] 8 | **discarded** | [**User**](User.md) | The user that was unified into the surviving user object. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UserRemoveEvent.md: -------------------------------------------------------------------------------- 1 | # UserRemoveEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**UserRemoveEventAllOfPayload**](UserRemoveEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserRemoveEventAllOf.md: -------------------------------------------------------------------------------- 1 | # UserRemoveEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**UserRemoveEventAllOfPayload**](UserRemoveEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UserRemoveEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # UserRemoveEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **user** | [**UserTruncated**](UserTruncated.md) | The user that was removed. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UserResponse.md: -------------------------------------------------------------------------------- 1 | # UserResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user** | [**User**](User.md) | The user. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UserTruncated.md: -------------------------------------------------------------------------------- 1 | # UserTruncated 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the user. | [optional] 7 | **authenticated** | **bool** | Whether or not the user has authenticated, either via JWT or via the Help Center | [optional] [readonly] 8 | **external_id** | **str** | An optional ID that can also be used to retrieve the user. | [optional] 9 | **zendesk_id** | **str** | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserUpdateBody.md: -------------------------------------------------------------------------------- 1 | # UserUpdateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **signed_up_at** | **str** | | [optional] 7 | **to_be_retained** | **bool** | | [optional] 8 | **profile** | [**Profile**](Profile.md) | | [optional] 9 | **metadata** | **dict(str, object)** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserUpdateEvent.md: -------------------------------------------------------------------------------- 1 | # UserUpdateEvent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 7 | **type** | **str** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 8 | **created_at** | **str** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 9 | **payload** | [**UserUpdateEventAllOfPayload**](UserUpdateEventAllOfPayload.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserUpdateEventAllOf.md: -------------------------------------------------------------------------------- 1 | # UserUpdateEventAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **payload** | [**UserUpdateEventAllOfPayload**](UserUpdateEventAllOfPayload.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UserUpdateEventAllOfPayload.md: -------------------------------------------------------------------------------- 1 | # UserUpdateEventAllOfPayload 2 | 3 | The payload of the event. The contents of this object depend on the type of event. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **user** | [**User**](User.md) | The updated user. | [optional] 8 | **reason** | **str** | 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 | **source** | [**SourceWebhook**](SourceWebhook.md) | The source of the creation. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Viber.md: -------------------------------------------------------------------------------- 1 | # Viber 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a Viber integration, acquire the Viber Public Account token from the user and call the Create Integration endpoint. | [optional] [default to 'viber'] 7 | **token** | **str** | Viber Public Account token. | 8 | **uri** | **str** | Unique URI of the Viber account. | [optional] [readonly] 9 | **account_id** | **str** | Unique ID of the Viber account. | [optional] [readonly] 10 | **default_responder_id** | **str** | 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] 11 | **default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ViberAllOf.md: -------------------------------------------------------------------------------- 1 | # ViberAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | To configure a Viber integration, acquire the Viber Public Account token from the user and call the Create Integration endpoint. | [optional] [default to 'viber'] 7 | **token** | **str** | Viber Public Account token. | 8 | **uri** | **str** | Unique URI of the Viber account. | [optional] [readonly] 9 | **account_id** | **str** | Unique ID of the Viber account. | [optional] [readonly] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ViberUpdate.md: -------------------------------------------------------------------------------- 1 | # ViberUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Webhook.md: -------------------------------------------------------------------------------- 1 | # Webhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | A unique identifier for the webhook. | [optional] [readonly] 7 | **version** | **str** | Schema version of the payload delivered to this webhook. Can be `v1`, `v1.1` or `v2`. | [optional] [readonly] 8 | **target** | **str** | URL to be called when the webhook is triggered. | 9 | **triggers** | **list[str]** | An array of triggers the integration is subscribed to. This property is case sensitive. [More details](https://docs.smooch.io/rest/#section/Webhook-Triggers). | 10 | **secret** | **str** | Webhook secret, used to verify the origin of incoming requests. | [optional] 11 | **include_full_user** | **bool** | A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user. | [optional] [default to False] 12 | **include_full_source** | **bool** | A boolean specifying whether webhook payloads should include the client and device object (when applicable). | [optional] [default to False] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/WebhookBody.md: -------------------------------------------------------------------------------- 1 | # WebhookBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **target** | **str** | URL to be called when the webhook is triggered. | [optional] 7 | **triggers** | **list[str]** | An array of triggers the integration is subscribed to. This property is case sensitive. [More details](https://docs.smooch.io/rest/#section/Webhook-Triggers). | [optional] 8 | **include_full_user** | **bool** | A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user. | [optional] [default to False] 9 | **include_full_source** | **bool** | A boolean specifying whether webhook payloads should include the client and device object (when applicable). | [optional] [default to False] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/WebhookCreateBody.md: -------------------------------------------------------------------------------- 1 | # WebhookCreateBody 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/WebhookListResponse.md: -------------------------------------------------------------------------------- 1 | # WebhookListResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **webhooks** | [**list[Webhook]**](Webhook.md) | List of webhooks associated with the integration. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/WebhookResponse.md: -------------------------------------------------------------------------------- 1 | # WebhookResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **webhook** | [**Webhook**](Webhook.md) | The webhook. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/WebhookSubSchema.md: -------------------------------------------------------------------------------- 1 | # WebhookSubSchema 2 | 3 | The webhook that generated the payload. 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | The unique ID of the webhook. | [optional] 8 | **version** | **str** | Schema version of the payload delivered to this webhook (v2). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/WhatsAppUpdateAllOf.md: -------------------------------------------------------------------------------- 1 | # WhatsAppUpdateAllOf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **hsm_fallback_language** | **str** | 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'] 7 | **account_id** | **str** | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional] 8 | **account_management_access_token** | **str** | 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] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi >= 14.05.14 2 | future; python_version<="2.7" 3 | six >= 1.10 4 | python_dateutil >= 2.5.3 5 | setuptools >= 21.0.0 6 | urllib3 >= 1.15.1 7 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length=99 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Sunshine Conversations API 5 | 6 | The version of the OpenAPI document: 15.5.1 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | from setuptools import setup, find_packages # noqa: H301 12 | 13 | NAME = "sunshine-conversations-client" 14 | VERSION = "15.5.1" 15 | # To install the library, run the following 16 | # 17 | # python setup.py install 18 | # 19 | # prerequisite: setuptools 20 | # http://pypi.python.org/pypi/setuptools 21 | 22 | REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil"] 23 | setup( 24 | name=NAME, 25 | version=VERSION, 26 | description="Sunshine Conversations API", 27 | author="OpenAPI Generator community", 28 | author_email="team@openapitools.org", 29 | url="", 30 | keywords=["Sunshine Conversations API"], 31 | install_requires=REQUIRES, 32 | packages=find_packages(exclude=["test", "tests"]), 33 | include_package_data=True, 34 | long_description_content_type='text/markdown', 35 | long_description="""\ 36 | The Python package for the Sunshine Conversations API\n 37 | 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). 38 | """ 39 | ) 40 | -------------------------------------------------------------------------------- /sunshine_conversations_client/undefined.py: -------------------------------------------------------------------------------- 1 | class Undefined: 2 | pass 3 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest~=4.6.7 # needed for python 2.7+3.4 2 | pytest-cov>=2.8.1 3 | pytest-randomly==1.2.3 # needed for python 2.7+3.4 4 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | pytest --cov=sunshine_conversations_client 10 | --------------------------------------------------------------------------------