sunshine-conversations-client 15.5.2 → 16.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 -1
- data/README.md +15 -8
- data/docs/AttachmentsApi.md +1 -1
- data/docs/Content.md +1 -1
- data/docs/ConversationsApi.md +63 -0
- data/docs/ConversionEventsBody.md +21 -0
- data/docs/InstagramConversionEventsBody.md +17 -0
- data/docs/MessagePost.md +1 -1
- data/docs/MessengerConversionEventsBody.md +17 -0
- data/docs/MetaConversionEvent.md +17 -0
- data/docs/MetaConversionEventPayload.md +17 -0
- data/docs/SwitchboardActionsApi.md +1 -1
- data/docs/SwitchboardPassControlAllOfPayload.md +3 -1
- data/docs/SwitchboardReleaseControlAllOfPayload.md +3 -1
- data/docs/TemplateMessage.md +1 -1
- data/docs/WhatsAppConversionEventsBody.md +17 -0
- data/lib/sunshine-conversations-client/api/activities_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/app_keys_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/apps_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/attachments_api.rb +3 -3
- data/lib/sunshine-conversations-client/api/clients_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/conversations_api.rb +77 -1
- data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/devices_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/integrations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/messages_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/participants_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +3 -3
- data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboards_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/users_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/webhooks_api.rb +1 -1
- data/lib/sunshine-conversations-client/api_client.rb +1 -1
- data/lib/sunshine-conversations-client/api_error.rb +1 -1
- data/lib/sunshine-conversations-client/configuration.rb +1 -1
- data/lib/sunshine-conversations-client/models/accept_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/action.rb +1 -1
- data/lib/sunshine-conversations-client/models/action_subset.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_post.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_post_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/activity_types.rb +1 -1
- data/lib/sunshine-conversations-client/models/android.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/android_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/api_key.rb +1 -1
- data/lib/sunshine-conversations-client/models/app.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_key_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_list_filter.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_settings.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/app_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_message_override_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/apple_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_delete_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/attachment_upload_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/author.rb +1 -1
- data/lib/sunshine-conversations-client/models/author_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/buy.rb +1 -1
- data/lib/sunshine-conversations-client/models/campaign.rb +1 -1
- data/lib/sunshine-conversations-client/models/carousel_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/carousel_message_display_settings.rb +1 -1
- data/lib/sunshine-conversations-client/models/client.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_add_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_add_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_add_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_association.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_create.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_remove_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_remove_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_remove_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_type.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_update_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_update_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/client_update_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/confirmation.rb +1 -1
- data/lib/sunshine-conversations-client/models/content.rb +2 -2
- data/lib/sunshine-conversations-client/models/conversation.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_join_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_join_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_join_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_leave_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_list_filter.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_destination.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_external_messages.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_delivery_user_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_message_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_postback_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_read_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_read_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_referral_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_remove_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_truncated.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_type.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_typing_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversation_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/conversion_events_body.rb +246 -0
- data/lib/sunshine-conversations-client/models/custom.rb +1 -1
- data/lib/sunshine-conversations-client/models/custom_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/custom_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/default_responder.rb +1 -1
- data/lib/sunshine-conversations-client/models/default_responder_default_responder.rb +1 -1
- data/lib/sunshine-conversations-client/models/default_responder_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/destination.rb +1 -1
- data/lib/sunshine-conversations-client/models/device.rb +1 -1
- data/lib/sunshine-conversations-client/models/device_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/device_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple.rb +1 -1
- data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple_interactive_data_ref.rb +1 -1
- data/lib/sunshine-conversations-client/models/error.rb +1 -1
- data/lib/sunshine-conversations-client/models/error_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/event_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/extra_channel_options.rb +1 -1
- data/lib/sunshine-conversations-client/models/extra_channel_options_messenger.rb +1 -1
- data/lib/sunshine-conversations-client/models/field.rb +1 -1
- data/lib/sunshine-conversations-client/models/file_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_message_field.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_message_field_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message_field.rb +1 -1
- data/lib/sunshine-conversations-client/models/form_response_message_field_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/identity.rb +1 -1
- data/lib/sunshine-conversations-client/models/image_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/inline_object.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram_conversion_events_body.rb +203 -0
- data/lib/sunshine-conversations-client/models/instagram_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/instagram_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_api_key.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_api_key_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_api_key_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_list_filter.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_type.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/integration_update_base.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/ios_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/item.rb +1 -1
- data/lib/sunshine-conversations-client/models/line.rb +1 -1
- data/lib/sunshine-conversations-client/models/line_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/line_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/link.rb +1 -1
- data/lib/sunshine-conversations-client/models/links.rb +1 -1
- data/lib/sunshine-conversations-client/models/list_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_message_coordinates.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_message_location.rb +1 -1
- data/lib/sunshine-conversations-client/models/location_request.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/mailgun_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_base.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_mailgun_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_messagebird_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_twilio.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_twilio_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/match_criteria_whatsapp_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/message.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_bird_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override.rb +2 -2
- data/lib/sunshine-conversations-client/models/message_override_apple.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_line.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_messenger.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_post.rb +2 -2
- data/lib/sunshine-conversations-client/models/message_post_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/messagebird.rb +1 -1
- data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/messenger.rb +1 -1
- data/lib/sunshine-conversations-client/models/messenger_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/messenger_conversion_events_body.rb +203 -0
- data/lib/sunshine-conversations-client/models/messenger_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/meta.rb +1 -1
- data/lib/sunshine-conversations-client/models/meta_conversion_event.rb +209 -0
- data/lib/sunshine-conversations-client/models/meta_conversion_event_payload.rb +209 -0
- data/lib/sunshine-conversations-client/models/offer_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/page.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_join_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/pass_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/postback.rb +1 -1
- data/lib/sunshine-conversations-client/models/postback_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/prechat_capture.rb +1 -1
- data/lib/sunshine-conversations-client/models/profile.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/referral.rb +1 -1
- data/lib/sunshine-conversations-client/models/referral_details.rb +1 -1
- data/lib/sunshine-conversations-client/models/release_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/reply.rb +1 -1
- data/lib/sunshine-conversations-client/models/source.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/status.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +50 -6
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_release_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_release_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_release_control_all_of_payload.rb +50 -6
- data/lib/sunshine-conversations-client/models/switchboard_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/sync_user_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/target.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/telegram_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/template_message.rb +2 -2
- data/lib/sunshine-conversations-client/models/text_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/ticket_closed.rb +1 -1
- data/lib/sunshine-conversations-client/models/transfer_to_email.rb +1 -1
- data/lib/sunshine-conversations-client/models/twilio.rb +1 -1
- data/lib/sunshine-conversations-client/models/twilio_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/twilio_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/twitter.rb +1 -1
- data/lib/sunshine-conversations-client/models/twitter_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/twitter_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/unity.rb +1 -1
- data/lib/sunshine-conversations-client/models/unity_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/unity_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/unity_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_clients.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_conversations.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_users.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_remove_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_remove_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_remove_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_truncated.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_event.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_event_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/user_update_event_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/viber.rb +1 -1
- data/lib/sunshine-conversations-client/models/viber_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/viber_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/web.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/web_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/webhook_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/webview.rb +1 -1
- data/lib/sunshine-conversations-client/models/whats_app_conversion_events_body.rb +203 -0
- data/lib/sunshine-conversations-client/models/whats_app_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/whatsapp_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/version.rb +2 -2
- data/lib/sunshine-conversations-client.rb +7 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/sunshine-conversations-client.gemspec +1 -1
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 927645a50a807dc8bb2597ceeaa136889fa2e3d0776d0610be3593b2c843f367
|
4
|
+
data.tar.gz: 3b66717f291b19bea8184c1de2ec19cf2450fce7f6354f4622cac4a192bb8daf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '038cf24bd64306d110005d9aa2ac63e9fabcf96417819ef2c575cf9cc219d72a32b7e84faaea93fbbcd4d946e4bd11158b912aa34ad4f3514a7cb89525fb0b5e'
|
7
|
+
data.tar.gz: 4a6a2ca5b018a50e0fd40a5f8f19d0a20582536e63be3bacceeaab7442b8764b9d6e23281a2843c0003289216fc79d8fc7273c7917c87f9818f203a980055623
|
data/CHANGELOG_RB.md
CHANGED
@@ -1,5 +1,11 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [15.6.0] - 2025-07-24
|
4
|
+
|
5
|
+
- Added [conversion events](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/conversation-referrals/#conversion-events) API.
|
6
|
+
- Added `reason` field to `switchboard:passControl` and `switchboard:releaseControl` webhook events.
|
7
|
+
- Updated various links in documentation.
|
8
|
+
|
3
9
|
## [15.5.2] - 2025-07-08
|
4
10
|
|
5
11
|
- Added release control in the webhook and webhook event documentation.
|
@@ -256,7 +262,7 @@
|
|
256
262
|
|
257
263
|
## [9.12.0] - 2022-08-30
|
258
264
|
|
259
|
-
- The Switchboard `passControl` action is now idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://
|
265
|
+
- The Switchboard `passControl` action is now idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://developer.zendesk.com/documentation/conversations/how-to-guides/building-a-marketplace-bot/) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded.
|
260
266
|
- For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
|
261
267
|
|
262
268
|
## [9.11.0] - 2022-07-28
|
data/README.md
CHANGED
@@ -4,18 +4,18 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
|
|
4
4
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
|
6
6
|
|
7
|
-
- API version: 15.
|
8
|
-
- Package version:
|
7
|
+
- API version: 15.6.0
|
8
|
+
- Package version: 16.0.0
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
10
10
|
|
11
11
|
## Sunshine Conversations API Version
|
12
12
|
|
13
|
-
The Sunshine Conversations API offers multiple [versions](https://
|
13
|
+
The Sunshine Conversations API offers multiple [versions](https://developer.zendesk.com/documentation/conversations/references/api-versioning/). Each release of this project targets one and only one Sunshine Conversations API version. If you depend on an older version of the Sunshine Conversations API, you may need to use an older release of this library. Use the table below as your guide:
|
14
14
|
|
15
15
|
| Sunshine Conversations API version | `zendesk/sunshine-conversations-ruby` version to use |
|
16
16
|
|--------------------|--------------------------------|
|
17
|
-
| `v2` [
|
18
|
-
| `v1.1` [Upgrade guide](https://
|
17
|
+
| `v2` [Upgrade guide](https://developer.zendesk.com/documentation/conversations/references/api-versioning/#upgrading-from-v11-to-v2) | `9.*` or newer |
|
18
|
+
| `v1.1` [Upgrade guide](https://developer.zendesk.com/documentation/conversations/references/api-versioning/#upgrading-from-v1-to-v11) | `4.0.0` or newer |
|
19
19
|
| `v1` | `3.*` or older |
|
20
20
|
|
21
21
|
|
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
|
|
32
32
|
Then either install the gem locally:
|
33
33
|
|
34
34
|
```shell
|
35
|
-
gem install ./sunshine-conversations-client-
|
35
|
+
gem install ./sunshine-conversations-client-16.0.0.gem
|
36
36
|
```
|
37
37
|
|
38
|
-
(for development, run `gem install --dev ./sunshine-conversations-client-
|
38
|
+
(for development, run `gem install --dev ./sunshine-conversations-client-16.0.0.gem` to install the development dependencies)
|
39
39
|
|
40
40
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
41
41
|
|
42
42
|
Finally add this to the Gemfile:
|
43
43
|
|
44
|
-
gem 'sunshine-conversations-client', '~>
|
44
|
+
gem 'sunshine-conversations-client', '~> 16.0.0'
|
45
45
|
|
46
46
|
### Install from Git
|
47
47
|
|
@@ -151,6 +151,7 @@ Class | Method | HTTP request | Description
|
|
151
151
|
*SunshineConversationsClient::ConversationsApi* | [**download_message_ref**](docs/ConversationsApi.md#download_message_ref) | **POST** /v2/apps/{appId}/conversations/{conversationId}/download | Download Message Ref
|
152
152
|
*SunshineConversationsClient::ConversationsApi* | [**get_conversation**](docs/ConversationsApi.md#get_conversation) | **GET** /v2/apps/{appId}/conversations/{conversationId} | Get Conversation
|
153
153
|
*SunshineConversationsClient::ConversationsApi* | [**list_conversations**](docs/ConversationsApi.md#list_conversations) | **GET** /v2/apps/{appId}/conversations | List Conversations
|
154
|
+
*SunshineConversationsClient::ConversationsApi* | [**post_conversion_events**](docs/ConversationsApi.md#post_conversion_events) | **POST** /v2/apps/{appId}/conversations/{conversationId}/conversionEvents | Post Conversion Events
|
154
155
|
*SunshineConversationsClient::ConversationsApi* | [**update_conversation**](docs/ConversationsApi.md#update_conversation) | **PATCH** /v2/apps/{appId}/conversations/{conversationId} | Update Conversation
|
155
156
|
*SunshineConversationsClient::CustomIntegrationApiKeysApi* | [**create_custom_integration_key**](docs/CustomIntegrationApiKeysApi.md#create_custom_integration_key) | **POST** /v2/apps/{appId}/integrations/{integrationId}/keys | Create Integration Key
|
156
157
|
*SunshineConversationsClient::CustomIntegrationApiKeysApi* | [**delete_custom_integration_key**](docs/CustomIntegrationApiKeysApi.md#delete_custom_integration_key) | **DELETE** /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId} | Delete Integration Key
|
@@ -304,6 +305,7 @@ Class | Method | HTTP request | Description
|
|
304
305
|
- [SunshineConversationsClient::ConversationTypingEventAllOf](docs/ConversationTypingEventAllOf.md)
|
305
306
|
- [SunshineConversationsClient::ConversationTypingEventAllOfPayload](docs/ConversationTypingEventAllOfPayload.md)
|
306
307
|
- [SunshineConversationsClient::ConversationUpdateBody](docs/ConversationUpdateBody.md)
|
308
|
+
- [SunshineConversationsClient::ConversionEventsBody](docs/ConversionEventsBody.md)
|
307
309
|
- [SunshineConversationsClient::Custom](docs/Custom.md)
|
308
310
|
- [SunshineConversationsClient::CustomAllOf](docs/CustomAllOf.md)
|
309
311
|
- [SunshineConversationsClient::CustomUpdate](docs/CustomUpdate.md)
|
@@ -336,6 +338,7 @@ Class | Method | HTTP request | Description
|
|
336
338
|
- [SunshineConversationsClient::InlineObject](docs/InlineObject.md)
|
337
339
|
- [SunshineConversationsClient::Instagram](docs/Instagram.md)
|
338
340
|
- [SunshineConversationsClient::InstagramAllOf](docs/InstagramAllOf.md)
|
341
|
+
- [SunshineConversationsClient::InstagramConversionEventsBody](docs/InstagramConversionEventsBody.md)
|
339
342
|
- [SunshineConversationsClient::InstagramUpdate](docs/InstagramUpdate.md)
|
340
343
|
- [SunshineConversationsClient::InstagramUpdateAllOf](docs/InstagramUpdateAllOf.md)
|
341
344
|
- [SunshineConversationsClient::Integration](docs/Integration.md)
|
@@ -394,8 +397,11 @@ Class | Method | HTTP request | Description
|
|
394
397
|
- [SunshineConversationsClient::MessagebirdAllOf](docs/MessagebirdAllOf.md)
|
395
398
|
- [SunshineConversationsClient::Messenger](docs/Messenger.md)
|
396
399
|
- [SunshineConversationsClient::MessengerAllOf](docs/MessengerAllOf.md)
|
400
|
+
- [SunshineConversationsClient::MessengerConversionEventsBody](docs/MessengerConversionEventsBody.md)
|
397
401
|
- [SunshineConversationsClient::MessengerUpdate](docs/MessengerUpdate.md)
|
398
402
|
- [SunshineConversationsClient::Meta](docs/Meta.md)
|
403
|
+
- [SunshineConversationsClient::MetaConversionEvent](docs/MetaConversionEvent.md)
|
404
|
+
- [SunshineConversationsClient::MetaConversionEventPayload](docs/MetaConversionEventPayload.md)
|
399
405
|
- [SunshineConversationsClient::OfferControlBody](docs/OfferControlBody.md)
|
400
406
|
- [SunshineConversationsClient::Page](docs/Page.md)
|
401
407
|
- [SunshineConversationsClient::Participant](docs/Participant.md)
|
@@ -504,6 +510,7 @@ Class | Method | HTTP request | Description
|
|
504
510
|
- [SunshineConversationsClient::WebhookResponse](docs/WebhookResponse.md)
|
505
511
|
- [SunshineConversationsClient::WebhookSubSchema](docs/WebhookSubSchema.md)
|
506
512
|
- [SunshineConversationsClient::Webview](docs/Webview.md)
|
513
|
+
- [SunshineConversationsClient::WhatsAppConversionEventsBody](docs/WhatsAppConversionEventsBody.md)
|
507
514
|
- [SunshineConversationsClient::WhatsAppUpdate](docs/WhatsAppUpdate.md)
|
508
515
|
- [SunshineConversationsClient::WhatsAppUpdateAllOf](docs/WhatsAppUpdateAllOf.md)
|
509
516
|
- [SunshineConversationsClient::Whatsapp](docs/Whatsapp.md)
|
data/docs/AttachmentsApi.md
CHANGED
@@ -75,7 +75,7 @@ Name | Type | Description | Notes
|
|
75
75
|
|
76
76
|
Upload Attachment
|
77
77
|
|
78
|
-
Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://
|
78
|
+
Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc\">file validation</a> guide for more details.</aside>
|
79
79
|
|
80
80
|
### Example
|
81
81
|
|
data/docs/Content.md
CHANGED
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
|
23
23
|
**text_fallback** | **String** | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly]
|
24
24
|
**coordinates** | [**LocationMessageCoordinates**](LocationMessageCoordinates.md) | |
|
25
25
|
**location** | [**LocationMessageLocation**](LocationMessageLocation.md) | | [optional]
|
26
|
-
**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://
|
26
|
+
**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages). `schema` must be set to `whatsapp`. |
|
27
27
|
|
28
28
|
## Code Sample
|
29
29
|
|
data/docs/ConversationsApi.md
CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
[**download_message_ref**](ConversationsApi.md#download_message_ref) | **POST** /v2/apps/{appId}/conversations/{conversationId}/download | Download Message Ref
|
10
10
|
[**get_conversation**](ConversationsApi.md#get_conversation) | **GET** /v2/apps/{appId}/conversations/{conversationId} | Get Conversation
|
11
11
|
[**list_conversations**](ConversationsApi.md#list_conversations) | **GET** /v2/apps/{appId}/conversations | List Conversations
|
12
|
+
[**post_conversion_events**](ConversationsApi.md#post_conversion_events) | **POST** /v2/apps/{appId}/conversations/{conversationId}/conversionEvents | Post Conversion Events
|
12
13
|
[**update_conversation**](ConversationsApi.md#update_conversation) | **PATCH** /v2/apps/{appId}/conversations/{conversationId} | Update Conversation
|
13
14
|
|
14
15
|
|
@@ -319,6 +320,68 @@ Name | Type | Description | Notes
|
|
319
320
|
- **Accept**: application/json
|
320
321
|
|
321
322
|
|
323
|
+
## post_conversion_events
|
324
|
+
|
325
|
+
> Hash<String, Object> post_conversion_events(app_id, conversation_id, conversion_events_body)
|
326
|
+
|
327
|
+
Post Conversion Events
|
328
|
+
|
329
|
+
This API can be used to track your end user's interactions with third party channels.
|
330
|
+
|
331
|
+
### Example
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
# load the gem
|
335
|
+
require 'sunshine-conversations-client'
|
336
|
+
# setup authorization
|
337
|
+
SunshineConversationsClient.configure do |config|
|
338
|
+
# Configure HTTP basic authorization: basicAuth
|
339
|
+
config.username = 'YOUR_USERNAME'
|
340
|
+
config.password = 'YOUR_PASSWORD'
|
341
|
+
|
342
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
343
|
+
# Uncomment this line to use JWTs
|
344
|
+
# config.access_token = 'YOUR_JWT'
|
345
|
+
end
|
346
|
+
|
347
|
+
api_instance = SunshineConversationsClient::ConversationsApi.new
|
348
|
+
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
349
|
+
conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
|
350
|
+
conversion_events_body = {"instagram":{"payload":{"data":[{"action_source":"business_messaging","event_name":"TestEvent","event_time":1752161233,"messaging_channel":"instagram"}]}}} # ConversionEventsBody |
|
351
|
+
# Be sure to add the required body parameters
|
352
|
+
|
353
|
+
begin
|
354
|
+
#Post Conversion Events
|
355
|
+
result = api_instance.post_conversion_events(app_id, conversation_id, conversion_events_body)
|
356
|
+
p result
|
357
|
+
rescue SunshineConversationsClient::ApiError => e
|
358
|
+
puts "Exception when calling ConversationsApi->post_conversion_events: #{e}"
|
359
|
+
end
|
360
|
+
```
|
361
|
+
|
362
|
+
### Parameters
|
363
|
+
|
364
|
+
|
365
|
+
Name | Type | Description | Notes
|
366
|
+
------------- | ------------- | ------------- | -------------
|
367
|
+
**app_id** | **String**| Identifies the app. |
|
368
|
+
**conversation_id** | **String**| Identifies the conversation. |
|
369
|
+
**conversion_events_body** | [**ConversionEventsBody**](ConversionEventsBody.md)| |
|
370
|
+
|
371
|
+
### Return type
|
372
|
+
|
373
|
+
**Hash<String, Object>**
|
374
|
+
|
375
|
+
### Authorization
|
376
|
+
|
377
|
+
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
378
|
+
|
379
|
+
### HTTP request headers
|
380
|
+
|
381
|
+
- **Content-Type**: application/json
|
382
|
+
- **Accept**: application/json
|
383
|
+
|
384
|
+
|
322
385
|
## update_conversation
|
323
386
|
|
324
387
|
> ConversationResponse update_conversation(app_id, conversation_id, conversation_update_body)
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# SunshineConversationsClient::ConversionEventsBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**messenger** | [**MetaConversionEvent**](MetaConversionEvent.md) | | [optional]
|
8
|
+
**instagram** | [**MetaConversionEvent**](MetaConversionEvent.md) | | [optional]
|
9
|
+
**whatsapp** | [**MetaConversionEvent**](MetaConversionEvent.md) | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'SunshineConversationsClient'
|
15
|
+
|
16
|
+
instance = SunshineConversationsClient::ConversionEventsBody.new(messenger: null,
|
17
|
+
instagram: null,
|
18
|
+
whatsapp: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SunshineConversationsClient::InstagramConversionEventsBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**instagram** | [**MetaConversionEvent**](MetaConversionEvent.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SunshineConversationsClient'
|
13
|
+
|
14
|
+
instance = SunshineConversationsClient::InstagramConversionEventsBody.new(instagram: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/MessagePost.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**destination** | [**Destination**](Destination.md) | | [optional]
|
10
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
|
**override** | [**MessageOverride**](MessageOverride.md) | | [optional]
|
12
|
-
**schema** | **String** | When `schema` is set to `\"whatsapp\"`, the `content` key is expected to conform to the [native WhatsApp schema](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates) for sending message templates. For more details, consult the documentation for [sending message templates on WhatsApp](https://
|
12
|
+
**schema** | **String** | When `schema` is set to `\"whatsapp\"`, the `content` key is expected to conform to the [native WhatsApp schema](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates) for sending message templates. For more details, consult the documentation for [sending message templates on WhatsApp](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages). | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
15
15
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SunshineConversationsClient::MessengerConversionEventsBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**messenger** | [**MetaConversionEvent**](MetaConversionEvent.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SunshineConversationsClient'
|
13
|
+
|
14
|
+
instance = SunshineConversationsClient::MessengerConversionEventsBody.new(messenger: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SunshineConversationsClient::MetaConversionEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**payload** | [**MetaConversionEventPayload**](MetaConversionEventPayload.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SunshineConversationsClient'
|
13
|
+
|
14
|
+
instance = SunshineConversationsClient::MetaConversionEvent.new(payload: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SunshineConversationsClient::MetaConversionEventPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**data** | **Array<Object>** | The array of conversion events to be sent to Meta's conversion events API. |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SunshineConversationsClient'
|
13
|
+
|
14
|
+
instance = SunshineConversationsClient::MetaConversionEventPayload.new(data: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -141,7 +141,7 @@ Name | Type | Description | Notes
|
|
141
141
|
|
142
142
|
Pass Control
|
143
143
|
|
144
|
-
The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://
|
144
|
+
The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://developer.zendesk.com/documentation/conversations/how-to-guides/building-a-marketplace-bot/) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
|
145
145
|
|
146
146
|
### Example
|
147
147
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the switchboard integration that is now in control of the conversation. | [optional]
|
8
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
|
+
**reason** | **String** | Reason for the pass control action, if applicable. | [optional]
|
9
10
|
|
10
11
|
## Code Sample
|
11
12
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'SunshineConversationsClient'
|
14
15
|
|
15
16
|
instance = SunshineConversationsClient::SwitchboardPassControlAllOfPayload.new(conversation: null,
|
16
|
-
metadata: {"lang":"en-ca"}
|
17
|
+
metadata: {"lang":"en-ca"},
|
18
|
+
reason: null)
|
17
19
|
```
|
18
20
|
|
19
21
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. The payload will omit `activeSwitchboardIntegration`, representing that no switchboard integration is in control of the conversation. | [optional]
|
8
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
|
+
**reason** | **String** | Reason for the release control action, if applicable. | [optional]
|
9
10
|
|
10
11
|
## Code Sample
|
11
12
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'SunshineConversationsClient'
|
14
15
|
|
15
16
|
instance = SunshineConversationsClient::SwitchboardReleaseControlAllOfPayload.new(conversation: null,
|
16
|
-
metadata: {"lang":"en-ca"}
|
17
|
+
metadata: {"lang":"en-ca"},
|
18
|
+
reason: null)
|
17
19
|
```
|
18
20
|
|
19
21
|
|
data/docs/TemplateMessage.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**type** | **String** | The type of message. | [default to 'template']
|
8
8
|
**block_chat_input** | **Boolean** | When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation. | [optional]
|
9
|
-
**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://
|
9
|
+
**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages). `schema` must be set to `whatsapp`. |
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SunshineConversationsClient::WhatsAppConversionEventsBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**whatsapp** | [**MetaConversionEvent**](MetaConversionEvent.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SunshineConversationsClient'
|
13
|
+
|
14
|
+
instance = SunshineConversationsClient::WhatsAppConversionEventsBody.new(whatsapp: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Sunshine Conversations API
|
3
3
|
|
4
|
-
The version of the OpenAPI document: 15.
|
4
|
+
The version of the OpenAPI document: 15.6.0
|
5
5
|
|
6
6
|
Generated by: https://openapi-generator.tech
|
7
7
|
OpenAPI Generator version: 4.3.1
|
@@ -87,7 +87,7 @@ module SunshineConversationsClient
|
|
87
87
|
end
|
88
88
|
|
89
89
|
# Upload Attachment
|
90
|
-
# Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://
|
90
|
+
# Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc\">file validation</a> guide for more details.</aside>
|
91
91
|
# @param app_id [String] Identifies the app.
|
92
92
|
# @param access [String] The access level for the attachment. Currently the only available access level is public. Private is not supported.
|
93
93
|
# @param source [File]
|
@@ -101,7 +101,7 @@ module SunshineConversationsClient
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Upload Attachment
|
104
|
-
# Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://
|
104
|
+
# Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc\">file validation</a> guide for more details.</aside>
|
105
105
|
# @param app_id [String] Identifies the app.
|
106
106
|
# @param access [String] The access level for the attachment. Currently the only available access level is public. Private is not supported.
|
107
107
|
# @param source [File]
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Sunshine Conversations API
|
3
3
|
|
4
|
-
The version of the OpenAPI document: 15.
|
4
|
+
The version of the OpenAPI document: 15.6.0
|
5
5
|
|
6
6
|
Generated by: https://openapi-generator.tech
|
7
7
|
OpenAPI Generator version: 4.3.1
|
@@ -370,6 +370,82 @@ module SunshineConversationsClient
|
|
370
370
|
return data, status_code, headers
|
371
371
|
end
|
372
372
|
|
373
|
+
# Post Conversion Events
|
374
|
+
# This API can be used to track your end user's interactions with third party channels.
|
375
|
+
# @param app_id [String] Identifies the app.
|
376
|
+
# @param conversation_id [String] Identifies the conversation.
|
377
|
+
# @param conversion_events_body [ConversionEventsBody]
|
378
|
+
# @param [Hash] opts the optional parameters
|
379
|
+
# @return [Hash<String, Object>]
|
380
|
+
def post_conversion_events(app_id, conversation_id, conversion_events_body, opts = {})
|
381
|
+
data, _status_code, _headers = post_conversion_events_with_http_info(app_id, conversation_id, conversion_events_body, opts)
|
382
|
+
data
|
383
|
+
end
|
384
|
+
|
385
|
+
# Post Conversion Events
|
386
|
+
# This API can be used to track your end user's interactions with third party channels.
|
387
|
+
# @param app_id [String] Identifies the app.
|
388
|
+
# @param conversation_id [String] Identifies the conversation.
|
389
|
+
# @param conversion_events_body [ConversionEventsBody]
|
390
|
+
# @param [Hash] opts the optional parameters
|
391
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
392
|
+
def post_conversion_events_with_http_info(app_id, conversation_id, conversion_events_body, opts = {})
|
393
|
+
if @api_client.config.debugging
|
394
|
+
@api_client.config.logger.debug 'Calling API: ConversationsApi.post_conversion_events ...'
|
395
|
+
end
|
396
|
+
# verify the required parameter 'app_id' is set
|
397
|
+
if @api_client.config.client_side_validation && app_id.nil?
|
398
|
+
fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.post_conversion_events"
|
399
|
+
end
|
400
|
+
# verify the required parameter 'conversation_id' is set
|
401
|
+
if @api_client.config.client_side_validation && conversation_id.nil?
|
402
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversion_events"
|
403
|
+
end
|
404
|
+
# verify the required parameter 'conversion_events_body' is set
|
405
|
+
if @api_client.config.client_side_validation && conversion_events_body.nil?
|
406
|
+
fail ArgumentError, "Missing the required parameter 'conversion_events_body' when calling ConversationsApi.post_conversion_events"
|
407
|
+
end
|
408
|
+
# resource path
|
409
|
+
local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/conversionEvents'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))
|
410
|
+
|
411
|
+
# query parameters
|
412
|
+
query_params = opts[:query_params] || {}
|
413
|
+
|
414
|
+
# header parameters
|
415
|
+
header_params = opts[:header_params] || {}
|
416
|
+
# HTTP header 'Accept' (if needed)
|
417
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
418
|
+
# HTTP header 'Content-Type'
|
419
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
420
|
+
|
421
|
+
# form parameters
|
422
|
+
form_params = opts[:form_params] || {}
|
423
|
+
|
424
|
+
# http body (model)
|
425
|
+
post_body = opts[:body] || @api_client.object_to_http_body(conversion_events_body)
|
426
|
+
|
427
|
+
# return_type
|
428
|
+
return_type = opts[:return_type] || 'Hash<String, Object>'
|
429
|
+
|
430
|
+
# auth_names
|
431
|
+
auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
|
432
|
+
|
433
|
+
new_options = opts.merge(
|
434
|
+
:header_params => header_params,
|
435
|
+
:query_params => query_params,
|
436
|
+
:form_params => form_params,
|
437
|
+
:body => post_body,
|
438
|
+
:auth_names => auth_names,
|
439
|
+
:return_type => return_type
|
440
|
+
)
|
441
|
+
|
442
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
443
|
+
if @api_client.config.debugging
|
444
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_conversion_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
445
|
+
end
|
446
|
+
return data, status_code, headers
|
447
|
+
end
|
448
|
+
|
373
449
|
# Update Conversation
|
374
450
|
# Updates a conversation record.
|
375
451
|
# @param app_id [String] Identifies the app.
|