sunshine-conversations-client 9.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG_RB.md +12 -0
- data/Gemfile +9 -0
- data/LICENSE +176 -0
- data/README.md +456 -0
- data/Rakefile +10 -0
- data/docs/AcceptControlBody.md +17 -0
- data/docs/Action.md +41 -0
- data/docs/ActionSubset.md +39 -0
- data/docs/ActivitiesApi.md +71 -0
- data/docs/Activity.md +21 -0
- data/docs/ActivityAllOf.md +19 -0
- data/docs/ActivityPost.md +19 -0
- data/docs/ActivityPostAllOf.md +17 -0
- data/docs/ActivityTypes.md +17 -0
- data/docs/Android.md +23 -0
- data/docs/AndroidAllOf.md +23 -0
- data/docs/AndroidUpdate.md +23 -0
- data/docs/AndroidUpdateAllOf.md +21 -0
- data/docs/ApiKey.md +21 -0
- data/docs/App.md +23 -0
- data/docs/AppCreateBody.md +21 -0
- data/docs/AppKey.md +21 -0
- data/docs/AppKeyCreateBody.md +17 -0
- data/docs/AppKeyListResponse.md +17 -0
- data/docs/AppKeyResponse.md +17 -0
- data/docs/AppKeysApi.md +250 -0
- data/docs/AppListFilter.md +17 -0
- data/docs/AppListResponse.md +21 -0
- data/docs/AppResponse.md +17 -0
- data/docs/AppSettings.md +31 -0
- data/docs/AppSubSchema.md +17 -0
- data/docs/AppUpdateBody.md +21 -0
- data/docs/Apple.md +23 -0
- data/docs/AppleAllOf.md +23 -0
- data/docs/AppleUpdate.md +16 -0
- data/docs/AppsApi.md +309 -0
- data/docs/AttachmentDeleteBody.md +17 -0
- data/docs/AttachmentMediaTokenBody.md +17 -0
- data/docs/AttachmentMediaTokenResponse.md +17 -0
- data/docs/AttachmentResponse.md +17 -0
- data/docs/AttachmentSchema.md +19 -0
- data/docs/AttachmentUploadBody.md +17 -0
- data/docs/AttachmentsApi.md +254 -0
- data/docs/Author.md +25 -0
- data/docs/AuthorWebhook.md +21 -0
- data/docs/Buy.md +25 -0
- data/docs/CarouselMessage.md +23 -0
- data/docs/CarouselMessageDisplaySettings.md +17 -0
- data/docs/Client.md +37 -0
- data/docs/ClientAssociation.md +19 -0
- data/docs/ClientCreate.md +21 -0
- data/docs/ClientListResponse.md +21 -0
- data/docs/ClientResponse.md +17 -0
- data/docs/ClientType.md +16 -0
- data/docs/ClientsApi.md +199 -0
- data/docs/Confirmation.md +19 -0
- data/docs/Content.md +41 -0
- data/docs/Conversation.md +37 -0
- data/docs/ConversationAllOf.md +29 -0
- data/docs/ConversationCreateBody.md +27 -0
- data/docs/ConversationCreateEvent.md +23 -0
- data/docs/ConversationCreateEventAllOf.md +17 -0
- data/docs/ConversationCreateEventAllOfPayload.md +25 -0
- data/docs/ConversationListFilter.md +19 -0
- data/docs/ConversationListResponse.md +21 -0
- data/docs/ConversationMessageDeliveryChannelEvent.md +23 -0
- data/docs/ConversationMessageDeliveryChannelEventAllOf.md +17 -0
- data/docs/ConversationMessageDeliveryFailureEvent.md +23 -0
- data/docs/ConversationMessageDeliveryFailureEventAllOf.md +17 -0
- data/docs/ConversationMessageDeliveryPayload.md +27 -0
- data/docs/ConversationMessageDeliveryPayloadDestination.md +19 -0
- data/docs/ConversationMessageDeliveryPayloadExternalMessages.md +17 -0
- data/docs/ConversationMessageDeliveryPayloadMessage.md +17 -0
- data/docs/ConversationMessageDeliveryUserEvent.md +23 -0
- data/docs/ConversationMessageEvent.md +23 -0
- data/docs/ConversationMessageEventAllOf.md +17 -0
- data/docs/ConversationMessageEventAllOfPayload.md +21 -0
- data/docs/ConversationPostbackEvent.md +23 -0
- data/docs/ConversationPostbackEventAllOf.md +17 -0
- data/docs/ConversationPostbackEventAllOfPayload.md +23 -0
- data/docs/ConversationReadEvent.md +23 -0
- data/docs/ConversationReadEventAllOf.md +17 -0
- data/docs/ConversationReadEventAllOfPayload.md +19 -0
- data/docs/ConversationResponse.md +17 -0
- data/docs/ConversationTruncated.md +23 -0
- data/docs/ConversationType.md +16 -0
- data/docs/ConversationTypingEvent.md +23 -0
- data/docs/ConversationTypingEventAllOf.md +17 -0
- data/docs/ConversationTypingEventAllOfPayload.md +19 -0
- data/docs/ConversationUpdateBody.md +23 -0
- data/docs/ConversationsApi.md +319 -0
- data/docs/Custom.md +19 -0
- data/docs/CustomAllOf.md +19 -0
- data/docs/CustomIntegrationApiKeysApi.md +258 -0
- data/docs/CustomUpdate.md +16 -0
- data/docs/Destination.md +19 -0
- data/docs/Device.md +35 -0
- data/docs/EventSubSchema.md +21 -0
- data/docs/ExtraChannelOptions.md +17 -0
- data/docs/ExtraChannelOptionsMessenger.md +19 -0
- data/docs/Field.md +35 -0
- data/docs/FileMessage.md +25 -0
- data/docs/FormMessage.md +21 -0
- data/docs/FormResponseMessage.md +21 -0
- data/docs/ImageMessage.md +23 -0
- data/docs/InlineObject.md +23 -0
- data/docs/Integration.md +23 -0
- data/docs/IntegrationApiKey.md +17 -0
- data/docs/IntegrationApiKeyListResponse.md +17 -0
- data/docs/IntegrationApiKeyResponse.md +17 -0
- data/docs/IntegrationId.md +17 -0
- data/docs/IntegrationListFilter.md +17 -0
- data/docs/IntegrationListResponse.md +21 -0
- data/docs/IntegrationResponse.md +17 -0
- data/docs/IntegrationType.md +17 -0
- data/docs/IntegrationUpdate.md +71 -0
- data/docs/IntegrationUpdateBase.md +17 -0
- data/docs/IntegrationsApi.md +319 -0
- data/docs/Ios.md +27 -0
- data/docs/IosAllOf.md +27 -0
- data/docs/IosUpdate.md +27 -0
- data/docs/IosUpdateAllOf.md +25 -0
- data/docs/Item.md +29 -0
- data/docs/Line.md +31 -0
- data/docs/LineAllOf.md +31 -0
- data/docs/LineUpdate.md +16 -0
- data/docs/Link.md +27 -0
- data/docs/Links.md +19 -0
- data/docs/ListMessage.md +21 -0
- data/docs/LocationMessage.md +23 -0
- data/docs/LocationMessageCoordinates.md +19 -0
- data/docs/LocationMessageLocation.md +19 -0
- data/docs/LocationRequest.md +21 -0
- data/docs/Mailgun.md +27 -0
- data/docs/MailgunAllOf.md +27 -0
- data/docs/MailgunUpdate.md +21 -0
- data/docs/MailgunUpdateAllOf.md +19 -0
- data/docs/MatchCriteria.md +27 -0
- data/docs/MatchCriteriaBase.md +21 -0
- data/docs/MatchCriteriaMailgun.md +25 -0
- data/docs/MatchCriteriaMailgunAllOf.md +21 -0
- data/docs/MatchCriteriaMessagebird.md +23 -0
- data/docs/MatchCriteriaMessagebirdAllOf.md +19 -0
- data/docs/MatchCriteriaTwilio.md +23 -0
- data/docs/MatchCriteriaTwilioAllOf.md +19 -0
- data/docs/MatchCriteriaWhatsapp.md +23 -0
- data/docs/MatchCriteriaWhatsappAllOf.md +19 -0
- data/docs/Message.md +31 -0
- data/docs/MessageBirdUpdate.md +16 -0
- data/docs/MessageListResponse.md +21 -0
- data/docs/MessageOverride.md +23 -0
- data/docs/MessageOverrideApple.md +17 -0
- data/docs/MessageOverrideLine.md +17 -0
- data/docs/MessageOverrideMessenger.md +17 -0
- data/docs/MessageOverridePayload.md +17 -0
- data/docs/MessageOverrideWhatsapp.md +17 -0
- data/docs/MessagePost.md +27 -0
- data/docs/MessagePostResponse.md +17 -0
- data/docs/MessageWebhook.md +31 -0
- data/docs/Messagebird.md +25 -0
- data/docs/MessagebirdAllOf.md +25 -0
- data/docs/MessagesApi.md +260 -0
- data/docs/Messenger.md +23 -0
- data/docs/MessengerAllOf.md +23 -0
- data/docs/MessengerUpdate.md +19 -0
- data/docs/MessengerUpdateAllOf.md +17 -0
- data/docs/Meta.md +21 -0
- data/docs/OAuthEndpointsApi.md +168 -0
- data/docs/OfferControlBody.md +19 -0
- data/docs/Page.md +21 -0
- data/docs/Participant.md +27 -0
- data/docs/ParticipantJoinBody.md +16 -0
- data/docs/ParticipantLeaveBody.md +21 -0
- data/docs/ParticipantLeaveBodyParticipantId.md +17 -0
- data/docs/ParticipantLeaveBodyUserExternalId.md +17 -0
- data/docs/ParticipantLeaveBodyUserId.md +17 -0
- data/docs/ParticipantListResponse.md +21 -0
- data/docs/ParticipantResponse.md +17 -0
- data/docs/ParticipantSubSchema.md +21 -0
- data/docs/ParticipantWithUserExternalId.md +19 -0
- data/docs/ParticipantWithUserId.md +19 -0
- data/docs/ParticipantsApi.md +199 -0
- data/docs/PassControlBody.md +19 -0
- data/docs/Postback.md +23 -0
- data/docs/PostbackWebhook.md +19 -0
- data/docs/PrechatCapture.md +23 -0
- data/docs/Profile.md +23 -0
- data/docs/QuotedMessage.md +21 -0
- data/docs/QuotedMessageExternalMessageId.md +19 -0
- data/docs/QuotedMessageMessage.md +19 -0
- data/docs/Referral.md +19 -0
- data/docs/ReferralDetails.md +21 -0
- data/docs/Reply.md +25 -0
- data/docs/Source.md +27 -0
- data/docs/SourceWebhook.md +27 -0
- data/docs/Status.md +16 -0
- data/docs/Switchboard.md +21 -0
- data/docs/SwitchboardAcceptControl.md +23 -0
- data/docs/SwitchboardAcceptControlAllOf.md +17 -0
- data/docs/SwitchboardAcceptControlAllOfPayload.md +19 -0
- data/docs/SwitchboardAcceptControlFailure.md +23 -0
- data/docs/SwitchboardAcceptControlFailureAllOf.md +17 -0
- data/docs/SwitchboardAcceptControlFailureAllOfPayload.md +21 -0
- data/docs/SwitchboardActionsApi.md +197 -0
- data/docs/SwitchboardIntegration.md +29 -0
- data/docs/SwitchboardIntegrationCreateBody.md +27 -0
- data/docs/SwitchboardIntegrationListResponse.md +17 -0
- data/docs/SwitchboardIntegrationResponse.md +17 -0
- data/docs/SwitchboardIntegrationUpdateBody.md +27 -0
- data/docs/SwitchboardIntegrationWebhook.md +23 -0
- data/docs/SwitchboardIntegrationsApi.md +260 -0
- data/docs/SwitchboardListResponse.md +17 -0
- data/docs/SwitchboardOfferControl.md +23 -0
- data/docs/SwitchboardOfferControlAllOf.md +17 -0
- data/docs/SwitchboardOfferControlAllOfPayload.md +19 -0
- data/docs/SwitchboardOfferControlFailure.md +23 -0
- data/docs/SwitchboardPassControl.md +23 -0
- data/docs/SwitchboardPassControlAllOf.md +17 -0
- data/docs/SwitchboardPassControlAllOfPayload.md +19 -0
- data/docs/SwitchboardPassControlFailure.md +23 -0
- data/docs/SwitchboardResponse.md +17 -0
- data/docs/SwitchboardUpdateBody.md +19 -0
- data/docs/SwitchboardsApi.md +250 -0
- data/docs/Target.md +17 -0
- data/docs/Telegram.md +23 -0
- data/docs/TelegramAllOf.md +23 -0
- data/docs/TelegramUpdate.md +16 -0
- data/docs/TextMessage.md +21 -0
- data/docs/Twilio.md +23 -0
- data/docs/TwilioAllOf.md +23 -0
- data/docs/TwilioUpdate.md +16 -0
- data/docs/Twitter.md +29 -0
- data/docs/TwitterAllOf.md +29 -0
- data/docs/TwitterUpdate.md +16 -0
- data/docs/User.md +25 -0
- data/docs/UserAllOf.md +21 -0
- data/docs/UserCreateBody.md +23 -0
- data/docs/UserMergeEvent.md +23 -0
- data/docs/UserMergeEventAllOf.md +17 -0
- data/docs/UserMergeEventAllOfPayload.md +21 -0
- data/docs/UserMergeEventAllOfPayloadMergedConversations.md +19 -0
- data/docs/UserMergeEventAllOfPayloadMergedUsers.md +19 -0
- data/docs/UserResponse.md +17 -0
- data/docs/UserTruncated.md +19 -0
- data/docs/UserUpdateBody.md +21 -0
- data/docs/UsersApi.md +315 -0
- data/docs/Viber.md +23 -0
- data/docs/ViberAllOf.md +23 -0
- data/docs/ViberUpdate.md +16 -0
- data/docs/Web.md +47 -0
- data/docs/WebAllOf.md +47 -0
- data/docs/WebUpdate.md +47 -0
- data/docs/WebUpdateAllOf.md +45 -0
- data/docs/Webhook.md +29 -0
- data/docs/WebhookBody.md +23 -0
- data/docs/WebhookCreateBody.md +16 -0
- data/docs/WebhookListResponse.md +17 -0
- data/docs/WebhookResponse.md +17 -0
- data/docs/WebhookSubSchema.md +19 -0
- data/docs/WebhooksApi.md +323 -0
- data/docs/Webview.md +33 -0
- data/docs/WhatsAppUpdate.md +23 -0
- data/docs/WhatsAppUpdateAllOf.md +21 -0
- data/docs/Whatsapp.md +25 -0
- data/docs/WhatsappAllOf.md +25 -0
- data/lib/sunshine-conversations-client.rb +306 -0
- data/lib/sunshine-conversations-client/api/activities_api.rb +95 -0
- data/lib/sunshine-conversations-client/api/app_keys_api.rb +287 -0
- data/lib/sunshine-conversations-client/api/apps_api.rb +339 -0
- data/lib/sunshine-conversations-client/api/attachments_api.rb +305 -0
- data/lib/sunshine-conversations-client/api/clients_api.rb +240 -0
- data/lib/sunshine-conversations-client/api/conversations_api.rb +373 -0
- data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +311 -0
- data/lib/sunshine-conversations-client/api/integrations_api.rb +369 -0
- data/lib/sunshine-conversations-client/api/messages_api.rb +308 -0
- data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +213 -0
- data/lib/sunshine-conversations-client/api/participants_api.rb +242 -0
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +247 -0
- data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb +319 -0
- data/lib/sunshine-conversations-client/api/switchboards_api.rb +287 -0
- data/lib/sunshine-conversations-client/api/users_api.rb +369 -0
- data/lib/sunshine-conversations-client/api/webhooks_api.rb +393 -0
- data/lib/sunshine-conversations-client/api_client.rb +348 -0
- data/lib/sunshine-conversations-client/api_error.rb +54 -0
- data/lib/sunshine-conversations-client/configuration.rb +284 -0
- data/lib/sunshine-conversations-client/models/accept_control_body.rb +204 -0
- data/lib/sunshine-conversations-client/models/action.rb +421 -0
- data/lib/sunshine-conversations-client/models/action_subset.rb +409 -0
- data/lib/sunshine-conversations-client/models/activity.rb +265 -0
- data/lib/sunshine-conversations-client/models/activity_all_of.rb +213 -0
- data/lib/sunshine-conversations-client/models/activity_post.rb +266 -0
- data/lib/sunshine-conversations-client/models/activity_post_all_of.rb +204 -0
- data/lib/sunshine-conversations-client/models/activity_types.rb +238 -0
- data/lib/sunshine-conversations-client/models/android.rb +280 -0
- data/lib/sunshine-conversations-client/models/android_all_of.rb +268 -0
- data/lib/sunshine-conversations-client/models/android_update.rb +299 -0
- data/lib/sunshine-conversations-client/models/android_update_all_of.rb +256 -0
- data/lib/sunshine-conversations-client/models/api_key.rb +225 -0
- data/lib/sunshine-conversations-client/models/app.rb +234 -0
- data/lib/sunshine-conversations-client/models/app_create_body.rb +229 -0
- data/lib/sunshine-conversations-client/models/app_key.rb +224 -0
- data/lib/sunshine-conversations-client/models/app_key_create_body.rb +209 -0
- data/lib/sunshine-conversations-client/models/app_key_list_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/app_key_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/app_list_filter.rb +204 -0
- data/lib/sunshine-conversations-client/models/app_list_response.rb +221 -0
- data/lib/sunshine-conversations-client/models/app_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/app_settings.rb +290 -0
- data/lib/sunshine-conversations-client/models/app_sub_schema.rb +205 -0
- data/lib/sunshine-conversations-client/models/app_update_body.rb +224 -0
- data/lib/sunshine-conversations-client/models/apple.rb +263 -0
- data/lib/sunshine-conversations-client/models/apple_all_of.rb +252 -0
- data/lib/sunshine-conversations-client/models/apple_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/attachment_delete_body.rb +209 -0
- data/lib/sunshine-conversations-client/models/attachment_media_token_body.rb +208 -0
- data/lib/sunshine-conversations-client/models/attachment_media_token_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/attachment_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/attachment_schema.rb +214 -0
- data/lib/sunshine-conversations-client/models/attachment_upload_body.rb +208 -0
- data/lib/sunshine-conversations-client/models/author.rb +284 -0
- data/lib/sunshine-conversations-client/models/author_webhook.rb +264 -0
- data/lib/sunshine-conversations-client/models/buy.rb +262 -0
- data/lib/sunshine-conversations-client/models/carousel_message.rb +245 -0
- data/lib/sunshine-conversations-client/models/carousel_message_display_settings.rb +239 -0
- data/lib/sunshine-conversations-client/models/client.rb +345 -0
- data/lib/sunshine-conversations-client/models/client_association.rb +213 -0
- data/lib/sunshine-conversations-client/models/client_create.rb +236 -0
- data/lib/sunshine-conversations-client/models/client_list_response.rb +221 -0
- data/lib/sunshine-conversations-client/models/client_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/client_type.rb +42 -0
- data/lib/sunshine-conversations-client/models/confirmation.rb +254 -0
- data/lib/sunshine-conversations-client/models/content.rb +380 -0
- data/lib/sunshine-conversations-client/models/conversation.rb +366 -0
- data/lib/sunshine-conversations-client/models/conversation_all_of.rb +317 -0
- data/lib/sunshine-conversations-client/models/conversation_create_body.rb +308 -0
- data/lib/sunshine-conversations-client/models/conversation_create_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb +281 -0
- data/lib/sunshine-conversations-client/models/conversation_list_filter.rb +214 -0
- data/lib/sunshine-conversations-client/models/conversation_list_response.rb +221 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload.rb +253 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_destination.rb +215 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_external_messages.rb +204 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_message.rb +205 -0
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_user_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_message_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of_payload.rb +224 -0
- data/lib/sunshine-conversations-client/models/conversation_postback_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of_payload.rb +235 -0
- data/lib/sunshine-conversations-client/models/conversation_read_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of_payload.rb +215 -0
- data/lib/sunshine-conversations-client/models/conversation_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/conversation_truncated.rb +235 -0
- data/lib/sunshine-conversations-client/models/conversation_type.rb +33 -0
- data/lib/sunshine-conversations-client/models/conversation_typing_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of_payload.rb +215 -0
- data/lib/sunshine-conversations-client/models/conversation_update_body.rb +285 -0
- data/lib/sunshine-conversations-client/models/custom.rb +232 -0
- data/lib/sunshine-conversations-client/models/custom_all_of.rb +220 -0
- data/lib/sunshine-conversations-client/models/custom_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/destination.rb +239 -0
- data/lib/sunshine-conversations-client/models/device.rb +343 -0
- data/lib/sunshine-conversations-client/models/event_sub_schema.rb +224 -0
- data/lib/sunshine-conversations-client/models/extra_channel_options.rb +204 -0
- data/lib/sunshine-conversations-client/models/extra_channel_options_messenger.rb +251 -0
- data/lib/sunshine-conversations-client/models/field.rb +522 -0
- data/lib/sunshine-conversations-client/models/file_message.rb +256 -0
- data/lib/sunshine-conversations-client/models/form_message.rb +236 -0
- data/lib/sunshine-conversations-client/models/form_response_message.rb +236 -0
- data/lib/sunshine-conversations-client/models/image_message.rb +245 -0
- data/lib/sunshine-conversations-client/models/inline_object.rb +254 -0
- data/lib/sunshine-conversations-client/models/integration.rb +260 -0
- data/lib/sunshine-conversations-client/models/integration_api_key.rb +209 -0
- data/lib/sunshine-conversations-client/models/integration_api_key_list_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/integration_api_key_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/integration_id.rb +204 -0
- data/lib/sunshine-conversations-client/models/integration_list_filter.rb +204 -0
- data/lib/sunshine-conversations-client/models/integration_list_response.rb +221 -0
- data/lib/sunshine-conversations-client/models/integration_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/integration_type.rb +204 -0
- data/lib/sunshine-conversations-client/models/integration_update.rb +619 -0
- data/lib/sunshine-conversations-client/models/integration_update_base.rb +229 -0
- data/lib/sunshine-conversations-client/models/ios.rb +284 -0
- data/lib/sunshine-conversations-client/models/ios_all_of.rb +272 -0
- data/lib/sunshine-conversations-client/models/ios_update.rb +303 -0
- data/lib/sunshine-conversations-client/models/ios_update_all_of.rb +260 -0
- data/lib/sunshine-conversations-client/models/item.rb +381 -0
- data/lib/sunshine-conversations-client/models/line.rb +313 -0
- data/lib/sunshine-conversations-client/models/line_all_of.rb +302 -0
- data/lib/sunshine-conversations-client/models/line_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/link.rb +272 -0
- data/lib/sunshine-conversations-client/models/links.rb +215 -0
- data/lib/sunshine-conversations-client/models/list_message.rb +235 -0
- data/lib/sunshine-conversations-client/models/location_message.rb +245 -0
- data/lib/sunshine-conversations-client/models/location_message_coordinates.rb +225 -0
- data/lib/sunshine-conversations-client/models/location_message_location.rb +215 -0
- data/lib/sunshine-conversations-client/models/location_request.rb +238 -0
- data/lib/sunshine-conversations-client/models/mailgun.rb +356 -0
- data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +345 -0
- data/lib/sunshine-conversations-client/models/mailgun_update.rb +273 -0
- data/lib/sunshine-conversations-client/models/mailgun_update_all_of.rb +230 -0
- data/lib/sunshine-conversations-client/models/match_criteria.rb +312 -0
- data/lib/sunshine-conversations-client/models/match_criteria_base.rb +237 -0
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun.rb +273 -0
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun_all_of.rb +234 -0
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird.rb +261 -0
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird_all_of.rb +222 -0
- data/lib/sunshine-conversations-client/models/match_criteria_twilio.rb +261 -0
- data/lib/sunshine-conversations-client/models/match_criteria_twilio_all_of.rb +222 -0
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp.rb +261 -0
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp_all_of.rb +222 -0
- data/lib/sunshine-conversations-client/models/message.rb +274 -0
- data/lib/sunshine-conversations-client/models/message_bird_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/message_list_response.rb +221 -0
- data/lib/sunshine-conversations-client/models/message_override.rb +253 -0
- data/lib/sunshine-conversations-client/models/message_override_apple.rb +203 -0
- data/lib/sunshine-conversations-client/models/message_override_line.rb +203 -0
- data/lib/sunshine-conversations-client/models/message_override_messenger.rb +203 -0
- data/lib/sunshine-conversations-client/models/message_override_payload.rb +204 -0
- data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +203 -0
- data/lib/sunshine-conversations-client/models/message_post.rb +263 -0
- data/lib/sunshine-conversations-client/models/message_post_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/message_webhook.rb +274 -0
- data/lib/sunshine-conversations-client/models/messagebird.rb +330 -0
- data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +319 -0
- data/lib/sunshine-conversations-client/models/messenger.rb +263 -0
- data/lib/sunshine-conversations-client/models/messenger_all_of.rb +252 -0
- data/lib/sunshine-conversations-client/models/messenger_update.rb +247 -0
- data/lib/sunshine-conversations-client/models/messenger_update_all_of.rb +204 -0
- data/lib/sunshine-conversations-client/models/meta.rb +225 -0
- data/lib/sunshine-conversations-client/models/offer_control_body.rb +219 -0
- data/lib/sunshine-conversations-client/models/page.rb +250 -0
- data/lib/sunshine-conversations-client/models/participant.rb +255 -0
- data/lib/sunshine-conversations-client/models/participant_join_body.rb +205 -0
- data/lib/sunshine-conversations-client/models/participant_leave_body.rb +249 -0
- data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +204 -0
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +204 -0
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +204 -0
- data/lib/sunshine-conversations-client/models/participant_list_response.rb +221 -0
- data/lib/sunshine-conversations-client/models/participant_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +244 -0
- data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +214 -0
- data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +214 -0
- data/lib/sunshine-conversations-client/models/pass_control_body.rb +219 -0
- data/lib/sunshine-conversations-client/models/postback.rb +252 -0
- data/lib/sunshine-conversations-client/models/postback_webhook.rb +215 -0
- data/lib/sunshine-conversations-client/models/prechat_capture.rb +239 -0
- data/lib/sunshine-conversations-client/models/profile.rb +335 -0
- data/lib/sunshine-conversations-client/models/quoted_message.rb +249 -0
- data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +216 -0
- data/lib/sunshine-conversations-client/models/quoted_message_message.rb +215 -0
- data/lib/sunshine-conversations-client/models/referral.rb +214 -0
- data/lib/sunshine-conversations-client/models/referral_details.rb +226 -0
- data/lib/sunshine-conversations-client/models/reply.rb +260 -0
- data/lib/sunshine-conversations-client/models/source.rb +265 -0
- data/lib/sunshine-conversations-client/models/source_webhook.rb +258 -0
- data/lib/sunshine-conversations-client/models/status.rb +34 -0
- data/lib/sunshine-conversations-client/models/switchboard.rb +234 -0
- data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +241 -0
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +216 -0
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +241 -0
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +226 -0
- data/lib/sunshine-conversations-client/models/switchboard_integration.rb +333 -0
- data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +302 -0
- data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +294 -0
- data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +249 -0
- data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +241 -0
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +216 -0
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +241 -0
- data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +241 -0
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +216 -0
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +241 -0
- data/lib/sunshine-conversations-client/models/switchboard_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +214 -0
- data/lib/sunshine-conversations-client/models/target.rb +210 -0
- data/lib/sunshine-conversations-client/models/telegram.rb +272 -0
- data/lib/sunshine-conversations-client/models/telegram_all_of.rb +261 -0
- data/lib/sunshine-conversations-client/models/telegram_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/text_message.rb +245 -0
- data/lib/sunshine-conversations-client/models/twilio.rb +301 -0
- data/lib/sunshine-conversations-client/models/twilio_all_of.rb +290 -0
- data/lib/sunshine-conversations-client/models/twilio_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/twitter.rb +419 -0
- data/lib/sunshine-conversations-client/models/twitter_all_of.rb +408 -0
- data/lib/sunshine-conversations-client/models/twitter_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/user.rb +250 -0
- data/lib/sunshine-conversations-client/models/user_all_of.rb +221 -0
- data/lib/sunshine-conversations-client/models/user_create_body.rb +267 -0
- data/lib/sunshine-conversations-client/models/user_merge_event.rb +241 -0
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of.rb +203 -0
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +225 -0
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_conversations.rb +215 -0
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_users.rb +215 -0
- data/lib/sunshine-conversations-client/models/user_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/user_truncated.rb +215 -0
- data/lib/sunshine-conversations-client/models/user_update_body.rb +223 -0
- data/lib/sunshine-conversations-client/models/viber.rb +272 -0
- data/lib/sunshine-conversations-client/models/viber_all_of.rb +261 -0
- data/lib/sunshine-conversations-client/models/viber_update.rb +205 -0
- data/lib/sunshine-conversations-client/models/web.rb +383 -0
- data/lib/sunshine-conversations-client/models/web_all_of.rb +372 -0
- data/lib/sunshine-conversations-client/models/web_update.rb +402 -0
- data/lib/sunshine-conversations-client/models/web_update_all_of.rb +360 -0
- data/lib/sunshine-conversations-client/models/webhook.rb +277 -0
- data/lib/sunshine-conversations-client/models/webhook_body.rb +237 -0
- data/lib/sunshine-conversations-client/models/webhook_create_body.rb +205 -0
- data/lib/sunshine-conversations-client/models/webhook_list_response.rb +203 -0
- data/lib/sunshine-conversations-client/models/webhook_response.rb +204 -0
- data/lib/sunshine-conversations-client/models/webhook_sub_schema.rb +215 -0
- data/lib/sunshine-conversations-client/models/webview.rb +339 -0
- data/lib/sunshine-conversations-client/models/whats_app_update.rb +272 -0
- data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +229 -0
- data/lib/sunshine-conversations-client/models/whatsapp.rb +268 -0
- data/lib/sunshine-conversations-client/models/whatsapp_all_of.rb +257 -0
- data/lib/sunshine-conversations-client/version.rb +12 -0
- data/spec/api_client_spec.rb +223 -0
- data/spec/configuration_spec.rb +39 -0
- data/spec/spec_helper.rb +108 -0
- data/sunshine-conversations-client.gemspec +36 -0
- metadata +641 -0
data/docs/Viber.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SunshineConversationsClient::Viber
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The type of integration. | [optional] [default to 'viber']
|
|
8
|
+
**token** | **String** | Viber Public Account token. |
|
|
9
|
+
**uri** | **String** | Unique URI of the Viber account. | [optional] [readonly]
|
|
10
|
+
**account_id** | **String** | Unique ID of the Viber account. | [optional] [readonly]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'SunshineConversationsClient'
|
|
16
|
+
|
|
17
|
+
instance = SunshineConversationsClient::Viber.new(type: null,
|
|
18
|
+
token: 445da6az1s345z78-dazcczb2542zv51a-e0vc5fva17480im9,
|
|
19
|
+
uri: null,
|
|
20
|
+
account_id: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
data/docs/ViberAllOf.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SunshineConversationsClient::ViberAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The type of integration. | [optional] [default to 'viber']
|
|
8
|
+
**token** | **String** | Viber Public Account token. |
|
|
9
|
+
**uri** | **String** | Unique URI of the Viber account. | [optional] [readonly]
|
|
10
|
+
**account_id** | **String** | Unique ID of the Viber account. | [optional] [readonly]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'SunshineConversationsClient'
|
|
16
|
+
|
|
17
|
+
instance = SunshineConversationsClient::ViberAllOf.new(type: null,
|
|
18
|
+
token: 445da6az1s345z78-dazcczb2542zv51a-e0vc5fva17480im9,
|
|
19
|
+
uri: null,
|
|
20
|
+
account_id: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
data/docs/ViberUpdate.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# SunshineConversationsClient::ViberUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
|
|
8
|
+
## Code Sample
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'SunshineConversationsClient'
|
|
12
|
+
|
|
13
|
+
instance = SunshineConversationsClient::ViberUpdate.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/Web.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# SunshineConversationsClient::Web
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The type of integration. | [optional] [default to 'web']
|
|
8
|
+
**brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
|
|
9
|
+
**fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
|
|
10
|
+
**conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
11
|
+
**action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
12
|
+
**display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
|
|
13
|
+
**button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
14
|
+
**button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
|
|
15
|
+
**button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
|
|
16
|
+
**integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
|
|
17
|
+
**business_name** | **String** | A custom business name for the Web Messenger. | [optional]
|
|
18
|
+
**business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
19
|
+
**background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
|
|
20
|
+
**origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https. | [optional]
|
|
21
|
+
**prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [optional]
|
|
22
|
+
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
|
|
23
|
+
|
|
24
|
+
## Code Sample
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'SunshineConversationsClient'
|
|
28
|
+
|
|
29
|
+
instance = SunshineConversationsClient::Web.new(type: null,
|
|
30
|
+
brand_color: null,
|
|
31
|
+
fixed_intro_pane: null,
|
|
32
|
+
conversation_color: null,
|
|
33
|
+
action_color: null,
|
|
34
|
+
display_style: null,
|
|
35
|
+
button_icon_url: https://domain.com/images/avatar.png,
|
|
36
|
+
button_width: null,
|
|
37
|
+
button_height: null,
|
|
38
|
+
integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
|
|
39
|
+
business_name: Kent Shop,
|
|
40
|
+
business_icon_url: https://www.gravatar.com/image.jpg,
|
|
41
|
+
background_image_url: https://a-beautiful-tile.png,
|
|
42
|
+
origin_whitelist: ["https://yourdomain.com"],
|
|
43
|
+
prechat_capture: null,
|
|
44
|
+
can_user_create_more_conversations: null)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
data/docs/WebAllOf.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The type of integration. | [optional] [default to 'web']
|
|
8
|
+
**brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
|
|
9
|
+
**fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
|
|
10
|
+
**conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
11
|
+
**action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
12
|
+
**display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
|
|
13
|
+
**button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
14
|
+
**button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
|
|
15
|
+
**button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
|
|
16
|
+
**integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
|
|
17
|
+
**business_name** | **String** | A custom business name for the Web Messenger. | [optional]
|
|
18
|
+
**business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
19
|
+
**background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
|
|
20
|
+
**origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https. | [optional]
|
|
21
|
+
**prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [optional]
|
|
22
|
+
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
|
|
23
|
+
|
|
24
|
+
## Code Sample
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'SunshineConversationsClient'
|
|
28
|
+
|
|
29
|
+
instance = SunshineConversationsClient::WebAllOf.new(type: null,
|
|
30
|
+
brand_color: null,
|
|
31
|
+
fixed_intro_pane: null,
|
|
32
|
+
conversation_color: null,
|
|
33
|
+
action_color: null,
|
|
34
|
+
display_style: null,
|
|
35
|
+
button_icon_url: https://domain.com/images/avatar.png,
|
|
36
|
+
button_width: null,
|
|
37
|
+
button_height: null,
|
|
38
|
+
integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
|
|
39
|
+
business_name: Kent Shop,
|
|
40
|
+
business_icon_url: https://www.gravatar.com/image.jpg,
|
|
41
|
+
background_image_url: https://a-beautiful-tile.png,
|
|
42
|
+
origin_whitelist: ["https://yourdomain.com"],
|
|
43
|
+
prechat_capture: null,
|
|
44
|
+
can_user_create_more_conversations: null)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
data/docs/WebUpdate.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional]
|
|
8
|
+
**brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
|
|
9
|
+
**fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
|
|
10
|
+
**conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
11
|
+
**action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
12
|
+
**display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
|
|
13
|
+
**button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
14
|
+
**button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
|
|
15
|
+
**button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
|
|
16
|
+
**integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
|
|
17
|
+
**business_name** | **String** | A custom business name for the Web Messenger. | [optional]
|
|
18
|
+
**business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
19
|
+
**background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
|
|
20
|
+
**origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https. | [optional]
|
|
21
|
+
**prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [optional]
|
|
22
|
+
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
|
|
23
|
+
|
|
24
|
+
## Code Sample
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'SunshineConversationsClient'
|
|
28
|
+
|
|
29
|
+
instance = SunshineConversationsClient::WebUpdate.new(display_name: My awesome integration,
|
|
30
|
+
brand_color: null,
|
|
31
|
+
fixed_intro_pane: null,
|
|
32
|
+
conversation_color: null,
|
|
33
|
+
action_color: null,
|
|
34
|
+
display_style: null,
|
|
35
|
+
button_icon_url: null,
|
|
36
|
+
button_width: null,
|
|
37
|
+
button_height: null,
|
|
38
|
+
integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
|
|
39
|
+
business_name: Kent Shop,
|
|
40
|
+
business_icon_url: https://www.gravatar.com/image.jpg,
|
|
41
|
+
background_image_url: https://a-beautiful-tile.png,
|
|
42
|
+
origin_whitelist: null,
|
|
43
|
+
prechat_capture: null,
|
|
44
|
+
can_user_create_more_conversations: null)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebUpdateAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
|
|
8
|
+
**fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
|
|
9
|
+
**conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
10
|
+
**action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
|
|
11
|
+
**display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
|
|
12
|
+
**button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
13
|
+
**button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
|
|
14
|
+
**button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
|
|
15
|
+
**integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
|
|
16
|
+
**business_name** | **String** | A custom business name for the Web Messenger. | [optional]
|
|
17
|
+
**business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
|
|
18
|
+
**background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
|
|
19
|
+
**origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https. | [optional]
|
|
20
|
+
**prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [optional]
|
|
21
|
+
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
|
|
22
|
+
|
|
23
|
+
## Code Sample
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'SunshineConversationsClient'
|
|
27
|
+
|
|
28
|
+
instance = SunshineConversationsClient::WebUpdateAllOf.new(brand_color: null,
|
|
29
|
+
fixed_intro_pane: null,
|
|
30
|
+
conversation_color: null,
|
|
31
|
+
action_color: null,
|
|
32
|
+
display_style: null,
|
|
33
|
+
button_icon_url: null,
|
|
34
|
+
button_width: null,
|
|
35
|
+
button_height: null,
|
|
36
|
+
integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
|
|
37
|
+
business_name: Kent Shop,
|
|
38
|
+
business_icon_url: https://www.gravatar.com/image.jpg,
|
|
39
|
+
background_image_url: https://a-beautiful-tile.png,
|
|
40
|
+
origin_whitelist: null,
|
|
41
|
+
prechat_capture: null,
|
|
42
|
+
can_user_create_more_conversations: null)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
|
data/docs/Webhook.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# SunshineConversationsClient::Webhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | A unique identifier for the webhook. | [optional] [readonly]
|
|
8
|
+
**version** | **String** | Schema version of the payload delivered to this webhook. Can be `v1`, `v1.1` or `v2`. | [optional] [readonly]
|
|
9
|
+
**target** | **String** | URL to be called when the webhook is triggered. |
|
|
10
|
+
**triggers** | **Array<String>** | An array of triggers the integration is subscribed to. This property is case sensitive. Current supported triggers in v2 are `conversation:create`, `conversation:message:delivery:channel`, `conversation:message:delivery:failure`, `conversation:message:delivery:user`, `conversation:message`, `conversation:read`, `conversation:typing`, `conversation:postback`, and `user:merge` |
|
|
11
|
+
**secret** | **String** | Webhook secret, used to verify the origin of incoming requests. | [optional]
|
|
12
|
+
**include_full_user** | **Boolean** | A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user. | [optional] [default to false]
|
|
13
|
+
**include_full_source** | **Boolean** | A boolean specifying whether webhook payloads should include the client and device object (when applicable). | [optional] [default to false]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'SunshineConversationsClient'
|
|
19
|
+
|
|
20
|
+
instance = SunshineConversationsClient::Webhook.new(id: 5e554d2cac66fb73a3c01871,
|
|
21
|
+
version: v2,
|
|
22
|
+
target: https://example.com/callback,
|
|
23
|
+
triggers: ["conversation:read","conversation:message"],
|
|
24
|
+
secret: 8564b3e6a8b20a4bdb68b05ce9bc5936,
|
|
25
|
+
include_full_user: null,
|
|
26
|
+
include_full_source: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
data/docs/WebhookBody.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebhookBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**target** | **String** | URL to be called when the webhook is triggered. | [optional]
|
|
8
|
+
**triggers** | **Array<String>** | An array of triggers the integration is subscribed to. This property is case sensitive. Current supported triggers in v2 are `conversation:create`, `conversation:message:delivery:channel`, `conversation:message:delivery:failure`, `conversation:message:delivery:user`, `conversation:message`, `conversation:read`, `conversation:typing`, `conversation:postback`, and `user:merge` | [optional]
|
|
9
|
+
**include_full_user** | **Boolean** | A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user. | [optional] [default to false]
|
|
10
|
+
**include_full_source** | **Boolean** | A boolean specifying whether webhook payloads should include the client and device object (when applicable). | [optional] [default to false]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'SunshineConversationsClient'
|
|
16
|
+
|
|
17
|
+
instance = SunshineConversationsClient::WebhookBody.new(target: https://example.com/callback,
|
|
18
|
+
triggers: ["conversation:read","conversation:message"],
|
|
19
|
+
include_full_user: null,
|
|
20
|
+
include_full_source: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebhookCreateBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
|
|
8
|
+
## Code Sample
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'SunshineConversationsClient'
|
|
12
|
+
|
|
13
|
+
instance = SunshineConversationsClient::WebhookCreateBody.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebhookListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**webhooks** | [**Array<Webhook>**](Webhook.md) | List of webhooks associated with the integration. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'SunshineConversationsClient'
|
|
13
|
+
|
|
14
|
+
instance = SunshineConversationsClient::WebhookListResponse.new(webhooks: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebhookResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**webhook** | [**Webhook**](Webhook.md) | The webhook. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'SunshineConversationsClient'
|
|
13
|
+
|
|
14
|
+
instance = SunshineConversationsClient::WebhookResponse.new(webhook: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebhookSubSchema
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | The unique ID of the webhook. | [optional]
|
|
8
|
+
**version** | **String** | Schema version of the payload delivered to this webhook (v2). | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'SunshineConversationsClient'
|
|
14
|
+
|
|
15
|
+
instance = SunshineConversationsClient::WebhookSubSchema.new(id: null,
|
|
16
|
+
version: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/WebhooksApi.md
ADDED
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
# SunshineConversationsClient::WebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.smooch.io*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /v2/apps/{appId}/integrations/{integrationId}/webhooks | Create Webhook
|
|
8
|
+
[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId} | Delete Webhook
|
|
9
|
+
[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId} | Get Webhook
|
|
10
|
+
[**list_webhooks**](WebhooksApi.md#list_webhooks) | **GET** /v2/apps/{appId}/integrations/{integrationId}/webhooks | List Webhooks
|
|
11
|
+
[**update_webhook**](WebhooksApi.md#update_webhook) | **PATCH** /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId} | Update Webhook
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## create_webhook
|
|
16
|
+
|
|
17
|
+
> WebhookResponse create_webhook(app_id, integration_id, webhook_create_body)
|
|
18
|
+
|
|
19
|
+
Create Webhook
|
|
20
|
+
|
|
21
|
+
Creates a new webhook associated with a Sunshine Conversations Connect integration or a custom integration.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
# load the gem
|
|
27
|
+
require 'sunshine-conversations-client'
|
|
28
|
+
# setup authorization
|
|
29
|
+
SunshineConversationsClient.configure do |config|
|
|
30
|
+
# Configure HTTP basic authorization: basicAuth
|
|
31
|
+
config.username = 'YOUR_USERNAME'
|
|
32
|
+
config.password = 'YOUR_PASSWORD'
|
|
33
|
+
|
|
34
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
35
|
+
# Uncomment this line to use JWTs
|
|
36
|
+
# config.access_token = 'YOUR_JWT'
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
api_instance = SunshineConversationsClient::WebhooksApi.new
|
|
40
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
41
|
+
integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
|
|
42
|
+
webhook_create_body = SunshineConversationsClient::WebhookCreateBody.new # WebhookCreateBody |
|
|
43
|
+
# Be sure to add the required body parameters
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
#Create Webhook
|
|
47
|
+
result = api_instance.create_webhook(app_id, integration_id, webhook_create_body)
|
|
48
|
+
p result
|
|
49
|
+
rescue SunshineConversationsClient::ApiError => e
|
|
50
|
+
puts "Exception when calling WebhooksApi->create_webhook: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**app_id** | **String**| Identifies the app. |
|
|
60
|
+
**integration_id** | **String**| The id of the integration. |
|
|
61
|
+
**webhook_create_body** | [**WebhookCreateBody**](WebhookCreateBody.md)| |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: application/json
|
|
74
|
+
- **Accept**: application/json
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## delete_webhook
|
|
78
|
+
|
|
79
|
+
> Object delete_webhook(app_id, integration_id, webhook_id)
|
|
80
|
+
|
|
81
|
+
Delete Webhook
|
|
82
|
+
|
|
83
|
+
Deletes the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
|
|
84
|
+
|
|
85
|
+
### Example
|
|
86
|
+
|
|
87
|
+
```ruby
|
|
88
|
+
# load the gem
|
|
89
|
+
require 'sunshine-conversations-client'
|
|
90
|
+
# setup authorization
|
|
91
|
+
SunshineConversationsClient.configure do |config|
|
|
92
|
+
# Configure HTTP basic authorization: basicAuth
|
|
93
|
+
config.username = 'YOUR_USERNAME'
|
|
94
|
+
config.password = 'YOUR_PASSWORD'
|
|
95
|
+
|
|
96
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
97
|
+
# Uncomment this line to use JWTs
|
|
98
|
+
# config.access_token = 'YOUR_JWT'
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = SunshineConversationsClient::WebhooksApi.new
|
|
102
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
103
|
+
integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
|
|
104
|
+
webhook_id = '029c31f25a21b47effd7be90' # String | The id of the webhook.
|
|
105
|
+
# Be sure to add the required body parameters
|
|
106
|
+
|
|
107
|
+
begin
|
|
108
|
+
#Delete Webhook
|
|
109
|
+
result = api_instance.delete_webhook(app_id, integration_id, webhook_id)
|
|
110
|
+
p result
|
|
111
|
+
rescue SunshineConversationsClient::ApiError => e
|
|
112
|
+
puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
|
|
113
|
+
end
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Parameters
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
Name | Type | Description | Notes
|
|
120
|
+
------------- | ------------- | ------------- | -------------
|
|
121
|
+
**app_id** | **String**| Identifies the app. |
|
|
122
|
+
**integration_id** | **String**| The id of the integration. |
|
|
123
|
+
**webhook_id** | **String**| The id of the webhook. |
|
|
124
|
+
|
|
125
|
+
### Return type
|
|
126
|
+
|
|
127
|
+
**Object**
|
|
128
|
+
|
|
129
|
+
### Authorization
|
|
130
|
+
|
|
131
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
|
132
|
+
|
|
133
|
+
### HTTP request headers
|
|
134
|
+
|
|
135
|
+
- **Content-Type**: Not defined
|
|
136
|
+
- **Accept**: application/json
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
## get_webhook
|
|
140
|
+
|
|
141
|
+
> WebhookResponse get_webhook(app_id, integration_id, webhook_id)
|
|
142
|
+
|
|
143
|
+
Get Webhook
|
|
144
|
+
|
|
145
|
+
Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
|
|
146
|
+
|
|
147
|
+
### Example
|
|
148
|
+
|
|
149
|
+
```ruby
|
|
150
|
+
# load the gem
|
|
151
|
+
require 'sunshine-conversations-client'
|
|
152
|
+
# setup authorization
|
|
153
|
+
SunshineConversationsClient.configure do |config|
|
|
154
|
+
# Configure HTTP basic authorization: basicAuth
|
|
155
|
+
config.username = 'YOUR_USERNAME'
|
|
156
|
+
config.password = 'YOUR_PASSWORD'
|
|
157
|
+
|
|
158
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
159
|
+
# Uncomment this line to use JWTs
|
|
160
|
+
# config.access_token = 'YOUR_JWT'
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
api_instance = SunshineConversationsClient::WebhooksApi.new
|
|
164
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
165
|
+
integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
|
|
166
|
+
webhook_id = '029c31f25a21b47effd7be90' # String | The id of the webhook.
|
|
167
|
+
# Be sure to add the required body parameters
|
|
168
|
+
|
|
169
|
+
begin
|
|
170
|
+
#Get Webhook
|
|
171
|
+
result = api_instance.get_webhook(app_id, integration_id, webhook_id)
|
|
172
|
+
p result
|
|
173
|
+
rescue SunshineConversationsClient::ApiError => e
|
|
174
|
+
puts "Exception when calling WebhooksApi->get_webhook: #{e}"
|
|
175
|
+
end
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Parameters
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
Name | Type | Description | Notes
|
|
182
|
+
------------- | ------------- | ------------- | -------------
|
|
183
|
+
**app_id** | **String**| Identifies the app. |
|
|
184
|
+
**integration_id** | **String**| The id of the integration. |
|
|
185
|
+
**webhook_id** | **String**| The id of the webhook. |
|
|
186
|
+
|
|
187
|
+
### Return type
|
|
188
|
+
|
|
189
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
190
|
+
|
|
191
|
+
### Authorization
|
|
192
|
+
|
|
193
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
|
194
|
+
|
|
195
|
+
### HTTP request headers
|
|
196
|
+
|
|
197
|
+
- **Content-Type**: Not defined
|
|
198
|
+
- **Accept**: application/json
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
## list_webhooks
|
|
202
|
+
|
|
203
|
+
> WebhookListResponse list_webhooks(app_id, integration_id)
|
|
204
|
+
|
|
205
|
+
List Webhooks
|
|
206
|
+
|
|
207
|
+
Lists all webhooks for a given Sunshine Conversations Connect integration or custom integration.
|
|
208
|
+
|
|
209
|
+
### Example
|
|
210
|
+
|
|
211
|
+
```ruby
|
|
212
|
+
# load the gem
|
|
213
|
+
require 'sunshine-conversations-client'
|
|
214
|
+
# setup authorization
|
|
215
|
+
SunshineConversationsClient.configure do |config|
|
|
216
|
+
# Configure HTTP basic authorization: basicAuth
|
|
217
|
+
config.username = 'YOUR_USERNAME'
|
|
218
|
+
config.password = 'YOUR_PASSWORD'
|
|
219
|
+
|
|
220
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
221
|
+
# Uncomment this line to use JWTs
|
|
222
|
+
# config.access_token = 'YOUR_JWT'
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
api_instance = SunshineConversationsClient::WebhooksApi.new
|
|
226
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
227
|
+
integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
|
|
228
|
+
# Be sure to add the required body parameters
|
|
229
|
+
|
|
230
|
+
begin
|
|
231
|
+
#List Webhooks
|
|
232
|
+
result = api_instance.list_webhooks(app_id, integration_id)
|
|
233
|
+
p result
|
|
234
|
+
rescue SunshineConversationsClient::ApiError => e
|
|
235
|
+
puts "Exception when calling WebhooksApi->list_webhooks: #{e}"
|
|
236
|
+
end
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
### Parameters
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
Name | Type | Description | Notes
|
|
243
|
+
------------- | ------------- | ------------- | -------------
|
|
244
|
+
**app_id** | **String**| Identifies the app. |
|
|
245
|
+
**integration_id** | **String**| The id of the integration. |
|
|
246
|
+
|
|
247
|
+
### Return type
|
|
248
|
+
|
|
249
|
+
[**WebhookListResponse**](WebhookListResponse.md)
|
|
250
|
+
|
|
251
|
+
### Authorization
|
|
252
|
+
|
|
253
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
|
254
|
+
|
|
255
|
+
### HTTP request headers
|
|
256
|
+
|
|
257
|
+
- **Content-Type**: Not defined
|
|
258
|
+
- **Accept**: application/json
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
## update_webhook
|
|
262
|
+
|
|
263
|
+
> WebhookResponse update_webhook(app_id, integration_id, webhook_id, webhook_body)
|
|
264
|
+
|
|
265
|
+
Update Webhook
|
|
266
|
+
|
|
267
|
+
Updates the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
|
|
268
|
+
|
|
269
|
+
### Example
|
|
270
|
+
|
|
271
|
+
```ruby
|
|
272
|
+
# load the gem
|
|
273
|
+
require 'sunshine-conversations-client'
|
|
274
|
+
# setup authorization
|
|
275
|
+
SunshineConversationsClient.configure do |config|
|
|
276
|
+
# Configure HTTP basic authorization: basicAuth
|
|
277
|
+
config.username = 'YOUR_USERNAME'
|
|
278
|
+
config.password = 'YOUR_PASSWORD'
|
|
279
|
+
|
|
280
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
281
|
+
# Uncomment this line to use JWTs
|
|
282
|
+
# config.access_token = 'YOUR_JWT'
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
api_instance = SunshineConversationsClient::WebhooksApi.new
|
|
286
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
287
|
+
integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
|
|
288
|
+
webhook_id = '029c31f25a21b47effd7be90' # String | The id of the webhook.
|
|
289
|
+
webhook_body = SunshineConversationsClient::WebhookBody.new # WebhookBody |
|
|
290
|
+
# Be sure to add the required body parameters
|
|
291
|
+
|
|
292
|
+
begin
|
|
293
|
+
#Update Webhook
|
|
294
|
+
result = api_instance.update_webhook(app_id, integration_id, webhook_id, webhook_body)
|
|
295
|
+
p result
|
|
296
|
+
rescue SunshineConversationsClient::ApiError => e
|
|
297
|
+
puts "Exception when calling WebhooksApi->update_webhook: #{e}"
|
|
298
|
+
end
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
Name | Type | Description | Notes
|
|
305
|
+
------------- | ------------- | ------------- | -------------
|
|
306
|
+
**app_id** | **String**| Identifies the app. |
|
|
307
|
+
**integration_id** | **String**| The id of the integration. |
|
|
308
|
+
**webhook_id** | **String**| The id of the webhook. |
|
|
309
|
+
**webhook_body** | [**WebhookBody**](WebhookBody.md)| |
|
|
310
|
+
|
|
311
|
+
### Return type
|
|
312
|
+
|
|
313
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
314
|
+
|
|
315
|
+
### Authorization
|
|
316
|
+
|
|
317
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
|
318
|
+
|
|
319
|
+
### HTTP request headers
|
|
320
|
+
|
|
321
|
+
- **Content-Type**: application/json
|
|
322
|
+
- **Accept**: application/json
|
|
323
|
+
|