sunshine-conversations-client 16.0.1 → 17.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG_RB.md +7 -0
- data/README.md +20 -72
- data/docs/AcceptControlBody.md +8 -7
- data/docs/Action.md +64 -34
- data/docs/ActionSubset.md +60 -32
- data/docs/ActivitiesApi.md +2 -2
- data/docs/Activity.md +12 -11
- data/docs/ActivityMessage.md +69 -9
- data/docs/ActivityPost.md +10 -9
- data/docs/ActivityTypes.md +8 -7
- data/docs/Android.md +28 -27
- data/docs/AndroidUpdate.md +24 -23
- data/docs/ApiKey.md +12 -11
- data/docs/App.md +14 -13
- data/docs/AppCreateBody.md +12 -11
- data/docs/AppKey.md +12 -11
- data/docs/AppKeyCreateBody.md +8 -7
- data/docs/AppKeyListResponse.md +8 -7
- data/docs/AppKeyResponse.md +8 -7
- data/docs/AppKeysApi.md +7 -7
- data/docs/AppListFilter.md +8 -7
- data/docs/AppListResponse.md +12 -11
- data/docs/AppResponse.md +8 -7
- data/docs/AppSettings.md +20 -19
- data/docs/AppSubSchema.md +8 -7
- data/docs/AppUpdateBody.md +12 -11
- data/docs/Apple.md +20 -19
- data/docs/AppleMessageOverridePayload.md +10 -9
- data/docs/AppleUpdate.md +12 -11
- data/docs/AppsApi.md +7 -7
- data/docs/AttachmentDeleteBody.md +8 -7
- data/docs/AttachmentResponse.md +8 -7
- data/docs/AttachmentSchema.md +10 -9
- data/docs/AttachmentsApi.md +7 -7
- data/docs/Author.md +18 -17
- data/docs/AuthorWebhook.md +12 -11
- data/docs/Buy.md +16 -15
- data/docs/Campaign.md +8 -7
- data/docs/CarouselMessage.md +16 -15
- data/docs/CarouselMessageDisplaySettings.md +8 -7
- data/docs/Client.md +28 -27
- data/docs/ClientAddEvent.md +14 -13
- data/docs/ClientAddEventAllOfPayload.md +16 -15
- data/docs/ClientAssociation.md +10 -9
- data/docs/ClientCreate.md +12 -11
- data/docs/ClientListResponse.md +12 -11
- data/docs/ClientRemoveEvent.md +14 -13
- data/docs/ClientRemoveEventAllOfPayload.md +18 -17
- data/docs/ClientResponse.md +8 -7
- data/docs/ClientType.md +4 -5
- data/docs/ClientUpdateEvent.md +14 -13
- data/docs/ClientUpdateEventAllOfPayload.md +14 -13
- data/docs/ClientsApi.md +9 -9
- data/docs/Confirmation.md +10 -9
- data/docs/Content.md +93 -48
- data/docs/Conversation.md +30 -29
- data/docs/ConversationCreateBody.md +18 -17
- data/docs/ConversationCreateEvent.md +14 -13
- data/docs/ConversationCreateEventAllOfPayload.md +16 -15
- data/docs/ConversationJoinEvent.md +14 -13
- data/docs/ConversationJoinEventAllOfPayload.md +10 -9
- data/docs/ConversationLeaveEvent.md +14 -13
- data/docs/ConversationLeaveEventAllOfPayload.md +10 -9
- data/docs/ConversationListFilter.md +10 -9
- data/docs/ConversationListResponse.md +12 -11
- data/docs/ConversationMessageDeliveryChannelEvent.md +14 -13
- data/docs/ConversationMessageDeliveryFailureEvent.md +14 -13
- data/docs/ConversationMessageDeliveryFailureEventAllOfPayload.md +30 -0
- data/docs/ConversationMessageDeliveryFailureEventAllOfPayloadAllOfError.md +20 -0
- data/docs/ConversationMessageDeliveryPayload.md +18 -17
- data/docs/ConversationMessageDeliveryPayloadDestination.md +10 -9
- data/docs/ConversationMessageDeliveryPayloadExternalMessagesInner.md +18 -0
- data/docs/ConversationMessageDeliveryPayloadMessage.md +8 -7
- data/docs/ConversationMessageDeliveryUserEvent.md +14 -13
- data/docs/ConversationMessageEvent.md +14 -13
- data/docs/ConversationMessageEventAllOfPayload.md +12 -11
- data/docs/ConversationPostbackEvent.md +14 -13
- data/docs/ConversationPostbackEventAllOfPayload.md +14 -13
- data/docs/ConversationReadEvent.md +14 -13
- data/docs/ConversationReadEventAllOfPayload.md +10 -9
- data/docs/ConversationReadEventAllOfPayloadActivity.md +22 -0
- data/docs/ConversationReferralEvent.md +14 -13
- data/docs/ConversationReferralEventAllOfPayload.md +14 -13
- data/docs/ConversationRemoveEvent.md +14 -13
- data/docs/ConversationRemoveEventAllOfPayload.md +8 -7
- data/docs/ConversationResponse.md +8 -7
- data/docs/ConversationTruncated.md +16 -15
- data/docs/ConversationType.md +4 -5
- data/docs/ConversationTypingEvent.md +14 -13
- data/docs/ConversationTypingEventAllOfPayload.md +10 -9
- data/docs/ConversationTypingEventAllOfPayloadActivity.md +22 -0
- data/docs/ConversationUpdateBody.md +14 -13
- data/docs/ConversationsApi.md +16 -16
- data/docs/ConversionEventsBody.md +41 -11
- data/docs/Custom.md +10 -9
- data/docs/CustomIntegrationApiKeysApi.md +11 -11
- data/docs/CustomUpdate.md +8 -7
- data/docs/DefaultResponder.md +8 -7
- data/docs/DefaultResponderDefaultResponder.md +20 -19
- data/docs/DefaultResponderId.md +8 -7
- data/docs/Destination.md +39 -9
- data/docs/Device.md +26 -25
- data/docs/DeviceListResponse.md +8 -7
- data/docs/DeviceResponse.md +8 -7
- data/docs/DevicesApi.md +5 -5
- data/docs/DownloadMessageRefBody.md +10 -6
- data/docs/DownloadMessageRefBodyAllOfApple.md +8 -7
- data/docs/DownloadMessageRefBodyAllOfAppleInteractiveDataRef.md +16 -15
- data/docs/Error.md +10 -9
- data/docs/ErrorResponse.md +8 -7
- data/docs/EventSubSchema.md +12 -11
- data/docs/ExtraChannelOptions.md +8 -7
- data/docs/ExtraChannelOptionsMessenger.md +10 -9
- data/docs/Field.md +18 -17
- data/docs/FileMessage.md +26 -25
- data/docs/FormMessage.md +14 -13
- data/docs/FormMessageField.md +26 -25
- data/docs/FormOptionsInner.md +20 -0
- data/docs/FormResponseMessage.md +12 -11
- data/docs/FormResponseMessageField.md +20 -19
- data/docs/GetToken200Response.md +20 -0
- data/docs/GetTokenRequest.md +24 -0
- data/docs/Identity.md +12 -11
- data/docs/ImageMessage.md +28 -27
- data/docs/Instagram.md +30 -29
- data/docs/InstagramConversionEventsBody.md +8 -7
- data/docs/InstagramUpdate.md +12 -11
- data/docs/Integration.md +14 -13
- data/docs/IntegrationApiKey.md +8 -7
- data/docs/IntegrationApiKeyListResponse.md +8 -7
- data/docs/IntegrationApiKeyResponse.md +8 -7
- data/docs/IntegrationId.md +8 -7
- data/docs/IntegrationListFilter.md +8 -7
- data/docs/IntegrationListResponse.md +12 -11
- data/docs/IntegrationResponse.md +8 -7
- data/docs/IntegrationType.md +8 -7
- data/docs/IntegrationUpdate.md +70 -76
- data/docs/IntegrationUpdateBase.md +10 -9
- data/docs/IntegrationsApi.md +11 -11
- data/docs/Ios.md +26 -25
- data/docs/IosUpdate.md +22 -21
- data/docs/Item.md +22 -21
- data/docs/Line.md +26 -25
- data/docs/LineUpdate.md +10 -6
- data/docs/Link.md +18 -17
- data/docs/Links.md +10 -9
- data/docs/ListMessage.md +14 -13
- data/docs/LocationMessage.md +16 -15
- data/docs/LocationMessageCoordinates.md +10 -9
- data/docs/LocationMessageLocation.md +10 -9
- data/docs/LocationRequest.md +12 -11
- data/docs/Mailgun.md +22 -21
- data/docs/MailgunUpdate.md +14 -13
- data/docs/MatchCriteria.md +76 -18
- data/docs/MatchCriteriaBase.md +12 -11
- data/docs/MatchCriteriaMailgun.md +16 -15
- data/docs/MatchCriteriaMessagebird.md +14 -13
- data/docs/MatchCriteriaTwilio.md +14 -13
- data/docs/MatchCriteriaWhatsapp.md +14 -13
- data/docs/Message.md +24 -23
- data/docs/MessageBirdUpdate.md +10 -6
- data/docs/MessageListResponse.md +12 -11
- data/docs/MessageOverride.md +14 -13
- data/docs/MessageOverrideApple.md +8 -7
- data/docs/MessageOverrideLine.md +8 -7
- data/docs/MessageOverrideMessenger.md +8 -7
- data/docs/MessageOverridePayload.md +8 -7
- data/docs/MessageOverrideWhatsapp.md +8 -7
- data/docs/MessagePost.md +18 -17
- data/docs/MessagePostResponse.md +8 -7
- data/docs/MessageWebhook.md +22 -21
- data/docs/MessageWebhookSource.md +30 -0
- data/docs/Messagebird.md +20 -19
- data/docs/MessagesApi.md +11 -11
- data/docs/Messenger.md +22 -21
- data/docs/MessengerConversionEventsBody.md +8 -7
- data/docs/MessengerUpdate.md +12 -11
- data/docs/Meta.md +12 -11
- data/docs/MetaConversionEvent.md +8 -7
- data/docs/MetaConversionEventPayload.md +8 -7
- data/docs/OAuthEndpointsApi.md +9 -9
- data/docs/OfferControlBody.md +10 -9
- data/docs/Page.md +12 -11
- data/docs/Participant.md +18 -17
- data/docs/ParticipantJoinBody.md +12 -6
- data/docs/ParticipantLeaveBody.md +41 -11
- data/docs/ParticipantLeaveBodyParticipantId.md +8 -7
- data/docs/ParticipantLeaveBodyUserExternalId.md +8 -7
- data/docs/ParticipantLeaveBodyUserId.md +8 -7
- data/docs/ParticipantListResponse.md +12 -11
- data/docs/ParticipantResponse.md +8 -7
- data/docs/ParticipantSubSchema.md +12 -11
- data/docs/ParticipantWithUserExternalId.md +10 -9
- data/docs/ParticipantWithUserId.md +10 -9
- data/docs/ParticipantsApi.md +7 -7
- data/docs/PassControlBody.md +12 -11
- data/docs/Postback.md +14 -13
- data/docs/PostbackWebhook.md +10 -9
- data/docs/PrechatCapture.md +14 -13
- data/docs/Profile.md +16 -15
- data/docs/QuotedMessage.md +69 -11
- data/docs/QuotedMessageExternalMessageId.md +10 -9
- data/docs/QuotedMessageMessage.md +10 -9
- data/docs/Referral.md +10 -9
- data/docs/ReferralDetails.md +12 -11
- data/docs/ReleaseControlBody.md +10 -9
- data/docs/Reply.md +16 -15
- data/docs/Source.md +18 -17
- data/docs/SourceWebhook.md +18 -17
- data/docs/SourceWithCampaignWebhook.md +20 -19
- data/docs/Status.md +4 -5
- data/docs/Switchboard.md +12 -11
- data/docs/SwitchboardAcceptControl.md +14 -13
- data/docs/SwitchboardAcceptControlAllOfPayload.md +10 -9
- data/docs/SwitchboardAcceptControlFailure.md +14 -13
- data/docs/SwitchboardAcceptControlFailureAllOfPayload.md +12 -11
- data/docs/SwitchboardActionsApi.md +12 -12
- data/docs/SwitchboardIntegration.md +20 -19
- data/docs/SwitchboardIntegrationCreateBody.md +18 -17
- data/docs/SwitchboardIntegrationListResponse.md +8 -7
- data/docs/SwitchboardIntegrationResponse.md +8 -7
- data/docs/SwitchboardIntegrationUpdateBody.md +18 -17
- data/docs/SwitchboardIntegrationWebhook.md +14 -13
- data/docs/SwitchboardIntegrationsApi.md +10 -10
- data/docs/SwitchboardListResponse.md +8 -7
- data/docs/SwitchboardOfferControl.md +14 -13
- data/docs/SwitchboardOfferControlAllOfPayload.md +10 -9
- data/docs/SwitchboardOfferControlFailure.md +14 -13
- data/docs/SwitchboardPassControl.md +14 -13
- data/docs/SwitchboardPassControlAllOfPayload.md +12 -11
- data/docs/SwitchboardPassControlFailure.md +14 -13
- data/docs/SwitchboardReleaseControl.md +14 -13
- data/docs/SwitchboardReleaseControlAllOfPayload.md +12 -11
- data/docs/SwitchboardResponse.md +8 -7
- data/docs/SwitchboardUpdateBody.md +10 -9
- data/docs/SwitchboardsApi.md +7 -7
- data/docs/SyncUserBody.md +8 -7
- data/docs/Target.md +8 -7
- data/docs/Telegram.md +18 -17
- data/docs/TelegramUpdate.md +10 -6
- data/docs/TemplateMessage.md +12 -11
- data/docs/TextMessage.md +20 -19
- data/docs/TicketClosed.md +10 -9
- data/docs/TransferToEmail.md +10 -9
- data/docs/Twilio.md +20 -19
- data/docs/TwilioUpdate.md +10 -6
- data/docs/Twitter.md +24 -23
- data/docs/TwitterUpdate.md +10 -6
- data/docs/Unity.md +18 -17
- data/docs/UnityUpdate.md +14 -13
- data/docs/User.md +24 -23
- data/docs/UserCreateBody.md +16 -15
- data/docs/UserMergeEvent.md +14 -13
- data/docs/UserMergeEventAllOfPayload.md +16 -15
- data/docs/UserMergeEventAllOfPayloadMergedClients.md +10 -9
- data/docs/UserMergeEventAllOfPayloadMergedConversations.md +10 -9
- data/docs/UserMergeEventAllOfPayloadMergedUsers.md +10 -9
- data/docs/UserRemoveEvent.md +14 -13
- data/docs/UserRemoveEventAllOfPayload.md +8 -7
- data/docs/UserResponse.md +8 -7
- data/docs/UserTruncated.md +14 -13
- data/docs/UserUpdateBody.md +14 -13
- data/docs/UserUpdateEvent.md +14 -13
- data/docs/UserUpdateEventAllOfPayload.md +12 -11
- data/docs/UsersApi.md +14 -14
- data/docs/Viber.md +18 -17
- data/docs/ViberUpdate.md +10 -6
- data/docs/Web.md +46 -45
- data/docs/WebUpdate.md +42 -41
- data/docs/Webhook.md +20 -19
- data/docs/WebhookBody.md +14 -13
- data/docs/WebhookCreateBody.md +14 -6
- data/docs/WebhookListResponse.md +8 -7
- data/docs/WebhookResponse.md +8 -7
- data/docs/WebhookSubSchema.md +10 -9
- data/docs/WebhooksApi.md +15 -15
- data/docs/Webview.md +24 -23
- data/docs/WhatsAppConversionEventsBody.md +8 -7
- data/docs/WhatsAppUpdate.md +16 -15
- data/docs/Whatsapp.md +20 -19
- data/lib/sunshine-conversations-client/api/activities_api.rb +11 -7
- data/lib/sunshine-conversations-client/api/app_keys_api.rb +26 -19
- data/lib/sunshine-conversations-client/api/apps_api.rb +35 -24
- data/lib/sunshine-conversations-client/api/attachments_api.rb +20 -12
- data/lib/sunshine-conversations-client/api/clients_api.rb +21 -15
- data/lib/sunshine-conversations-client/api/conversations_api.rb +53 -34
- data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +26 -19
- data/lib/sunshine-conversations-client/api/devices_api.rb +12 -10
- data/lib/sunshine-conversations-client/api/integrations_api.rb +35 -24
- data/lib/sunshine-conversations-client/api/messages_api.rb +26 -19
- data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +36 -29
- data/lib/sunshine-conversations-client/api/participants_api.rb +25 -16
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +38 -22
- data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb +30 -20
- data/lib/sunshine-conversations-client/api/switchboards_api.rb +26 -19
- data/lib/sunshine-conversations-client/api/users_api.rb +44 -29
- data/lib/sunshine-conversations-client/api/webhooks_api.rb +35 -24
- data/lib/sunshine-conversations-client/api_client.rb +54 -9
- data/lib/sunshine-conversations-client/api_error.rb +3 -2
- data/lib/sunshine-conversations-client/configuration.rb +27 -29
- data/lib/sunshine-conversations-client/models/accept_control_body.rb +28 -25
- data/lib/sunshine-conversations-client/models/action.rb +30 -406
- data/lib/sunshine-conversations-client/models/action_subset.rb +24 -390
- data/lib/sunshine-conversations-client/models/activity.rb +24 -25
- data/lib/sunshine-conversations-client/models/activity_message.rb +30 -227
- data/lib/sunshine-conversations-client/models/activity_post.rb +42 -43
- data/lib/sunshine-conversations-client/models/activity_types.rb +23 -23
- data/lib/sunshine-conversations-client/models/android.rb +68 -47
- data/lib/sunshine-conversations-client/models/android_update.rb +24 -25
- data/lib/sunshine-conversations-client/models/api_key.rb +49 -24
- data/lib/sunshine-conversations-client/models/app.rb +52 -24
- data/lib/sunshine-conversations-client/models/app_create_body.rb +55 -24
- data/lib/sunshine-conversations-client/models/app_key.rb +24 -24
- data/lib/sunshine-conversations-client/models/app_key_create_body.rb +51 -23
- data/lib/sunshine-conversations-client/models/app_key_list_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/app_key_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/app_list_filter.rb +23 -23
- data/lib/sunshine-conversations-client/models/app_list_response.rb +27 -24
- data/lib/sunshine-conversations-client/models/app_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/app_settings.rb +24 -24
- data/lib/sunshine-conversations-client/models/app_sub_schema.rb +23 -23
- data/lib/sunshine-conversations-client/models/app_update_body.rb +51 -24
- data/lib/sunshine-conversations-client/models/apple.rb +67 -46
- data/lib/sunshine-conversations-client/models/apple_message_override_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/apple_update.rb +24 -25
- data/lib/sunshine-conversations-client/models/attachment_delete_body.rb +23 -23
- data/lib/sunshine-conversations-client/models/attachment_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/attachment_schema.rb +24 -24
- data/lib/sunshine-conversations-client/models/author.rb +51 -24
- data/lib/sunshine-conversations-client/models/author_webhook.rb +24 -24
- data/lib/sunshine-conversations-client/models/buy.rb +27 -24
- data/lib/sunshine-conversations-client/models/campaign.rb +23 -23
- data/lib/sunshine-conversations-client/models/carousel_message.rb +55 -24
- data/lib/sunshine-conversations-client/models/carousel_message_display_settings.rb +23 -23
- data/lib/sunshine-conversations-client/models/client.rb +24 -24
- data/lib/sunshine-conversations-client/models/client_add_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/client_add_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/client_association.rb +46 -24
- data/lib/sunshine-conversations-client/models/client_create.rb +24 -24
- data/lib/sunshine-conversations-client/models/client_list_response.rb +27 -24
- data/lib/sunshine-conversations-client/models/client_remove_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/client_remove_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/client_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/client_type.rb +9 -5
- data/lib/sunshine-conversations-client/models/client_update_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/client_update_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/confirmation.rb +24 -24
- data/lib/sunshine-conversations-client/models/content.rb +52 -502
- data/lib/sunshine-conversations-client/models/conversation.rb +74 -25
- data/lib/sunshine-conversations-client/models/conversation_create_body.rb +92 -24
- data/lib/sunshine-conversations-client/models/conversation_create_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/conversation_join_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_join_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/conversation_leave_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/conversation_list_filter.rb +24 -24
- data/lib/sunshine-conversations-client/models/conversation_list_response.rb +27 -24
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event.rb +25 -26
- data/lib/sunshine-conversations-client/models/{conversation_message_delivery_channel_event_all_of.rb → conversation_message_delivery_failure_event_all_of_payload.rb} +101 -33
- data/lib/sunshine-conversations-client/models/{conversation_message_delivery_failure_event_all_of.rb → conversation_message_delivery_failure_event_all_of_payload_all_of_error.rb} +45 -33
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload.rb +28 -25
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_destination.rb +24 -24
- data/lib/sunshine-conversations-client/models/{conversation_message_delivery_payload_external_messages.rb → conversation_message_delivery_payload_external_messages_inner.rb} +26 -26
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_message.rb +23 -23
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_user_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_message_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/conversation_postback_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/conversation_read_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of_payload.rb +25 -26
- data/lib/sunshine-conversations-client/models/{custom_all_of.rb → conversation_read_event_all_of_payload_activity.rb} +53 -40
- data/lib/sunshine-conversations-client/models/conversation_referral_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/conversation_remove_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of_payload.rb +23 -23
- data/lib/sunshine-conversations-client/models/conversation_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/conversation_truncated.rb +49 -24
- data/lib/sunshine-conversations-client/models/conversation_type.rb +9 -5
- data/lib/sunshine-conversations-client/models/conversation_typing_event.rb +24 -25
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of_payload.rb +25 -26
- data/lib/sunshine-conversations-client/models/{activity_all_of.rb → conversation_typing_event_all_of_payload_activity.rb} +45 -27
- data/lib/sunshine-conversations-client/models/conversation_update_body.rb +52 -24
- data/lib/sunshine-conversations-client/models/conversion_events_body.rb +78 -221
- data/lib/sunshine-conversations-client/models/custom.rb +77 -25
- data/lib/sunshine-conversations-client/models/custom_update.rb +23 -23
- data/lib/sunshine-conversations-client/models/default_responder.rb +23 -23
- data/lib/sunshine-conversations-client/models/default_responder_default_responder.rb +24 -24
- data/lib/sunshine-conversations-client/models/default_responder_id.rb +23 -23
- data/lib/sunshine-conversations-client/models/destination.rb +77 -213
- data/lib/sunshine-conversations-client/models/device.rb +27 -24
- data/lib/sunshine-conversations-client/models/device_list_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/device_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/download_message_ref_body.rb +52 -39
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple.rb +23 -23
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple_interactive_data_ref.rb +24 -24
- data/lib/sunshine-conversations-client/models/error.rb +24 -24
- data/lib/sunshine-conversations-client/models/error_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/event_sub_schema.rb +24 -24
- data/lib/sunshine-conversations-client/models/extra_channel_options.rb +23 -23
- data/lib/sunshine-conversations-client/models/extra_channel_options_messenger.rb +24 -24
- data/lib/sunshine-conversations-client/models/field.rb +27 -24
- data/lib/sunshine-conversations-client/models/file_message.rb +24 -24
- data/lib/sunshine-conversations-client/models/form_message.rb +55 -24
- data/lib/sunshine-conversations-client/models/form_message_field.rb +47 -27
- data/lib/sunshine-conversations-client/models/{viber_all_of.rb → form_options_inner.rb} +82 -72
- data/lib/sunshine-conversations-client/models/form_response_message.rb +55 -24
- data/lib/sunshine-conversations-client/models/form_response_message_field.rb +28 -26
- data/lib/sunshine-conversations-client/models/{user_merge_event_all_of.rb → get_token200_response.rb} +44 -33
- data/lib/sunshine-conversations-client/models/{inline_object.rb → get_token_request.rb} +27 -27
- data/lib/sunshine-conversations-client/models/identity.rb +24 -24
- data/lib/sunshine-conversations-client/models/image_message.rb +27 -24
- data/lib/sunshine-conversations-client/models/instagram.rb +68 -47
- data/lib/sunshine-conversations-client/models/instagram_conversion_events_body.rb +23 -23
- data/lib/sunshine-conversations-client/models/instagram_update.rb +24 -25
- data/lib/sunshine-conversations-client/models/integration.rb +46 -24
- data/lib/sunshine-conversations-client/models/integration_api_key.rb +23 -23
- data/lib/sunshine-conversations-client/models/integration_api_key_list_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/integration_api_key_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/integration_id.rb +23 -23
- data/lib/sunshine-conversations-client/models/integration_list_filter.rb +23 -23
- data/lib/sunshine-conversations-client/models/integration_list_response.rb +27 -24
- data/lib/sunshine-conversations-client/models/integration_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/integration_type.rb +23 -23
- data/lib/sunshine-conversations-client/models/integration_update.rb +95 -724
- data/lib/sunshine-conversations-client/models/integration_update_base.rb +24 -24
- data/lib/sunshine-conversations-client/models/ios.rb +69 -48
- data/lib/sunshine-conversations-client/models/ios_update.rb +25 -26
- data/lib/sunshine-conversations-client/models/item.rb +58 -24
- data/lib/sunshine-conversations-client/models/line.rb +68 -47
- data/lib/sunshine-conversations-client/models/line_update.rb +74 -32
- data/lib/sunshine-conversations-client/models/link.rb +27 -24
- data/lib/sunshine-conversations-client/models/links.rb +24 -24
- data/lib/sunshine-conversations-client/models/list_message.rb +82 -24
- data/lib/sunshine-conversations-client/models/location_message.rb +24 -24
- data/lib/sunshine-conversations-client/models/location_message_coordinates.rb +24 -24
- data/lib/sunshine-conversations-client/models/location_message_location.rb +24 -24
- data/lib/sunshine-conversations-client/models/location_request.rb +27 -24
- data/lib/sunshine-conversations-client/models/mailgun.rb +70 -49
- data/lib/sunshine-conversations-client/models/mailgun_update.rb +25 -26
- data/lib/sunshine-conversations-client/models/match_criteria.rb +34 -289
- data/lib/sunshine-conversations-client/models/match_criteria_base.rb +24 -24
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun.rb +25 -26
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird.rb +25 -26
- data/lib/sunshine-conversations-client/models/match_criteria_twilio.rb +25 -26
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp.rb +25 -26
- data/lib/sunshine-conversations-client/models/message.rb +29 -26
- data/lib/sunshine-conversations-client/models/message_bird_update.rb +74 -32
- data/lib/sunshine-conversations-client/models/message_list_response.rb +27 -24
- data/lib/sunshine-conversations-client/models/message_override.rb +79 -228
- data/lib/sunshine-conversations-client/models/message_override_apple.rb +23 -23
- data/lib/sunshine-conversations-client/models/message_override_line.rb +23 -23
- data/lib/sunshine-conversations-client/models/message_override_messenger.rb +23 -23
- data/lib/sunshine-conversations-client/models/message_override_payload.rb +23 -23
- data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +23 -23
- data/lib/sunshine-conversations-client/models/message_post.rb +27 -24
- data/lib/sunshine-conversations-client/models/message_post_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/message_webhook.rb +30 -27
- data/lib/sunshine-conversations-client/models/{apple_all_of.rb → message_webhook_source.rb} +91 -86
- data/lib/sunshine-conversations-client/models/messagebird.rb +69 -48
- data/lib/sunshine-conversations-client/models/messenger.rb +69 -48
- data/lib/sunshine-conversations-client/models/messenger_conversion_events_body.rb +23 -23
- data/lib/sunshine-conversations-client/models/messenger_update.rb +24 -25
- data/lib/sunshine-conversations-client/models/meta.rb +24 -24
- data/lib/sunshine-conversations-client/models/meta_conversion_event.rb +23 -23
- data/lib/sunshine-conversations-client/models/meta_conversion_event_payload.rb +26 -23
- data/lib/sunshine-conversations-client/models/offer_control_body.rb +29 -26
- data/lib/sunshine-conversations-client/models/page.rb +24 -24
- data/lib/sunshine-conversations-client/models/participant.rb +27 -24
- data/lib/sunshine-conversations-client/models/participant_join_body.rb +58 -32
- data/lib/sunshine-conversations-client/models/participant_leave_body.rb +78 -224
- data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +23 -23
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +23 -23
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +23 -23
- data/lib/sunshine-conversations-client/models/participant_list_response.rb +27 -24
- data/lib/sunshine-conversations-client/models/participant_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +77 -220
- data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +24 -24
- data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +24 -24
- data/lib/sunshine-conversations-client/models/pass_control_body.rb +29 -26
- data/lib/sunshine-conversations-client/models/postback.rb +27 -24
- data/lib/sunshine-conversations-client/models/postback_webhook.rb +27 -24
- data/lib/sunshine-conversations-client/models/prechat_capture.rb +27 -24
- data/lib/sunshine-conversations-client/models/profile.rb +24 -24
- data/lib/sunshine-conversations-client/models/quoted_message.rb +30 -237
- data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +24 -24
- data/lib/sunshine-conversations-client/models/quoted_message_message.rb +24 -24
- data/lib/sunshine-conversations-client/models/referral.rb +24 -24
- data/lib/sunshine-conversations-client/models/referral_details.rb +24 -24
- data/lib/sunshine-conversations-client/models/release_control_body.rb +29 -26
- data/lib/sunshine-conversations-client/models/reply.rb +27 -24
- data/lib/sunshine-conversations-client/models/source.rb +24 -24
- data/lib/sunshine-conversations-client/models/source_webhook.rb +24 -24
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook.rb +25 -26
- data/lib/sunshine-conversations-client/models/status.rb +9 -5
- data/lib/sunshine-conversations-client/models/switchboard.rb +24 -24
- data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/switchboard_integration.rb +24 -24
- data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +25 -24
- data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +24 -24
- data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +24 -24
- data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_release_control.rb +25 -26
- data/lib/sunshine-conversations-client/models/switchboard_release_control_all_of_payload.rb +27 -24
- data/lib/sunshine-conversations-client/models/switchboard_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +24 -24
- data/lib/sunshine-conversations-client/models/sync_user_body.rb +23 -23
- data/lib/sunshine-conversations-client/models/target.rb +23 -23
- data/lib/sunshine-conversations-client/models/telegram.rb +69 -48
- data/lib/sunshine-conversations-client/models/telegram_update.rb +74 -32
- data/lib/sunshine-conversations-client/models/template_message.rb +24 -24
- data/lib/sunshine-conversations-client/models/text_message.rb +27 -24
- data/lib/sunshine-conversations-client/models/ticket_closed.rb +27 -24
- data/lib/sunshine-conversations-client/models/transfer_to_email.rb +27 -24
- data/lib/sunshine-conversations-client/models/twilio.rb +69 -48
- data/lib/sunshine-conversations-client/models/twilio_update.rb +74 -32
- data/lib/sunshine-conversations-client/models/twitter.rb +50 -51
- data/lib/sunshine-conversations-client/models/twitter_update.rb +74 -32
- data/lib/sunshine-conversations-client/models/unity.rb +68 -47
- data/lib/sunshine-conversations-client/models/unity_update.rb +25 -26
- data/lib/sunshine-conversations-client/models/user.rb +34 -27
- data/lib/sunshine-conversations-client/models/user_create_body.rb +27 -24
- data/lib/sunshine-conversations-client/models/user_merge_event.rb +25 -26
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +28 -26
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_clients.rb +24 -24
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_conversations.rb +24 -24
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_users.rb +24 -24
- data/lib/sunshine-conversations-client/models/user_remove_event.rb +25 -26
- data/lib/sunshine-conversations-client/models/user_remove_event_all_of_payload.rb +23 -23
- data/lib/sunshine-conversations-client/models/user_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/user_truncated.rb +24 -24
- data/lib/sunshine-conversations-client/models/user_update_body.rb +29 -24
- data/lib/sunshine-conversations-client/models/user_update_event.rb +25 -26
- data/lib/sunshine-conversations-client/models/user_update_event_all_of_payload.rb +24 -24
- data/lib/sunshine-conversations-client/models/viber.rb +69 -48
- data/lib/sunshine-conversations-client/models/viber_update.rb +74 -32
- data/lib/sunshine-conversations-client/models/web.rb +75 -48
- data/lib/sunshine-conversations-client/models/web_update.rb +31 -26
- data/lib/sunshine-conversations-client/models/webhook.rb +27 -24
- data/lib/sunshine-conversations-client/models/webhook_body.rb +27 -24
- data/lib/sunshine-conversations-client/models/webhook_create_body.rb +84 -32
- data/lib/sunshine-conversations-client/models/webhook_list_response.rb +26 -23
- data/lib/sunshine-conversations-client/models/webhook_response.rb +23 -23
- data/lib/sunshine-conversations-client/models/webhook_sub_schema.rb +24 -24
- data/lib/sunshine-conversations-client/models/webview.rb +27 -24
- data/lib/sunshine-conversations-client/models/whats_app_conversion_events_body.rb +23 -23
- data/lib/sunshine-conversations-client/models/whats_app_update.rb +25 -26
- data/lib/sunshine-conversations-client/models/whatsapp.rb +70 -49
- data/lib/sunshine-conversations-client/version.rb +3 -3
- data/lib/sunshine-conversations-client.rb +11 -63
- data/spec/spec_helper.rb +2 -2
- data/sunshine-conversations-client.gemspec +5 -5
- metadata +21 -149
- data/docs/ActivityAllOf.md +0 -19
- data/docs/ActivityPostAllOf.md +0 -17
- data/docs/AndroidAllOf.md +0 -33
- data/docs/AndroidUpdateAllOf.md +0 -29
- data/docs/AppleAllOf.md +0 -25
- data/docs/AppleUpdateAllOf.md +0 -17
- data/docs/AttachmentUploadBody.md +0 -17
- data/docs/ClientAddEventAllOf.md +0 -17
- data/docs/ClientRemoveEventAllOf.md +0 -17
- data/docs/ClientUpdateEventAllOf.md +0 -17
- data/docs/ConversationAllOf.md +0 -29
- data/docs/ConversationCreateEventAllOf.md +0 -17
- data/docs/ConversationJoinEventAllOf.md +0 -17
- data/docs/ConversationLeaveEventAllOf.md +0 -17
- data/docs/ConversationMessageDeliveryChannelEventAllOf.md +0 -17
- data/docs/ConversationMessageDeliveryFailureEventAllOf.md +0 -17
- data/docs/ConversationMessageDeliveryPayloadExternalMessages.md +0 -17
- data/docs/ConversationMessageEventAllOf.md +0 -17
- data/docs/ConversationPostbackEventAllOf.md +0 -17
- data/docs/ConversationReadEventAllOf.md +0 -17
- data/docs/ConversationReferralEventAllOf.md +0 -17
- data/docs/ConversationRemoveEventAllOf.md +0 -17
- data/docs/ConversationTypingEventAllOf.md +0 -17
- data/docs/CustomAllOf.md +0 -19
- data/docs/DownloadMessageRefBodyAllOf.md +0 -19
- data/docs/FormMessageFieldAllOf.md +0 -23
- data/docs/FormResponseMessageFieldAllOf.md +0 -17
- data/docs/InlineObject.md +0 -23
- data/docs/InstagramAllOf.md +0 -35
- data/docs/InstagramUpdateAllOf.md +0 -17
- data/docs/IosAllOf.md +0 -31
- data/docs/IosUpdateAllOf.md +0 -27
- data/docs/LineAllOf.md +0 -31
- data/docs/MailgunAllOf.md +0 -27
- data/docs/MailgunUpdateAllOf.md +0 -19
- data/docs/MatchCriteriaMailgunAllOf.md +0 -21
- data/docs/MatchCriteriaMessagebirdAllOf.md +0 -19
- data/docs/MatchCriteriaTwilioAllOf.md +0 -19
- data/docs/MatchCriteriaWhatsappAllOf.md +0 -19
- data/docs/MessagebirdAllOf.md +0 -25
- data/docs/MessengerAllOf.md +0 -27
- data/docs/SourceWithCampaignWebhookAllOf.md +0 -17
- data/docs/SwitchboardAcceptControlAllOf.md +0 -17
- data/docs/SwitchboardAcceptControlFailureAllOf.md +0 -17
- data/docs/SwitchboardOfferControlAllOf.md +0 -17
- data/docs/SwitchboardPassControlAllOf.md +0 -17
- data/docs/SwitchboardReleaseControlAllOf.md +0 -17
- data/docs/TelegramAllOf.md +0 -23
- data/docs/TwilioAllOf.md +0 -25
- data/docs/TwitterAllOf.md +0 -29
- data/docs/UnityAllOf.md +0 -23
- data/docs/UnityUpdateAllOf.md +0 -19
- data/docs/UserAllOf.md +0 -25
- data/docs/UserMergeEventAllOf.md +0 -17
- data/docs/UserRemoveEventAllOf.md +0 -17
- data/docs/UserUpdateEventAllOf.md +0 -17
- data/docs/ViberAllOf.md +0 -23
- data/docs/WebAllOf.md +0 -51
- data/docs/WebUpdateAllOf.md +0 -47
- data/docs/WhatsAppUpdateAllOf.md +0 -21
- data/docs/WhatsappAllOf.md +0 -25
- data/lib/sunshine-conversations-client/models/activity_post_all_of.rb +0 -204
- data/lib/sunshine-conversations-client/models/android_all_of.rb +0 -366
- data/lib/sunshine-conversations-client/models/android_update_all_of.rb +0 -344
- data/lib/sunshine-conversations-client/models/apple_update_all_of.rb +0 -219
- data/lib/sunshine-conversations-client/models/attachment_upload_body.rb +0 -208
- data/lib/sunshine-conversations-client/models/client_add_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/client_remove_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/client_update_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_all_of.rb +0 -316
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_join_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of.rb +0 -213
- data/lib/sunshine-conversations-client/models/form_message_field_all_of.rb +0 -310
- data/lib/sunshine-conversations-client/models/form_response_message_field_all_of.rb +0 -205
- data/lib/sunshine-conversations-client/models/instagram_all_of.rb +0 -303
- data/lib/sunshine-conversations-client/models/instagram_update_all_of.rb +0 -204
- data/lib/sunshine-conversations-client/models/ios_all_of.rb +0 -292
- data/lib/sunshine-conversations-client/models/ios_update_all_of.rb +0 -270
- data/lib/sunshine-conversations-client/models/line_all_of.rb +0 -291
- data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +0 -336
- data/lib/sunshine-conversations-client/models/mailgun_update_all_of.rb +0 -230
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun_all_of.rb +0 -234
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird_all_of.rb +0 -222
- data/lib/sunshine-conversations-client/models/match_criteria_twilio_all_of.rb +0 -222
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp_all_of.rb +0 -222
- data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +0 -302
- data/lib/sunshine-conversations-client/models/messenger_all_of.rb +0 -263
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook_all_of.rb +0 -204
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/switchboard_release_control_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/telegram_all_of.rb +0 -252
- data/lib/sunshine-conversations-client/models/twilio_all_of.rb +0 -297
- data/lib/sunshine-conversations-client/models/twitter_all_of.rb +0 -400
- data/lib/sunshine-conversations-client/models/unity_all_of.rb +0 -236
- data/lib/sunshine-conversations-client/models/unity_update_all_of.rb +0 -214
- data/lib/sunshine-conversations-client/models/user_all_of.rb +0 -239
- data/lib/sunshine-conversations-client/models/user_remove_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/user_update_event_all_of.rb +0 -203
- data/lib/sunshine-conversations-client/models/web_all_of.rb +0 -391
- data/lib/sunshine-conversations-client/models/web_update_all_of.rb +0 -370
- data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +0 -229
- data/lib/sunshine-conversations-client/models/whatsapp_all_of.rb +0 -252
- data/spec/api_client_spec.rb +0 -223
- data/spec/configuration_spec.rb +0 -39
data/docs/PassControlBody.md
CHANGED
|
@@ -2,20 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**switchboard_integration** | **String** | 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 |
|
|
8
|
-
**reason** | **String** | Reason for the pass control action. | [optional]
|
|
9
|
-
**metadata** | **Hash
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **switchboard_integration** | **String** | 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 | |
|
|
8
|
+
| **reason** | **String** | Reason for the pass control action. | [optional] |
|
|
9
|
+
| **metadata** | **Hash<String, 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. The metadata object will be included in the `switchboard:passControl` webhook. | [optional] |
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'sunshine-conversations-client'
|
|
15
15
|
|
|
16
|
-
instance = SunshineConversationsClient::PassControlBody.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = SunshineConversationsClient::PassControlBody.new(
|
|
17
|
+
switchboard_integration: next,
|
|
18
|
+
reason: null,
|
|
19
|
+
metadata: {"lang":"en-ca"}
|
|
20
|
+
)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
data/docs/Postback.md
CHANGED
|
@@ -2,22 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | The type of action. | [default to 'postback']
|
|
8
|
-
**text** | **String** | The button text. |
|
|
9
|
-
**payload** | **String** | The payload of a postback or reply button. |
|
|
10
|
-
**metadata** | **Hash<String, 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]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of action. | [default to 'postback'] |
|
|
8
|
+
| **text** | **String** | The button text. | |
|
|
9
|
+
| **payload** | **String** | The payload of a postback or reply button. | |
|
|
10
|
+
| **metadata** | **Hash<String, 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
11
|
|
|
12
|
-
##
|
|
12
|
+
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'sunshine-conversations-client'
|
|
16
16
|
|
|
17
|
-
instance = SunshineConversationsClient::Postback.new(
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
instance = SunshineConversationsClient::Postback.new(
|
|
18
|
+
type: null,
|
|
19
|
+
text: null,
|
|
20
|
+
payload: null,
|
|
21
|
+
metadata: {"lang":"en-ca"}
|
|
22
|
+
)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
|
data/docs/PostbackWebhook.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**payload** | **String** | The payload associated with the postback. | [optional]
|
|
8
|
-
**metadata** | **Hash<String, 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]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payload** | **String** | The payload associated with the postback. | [optional] |
|
|
8
|
+
| **metadata** | **Hash<String, 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
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'sunshine-conversations-client'
|
|
14
14
|
|
|
15
|
-
instance = SunshineConversationsClient::PostbackWebhook.new(
|
|
16
|
-
|
|
15
|
+
instance = SunshineConversationsClient::PostbackWebhook.new(
|
|
16
|
+
payload: null,
|
|
17
|
+
metadata: {"lang":"en-ca"}
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
data/docs/PrechatCapture.md
CHANGED
|
@@ -2,22 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**avatar_url** | **String** | Sets the URL of the avatar to use for the automatic reply to the prechat capture messages. | [optional]
|
|
8
|
-
**enabled** | **Boolean** | If true, enables the Prechat Capture add-on when the Web Messenger is initialized. | [optional]
|
|
9
|
-
**enable_email_linking** | **Boolean** | f true and Mailgun is integrated, will automatically link submitted emails. | [optional]
|
|
10
|
-
**fields** | [**Array<Field>**](Field.md) | Array of Fields. Overrides the default Prechat Capture fields to define a custom form. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **avatar_url** | **String** | Sets the URL of the avatar to use for the automatic reply to the prechat capture messages. | [optional][default to 'undefined'] |
|
|
8
|
+
| **enabled** | **Boolean** | If true, enables the Prechat Capture add-on when the Web Messenger is initialized. | [optional][default to false] |
|
|
9
|
+
| **enable_email_linking** | **Boolean** | f true and Mailgun is integrated, will automatically link submitted emails. | [optional][default to false] |
|
|
10
|
+
| **fields** | [**Array<Field>**](Field.md) | Array of Fields. Overrides the default Prechat Capture fields to define a custom form. | [optional] |
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'sunshine-conversations-client'
|
|
16
16
|
|
|
17
|
-
instance = SunshineConversationsClient::PrechatCapture.new(
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
instance = SunshineConversationsClient::PrechatCapture.new(
|
|
18
|
+
avatar_url: https://domain.com/images/avatar.png,
|
|
19
|
+
enabled: null,
|
|
20
|
+
enable_email_linking: null,
|
|
21
|
+
fields: [{"type":"email","name":"email","label":"Email","placeholder":"your@email.com"},{"type":"text","name":"company-website","label":"Company website","placeholder":"mycompany.com"}]
|
|
22
|
+
)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
|
data/docs/Profile.md
CHANGED
|
@@ -2,24 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**given_name** | **String** | The user's given name (first name). | [optional]
|
|
8
|
-
**surname** | **String** | The user's surname (last name). | [optional]
|
|
9
|
-
**email** | **String** | The user's email address. | [optional]
|
|
10
|
-
**avatar_url** | **String** | The user's avatar. | [optional]
|
|
11
|
-
**locale** | **String** | End-user's locale information in BCP 47 format. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **given_name** | **String** | The user's given name (first name). | [optional] |
|
|
8
|
+
| **surname** | **String** | The user's surname (last name). | [optional] |
|
|
9
|
+
| **email** | **String** | The user's email address. | [optional] |
|
|
10
|
+
| **avatar_url** | **String** | The user's avatar. | [optional] |
|
|
11
|
+
| **locale** | **String** | End-user's locale information in BCP 47 format. | [optional] |
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Example
|
|
14
14
|
|
|
15
15
|
```ruby
|
|
16
|
-
require '
|
|
16
|
+
require 'sunshine-conversations-client'
|
|
17
17
|
|
|
18
|
-
instance = SunshineConversationsClient::Profile.new(
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
18
|
+
instance = SunshineConversationsClient::Profile.new(
|
|
19
|
+
given_name: Jane,
|
|
20
|
+
surname: Doe,
|
|
21
|
+
email: jane.doe@gmail.com,
|
|
22
|
+
avatar_url: https://s3.amazonaws.com/avatar.jpg,
|
|
23
|
+
locale: fr-CA
|
|
24
|
+
)
|
|
23
25
|
```
|
|
24
26
|
|
|
25
|
-
|
data/docs/QuotedMessage.md
CHANGED
|
@@ -1,21 +1,79 @@
|
|
|
1
1
|
# SunshineConversationsClient::QuotedMessage
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Class instance methods
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**type** | **String** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [default to 'externalMessageId']
|
|
8
|
-
**message** | [**Message**](Message.md) | | [optional]
|
|
9
|
-
**external_message_id** | **String** | The external message Id of the quoted message. | [optional]
|
|
5
|
+
### `openapi_one_of`
|
|
10
6
|
|
|
11
|
-
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sunshine-conversations-client'
|
|
13
|
+
|
|
14
|
+
SunshineConversationsClient::QuotedMessage.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'QuotedMessageExternalMessageId',
|
|
18
|
+
# :'QuotedMessageMessage'
|
|
19
|
+
# ]
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### `openapi_discriminator_name`
|
|
23
|
+
|
|
24
|
+
Returns the discriminator's property name.
|
|
25
|
+
|
|
26
|
+
#### Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'sunshine-conversations-client'
|
|
30
|
+
|
|
31
|
+
SunshineConversationsClient::QuotedMessage.openapi_discriminator_name
|
|
32
|
+
# => :'type'
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### `openapi_discriminator_name`
|
|
36
|
+
|
|
37
|
+
Returns the discriminator's mapping.
|
|
38
|
+
|
|
39
|
+
#### Example
|
|
12
40
|
|
|
13
41
|
```ruby
|
|
14
|
-
require '
|
|
42
|
+
require 'sunshine-conversations-client'
|
|
15
43
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
44
|
+
SunshineConversationsClient::QuotedMessage.openapi_discriminator_mapping
|
|
45
|
+
# =>
|
|
46
|
+
# {
|
|
47
|
+
# :'externalMessageId' => :'QuotedMessageExternalMessageId',
|
|
48
|
+
# :'message' => :'QuotedMessageMessage'
|
|
49
|
+
# }
|
|
19
50
|
```
|
|
20
51
|
|
|
52
|
+
### build
|
|
53
|
+
|
|
54
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
55
|
+
|
|
56
|
+
#### Example
|
|
57
|
+
|
|
58
|
+
```ruby
|
|
59
|
+
require 'sunshine-conversations-client'
|
|
60
|
+
|
|
61
|
+
SunshineConversationsClient::QuotedMessage.build(data)
|
|
62
|
+
# => #<QuotedMessageExternalMessageId:0x00007fdd4aab02a0>
|
|
63
|
+
|
|
64
|
+
SunshineConversationsClient::QuotedMessage.build(data_that_doesnt_match)
|
|
65
|
+
# => nil
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
#### Parameters
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description |
|
|
71
|
+
| ---- | ---- | ----------- |
|
|
72
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
73
|
+
|
|
74
|
+
#### Return type
|
|
75
|
+
|
|
76
|
+
- `QuotedMessageExternalMessageId`
|
|
77
|
+
- `QuotedMessageMessage`
|
|
78
|
+
- `nil` (if no type matches)
|
|
21
79
|
|
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [default to 'externalMessageId']
|
|
8
|
-
**external_message_id** | **String** | The external message Id of the quoted message. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [default to 'externalMessageId'] |
|
|
8
|
+
| **external_message_id** | **String** | The external message Id of the quoted message. | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'sunshine-conversations-client'
|
|
14
14
|
|
|
15
|
-
instance = SunshineConversationsClient::QuotedMessageExternalMessageId.new(
|
|
16
|
-
|
|
15
|
+
instance = SunshineConversationsClient::QuotedMessageExternalMessageId.new(
|
|
16
|
+
type: null,
|
|
17
|
+
external_message_id: null
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | The type of quotedMessage - a complete Sunshine Conversations message is provided. | [default to 'message']
|
|
8
|
-
**message** | [**Message**](Message.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of quotedMessage - a complete Sunshine Conversations message is provided. | [default to 'message'] |
|
|
8
|
+
| **message** | [**Message**](Message.md) | | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'sunshine-conversations-client'
|
|
14
14
|
|
|
15
|
-
instance = SunshineConversationsClient::QuotedMessageMessage.new(
|
|
16
|
-
|
|
15
|
+
instance = SunshineConversationsClient::QuotedMessageMessage.new(
|
|
16
|
+
type: null,
|
|
17
|
+
message: null
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
data/docs/Referral.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**code** | **String** | The referral’s identifier. | [optional]
|
|
8
|
-
**details** | [**ReferralDetails**](ReferralDetails.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | The referral’s identifier. | [optional] |
|
|
8
|
+
| **details** | [**ReferralDetails**](ReferralDetails.md) | | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'sunshine-conversations-client'
|
|
14
14
|
|
|
15
|
-
instance = SunshineConversationsClient::Referral.new(
|
|
16
|
-
|
|
15
|
+
instance = SunshineConversationsClient::Referral.new(
|
|
16
|
+
code: null,
|
|
17
|
+
details: null
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
data/docs/ReferralDetails.md
CHANGED
|
@@ -2,20 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**source** | **String** | The source of the referral - MESSENGER_CODE, ADS etc… | [optional]
|
|
8
|
-
**type** | **String** | The type of referral, typically OPEN-THREAD. | [optional]
|
|
9
|
-
**ad_id** | **String** | If the referral came from an ad, this field will be present with the ad’s Id. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **source** | **String** | The source of the referral - MESSENGER_CODE, ADS etc… | [optional] |
|
|
8
|
+
| **type** | **String** | The type of referral, typically OPEN-THREAD. | [optional] |
|
|
9
|
+
| **ad_id** | **String** | If the referral came from an ad, this field will be present with the ad’s Id. | [optional] |
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'sunshine-conversations-client'
|
|
15
15
|
|
|
16
|
-
instance = SunshineConversationsClient::ReferralDetails.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = SunshineConversationsClient::ReferralDetails.new(
|
|
17
|
+
source: MESSENGER_CODE,
|
|
18
|
+
type: OPEN-THREAD,
|
|
19
|
+
ad_id: 4216212847577
|
|
20
|
+
)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
data/docs/ReleaseControlBody.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**reason** | **String** | Reason for the release control action. | [optional]
|
|
8
|
-
**metadata** | **Hash
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reason** | **String** | Reason for the release control action. | [optional] |
|
|
8
|
+
| **metadata** | **Hash<String, 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. The metadata object will be included in the `switchboard:releaseControl` webhook. | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'sunshine-conversations-client'
|
|
14
14
|
|
|
15
|
-
instance = SunshineConversationsClient::ReleaseControlBody.new(
|
|
16
|
-
|
|
15
|
+
instance = SunshineConversationsClient::ReleaseControlBody.new(
|
|
16
|
+
reason: null,
|
|
17
|
+
metadata: {"lang":"en-ca"}
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
data/docs/Reply.md
CHANGED
|
@@ -2,24 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | The type of action. |
|
|
8
|
-
**text** | **String** | 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. |
|
|
9
|
-
**payload** | **String** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. |
|
|
10
|
-
**metadata** | **Hash<String, 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
|
-
**icon_url** | **String** | An icon to render next to the reply option. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of action. | |
|
|
8
|
+
| **text** | **String** | 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. | |
|
|
9
|
+
| **payload** | **String** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. | |
|
|
10
|
+
| **metadata** | **Hash<String, 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
|
+
| **icon_url** | **String** | An icon to render next to the reply option. | [optional] |
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Example
|
|
14
14
|
|
|
15
15
|
```ruby
|
|
16
|
-
require '
|
|
16
|
+
require 'sunshine-conversations-client'
|
|
17
17
|
|
|
18
|
-
instance = SunshineConversationsClient::Reply.new(
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
18
|
+
instance = SunshineConversationsClient::Reply.new(
|
|
19
|
+
type: null,
|
|
20
|
+
text: null,
|
|
21
|
+
payload: null,
|
|
22
|
+
metadata: {"lang":"en-ca"},
|
|
23
|
+
icon_url: null
|
|
24
|
+
)
|
|
23
25
|
```
|
|
24
26
|
|
|
25
|
-
|
data/docs/Source.md
CHANGED
|
@@ -2,26 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. |
|
|
8
|
-
**integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional]
|
|
9
|
-
**original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional]
|
|
10
|
-
**original_message_timestamp** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when the third party channel received the message. | [optional]
|
|
11
|
-
**client** | [**Client**](Client.md) | The client from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the `includeFullSource` option is enabled. | [optional]
|
|
12
|
-
**device** | [**Device**](Device.md) | The device from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the `includeFullSource` option is enabled. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | |
|
|
8
|
+
| **integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] |
|
|
9
|
+
| **original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional] |
|
|
10
|
+
| **original_message_timestamp** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when the third party channel received the message. | [optional] |
|
|
11
|
+
| **client** | [**Client**](Client.md) | The client from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the `includeFullSource` option is enabled. | [optional] |
|
|
12
|
+
| **device** | [**Device**](Device.md) | The device from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the `includeFullSource` option is enabled. | [optional] |
|
|
13
13
|
|
|
14
|
-
##
|
|
14
|
+
## Example
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
|
-
require '
|
|
17
|
+
require 'sunshine-conversations-client'
|
|
18
18
|
|
|
19
|
-
instance = SunshineConversationsClient::Source.new(
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
19
|
+
instance = SunshineConversationsClient::Source.new(
|
|
20
|
+
type: ios,
|
|
21
|
+
integration_id: de13bee15b51033b34162411,
|
|
22
|
+
original_message_id: 5f40256af057d0000dda9bd7,
|
|
23
|
+
original_message_timestamp: 2019-03-21T18:45:53.720Z,
|
|
24
|
+
client: null,
|
|
25
|
+
device: null
|
|
26
|
+
)
|
|
25
27
|
```
|
|
26
28
|
|
|
27
|
-
|
data/docs/SourceWebhook.md
CHANGED
|
@@ -2,26 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional]
|
|
8
|
-
**integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional]
|
|
9
|
-
**original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional]
|
|
10
|
-
**original_message_timestamp** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional]
|
|
11
|
-
**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]
|
|
12
|
-
**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]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional] |
|
|
8
|
+
| **integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] |
|
|
9
|
+
| **original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional] |
|
|
10
|
+
| **original_message_timestamp** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional] |
|
|
11
|
+
| **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] |
|
|
12
|
+
| **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] |
|
|
13
13
|
|
|
14
|
-
##
|
|
14
|
+
## Example
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
|
-
require '
|
|
17
|
+
require 'sunshine-conversations-client'
|
|
18
18
|
|
|
19
|
-
instance = SunshineConversationsClient::SourceWebhook.new(
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
19
|
+
instance = SunshineConversationsClient::SourceWebhook.new(
|
|
20
|
+
type: ios,
|
|
21
|
+
integration_id: null,
|
|
22
|
+
original_message_id: null,
|
|
23
|
+
original_message_timestamp: null,
|
|
24
|
+
client: null,
|
|
25
|
+
device: null
|
|
26
|
+
)
|
|
25
27
|
```
|
|
26
28
|
|
|
27
|
-
|
|
@@ -2,28 +2,29 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional]
|
|
8
|
-
**integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional]
|
|
9
|
-
**original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional]
|
|
10
|
-
**original_message_timestamp** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional]
|
|
11
|
-
**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]
|
|
12
|
-
**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]
|
|
13
|
-
**campaign** | [**Campaign**](Campaign.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional] |
|
|
8
|
+
| **integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] |
|
|
9
|
+
| **original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional] |
|
|
10
|
+
| **original_message_timestamp** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional] |
|
|
11
|
+
| **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] |
|
|
12
|
+
| **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] |
|
|
13
|
+
| **campaign** | [**Campaign**](Campaign.md) | | [optional] |
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Example
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
|
-
require '
|
|
18
|
+
require 'sunshine-conversations-client'
|
|
19
19
|
|
|
20
|
-
instance = SunshineConversationsClient::SourceWithCampaignWebhook.new(
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
20
|
+
instance = SunshineConversationsClient::SourceWithCampaignWebhook.new(
|
|
21
|
+
type: ios,
|
|
22
|
+
integration_id: null,
|
|
23
|
+
original_message_id: null,
|
|
24
|
+
original_message_timestamp: null,
|
|
25
|
+
client: null,
|
|
26
|
+
device: null,
|
|
27
|
+
campaign: null
|
|
28
|
+
)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
|
-
|
data/docs/Status.md
CHANGED
|
@@ -2,15 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Example
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
require '
|
|
11
|
+
require 'sunshine-conversations-client'
|
|
12
12
|
|
|
13
13
|
instance = SunshineConversationsClient::Status.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|