sunshine-conversations-client 13.0.0 → 13.2.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 +13 -0
- data/README.md +7 -9
- data/docs/AppSettings.md +1 -5
- data/docs/Apple.md +2 -0
- data/docs/AppleAllOf.md +3 -1
- data/docs/AppleMessageOverridePayload.md +19 -0
- data/docs/AppleUpdate.md +6 -1
- data/docs/AppleUpdateAllOf.md +17 -0
- data/docs/AttachmentsApi.md +2 -118
- data/docs/IntegrationUpdate.md +2 -0
- data/docs/MessageOverride.md +1 -1
- data/docs/MessageOverrideApple.md +1 -1
- data/lib/sunshine-conversations-client/api/activities_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/app_keys_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/apps_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/attachments_api.rb +3 -135
- data/lib/sunshine-conversations-client/api/clients_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/conversations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/devices_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/integrations_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/messages_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/participants_api.rb +1 -1
- data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +1 -1
- 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_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 +2 -22
- 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 +27 -2
- data/lib/sunshine-conversations-client/models/apple_all_of.rb +30 -5
- data/lib/sunshine-conversations-client/models/{attachment_media_token_body.rb → apple_message_override_payload.rb} +43 -16
- data/lib/sunshine-conversations-client/models/apple_update.rb +78 -10
- data/lib/sunshine-conversations-client/models/{attachment_media_token_response.rb → apple_update_all_of.rb} +27 -11
- 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 +1 -1
- 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/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/custom_update_all_of.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/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_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 +27 -2
- 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 +3 -3
- data/lib/sunshine-conversations-client/models/message_override_apple.rb +2 -2
- data/lib/sunshine-conversations-client/models/message_override_line.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_messenger.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_post.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_post_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/message_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/messagebird.rb +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_update.rb +1 -1
- data/lib/sunshine-conversations-client/models/meta.rb +1 -1
- data/lib/sunshine-conversations-client/models/offer_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/page.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_join_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/pass_control_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/postback.rb +1 -1
- data/lib/sunshine-conversations-client/models/postback_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/prechat_capture.rb +1 -1
- data/lib/sunshine-conversations-client/models/profile.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +1 -1
- data/lib/sunshine-conversations-client/models/quoted_message_message.rb +1 -1
- data/lib/sunshine-conversations-client/models/referral.rb +1 -1
- data/lib/sunshine-conversations-client/models/referral_details.rb +1 -1
- data/lib/sunshine-conversations-client/models/reply.rb +1 -1
- data/lib/sunshine-conversations-client/models/source.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/source_with_campaign_webhook_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/status.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_response.rb +1 -1
- data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +1 -1
- data/lib/sunshine-conversations-client/models/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 +1 -1
- data/lib/sunshine-conversations-client/models/text_message.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_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_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 +3 -3
- 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 +6 -6
- data/docs/AttachmentMediaTokenBody.md +0 -17
- data/docs/AttachmentMediaTokenResponse.md +0 -17
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 244a2c97e0ad1f82644b8ad72dfc0da11e9278a4e8fc3409906abcf958ae9500
|
|
4
|
+
data.tar.gz: f04baa883c3bda9e5e9b064af3bec9458e9efd58055a7bb03b60212dc5eb7582
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: df3c099de5be1d5b8b912acd49339d7f1e869ca153f90153705e0a19ace0fa9eb897ccdc22bb8e7c2d713be2031888d3d8222495853a923b482e4aeb98101cca
|
|
7
|
+
data.tar.gz: 2f0ae26ea3a2fc67b5854fc25bfe37f51af0c2753f755e9100c0fde3657cbdcb21feb9b7f4fd57351b684f841e6309d825c996c0e972ae8f986df7c055adc9c3
|
data/CHANGELOG_RB.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [13.2.0] - 2024-11-13
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
|
|
7
|
+
- Added new `withCapabilities` property to the Passthrought API endpoints, to Apple override MessagesPayload.
|
|
8
|
+
- Added authenticationMessageSecret to the Integrations create and update endpoints
|
|
9
|
+
|
|
10
|
+
## [13.1.0] - 2024-09-18
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- Removed private attachments support.
|
|
15
|
+
|
|
3
16
|
## [13.0.0] - 2024-09-17
|
|
4
17
|
|
|
5
18
|
### Added
|
data/README.md
CHANGED
|
@@ -4,8 +4,8 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
|
|
|
4
4
|
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
|
|
6
6
|
|
|
7
|
-
- API version:
|
|
8
|
-
- Package version: 13.
|
|
7
|
+
- API version: 13.2.0
|
|
8
|
+
- Package version: 13.2.0
|
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
10
10
|
|
|
11
11
|
## Sunshine Conversations API Version
|
|
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
|
|
|
32
32
|
Then either install the gem locally:
|
|
33
33
|
|
|
34
34
|
```shell
|
|
35
|
-
gem install ./sunshine-conversations-client-13.
|
|
35
|
+
gem install ./sunshine-conversations-client-13.2.0.gem
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
(for development, run `gem install --dev ./sunshine-conversations-client-13.
|
|
38
|
+
(for development, run `gem install --dev ./sunshine-conversations-client-13.2.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', '~> 13.
|
|
44
|
+
gem 'sunshine-conversations-client', '~> 13.2.0'
|
|
45
45
|
|
|
46
46
|
### Install from Git
|
|
47
47
|
|
|
@@ -142,8 +142,6 @@ Class | Method | HTTP request | Description
|
|
|
142
142
|
*SunshineConversationsClient::AppsApi* | [**list_apps**](docs/AppsApi.md#list_apps) | **GET** /v2/apps | List Apps
|
|
143
143
|
*SunshineConversationsClient::AppsApi* | [**update_app**](docs/AppsApi.md#update_app) | **PATCH** /v2/apps/{appId} | Update App
|
|
144
144
|
*SunshineConversationsClient::AttachmentsApi* | [**delete_attachment**](docs/AttachmentsApi.md#delete_attachment) | **POST** /v2/apps/{appId}/attachments/remove | Delete Attachment
|
|
145
|
-
*SunshineConversationsClient::AttachmentsApi* | [**generate_media_json_web_token**](docs/AttachmentsApi.md#generate_media_json_web_token) | **POST** /v2/apps/{appId}/attachments/token | Generate Media Token
|
|
146
|
-
*SunshineConversationsClient::AttachmentsApi* | [**set_cookie**](docs/AttachmentsApi.md#set_cookie) | **GET** /v2/apps/{appId}/attachments/cookie | Set Cookie
|
|
147
145
|
*SunshineConversationsClient::AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /v2/apps/{appId}/attachments | Upload Attachment
|
|
148
146
|
*SunshineConversationsClient::ClientsApi* | [**create_client**](docs/ClientsApi.md#create_client) | **POST** /v2/apps/{appId}/users/{userIdOrExternalId}/clients | Create Client
|
|
149
147
|
*SunshineConversationsClient::ClientsApi* | [**list_clients**](docs/ClientsApi.md#list_clients) | **GET** /v2/apps/{appId}/users/{userIdOrExternalId}/clients | List Clients
|
|
@@ -227,10 +225,10 @@ Class | Method | HTTP request | Description
|
|
|
227
225
|
- [SunshineConversationsClient::AppUpdateBody](docs/AppUpdateBody.md)
|
|
228
226
|
- [SunshineConversationsClient::Apple](docs/Apple.md)
|
|
229
227
|
- [SunshineConversationsClient::AppleAllOf](docs/AppleAllOf.md)
|
|
228
|
+
- [SunshineConversationsClient::AppleMessageOverridePayload](docs/AppleMessageOverridePayload.md)
|
|
230
229
|
- [SunshineConversationsClient::AppleUpdate](docs/AppleUpdate.md)
|
|
230
|
+
- [SunshineConversationsClient::AppleUpdateAllOf](docs/AppleUpdateAllOf.md)
|
|
231
231
|
- [SunshineConversationsClient::AttachmentDeleteBody](docs/AttachmentDeleteBody.md)
|
|
232
|
-
- [SunshineConversationsClient::AttachmentMediaTokenBody](docs/AttachmentMediaTokenBody.md)
|
|
233
|
-
- [SunshineConversationsClient::AttachmentMediaTokenResponse](docs/AttachmentMediaTokenResponse.md)
|
|
234
232
|
- [SunshineConversationsClient::AttachmentResponse](docs/AttachmentResponse.md)
|
|
235
233
|
- [SunshineConversationsClient::AttachmentSchema](docs/AttachmentSchema.md)
|
|
236
234
|
- [SunshineConversationsClient::AttachmentUploadBody](docs/AttachmentUploadBody.md)
|
data/docs/AppSettings.md
CHANGED
|
@@ -10,8 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**echo_postback** | **Boolean** | A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/guide/creating-and-managing-apps/#echo-postbacks) for more information. | [optional]
|
|
11
11
|
**ignore_auto_conversation_start** | **Boolean** | A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](https://docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class=\"notice\">Calling <code>startConversation()</code> (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside> | [optional]
|
|
12
12
|
**multi_convo_enabled** | **Boolean** | A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is **irreversible**. | [optional]
|
|
13
|
-
**attachments_access** | **String** | A string specifying whether attachments should be stored in a publicly or privately accessible cloud storage. attachmentsAccess is set to public by default but can be modified to private. | [optional]
|
|
14
|
-
**attachments_token_expiration_seconds** | **Integer** | Number of seconds representing the expiration time of the generated media tokens for private attachments. The JWT will be valid for 2 hours by default. | [optional]
|
|
15
13
|
**app_localization_enabled** | **Boolean** | A boolean specifying whether the messages authored by the Sunshine Conversations platform should be localized. | [optional]
|
|
16
14
|
|
|
17
15
|
## Code Sample
|
|
@@ -24,9 +22,7 @@ instance = SunshineConversationsClient::AppSettings.new(conversation_retention_s
|
|
|
24
22
|
use_animal_names: null,
|
|
25
23
|
echo_postback: null,
|
|
26
24
|
ignore_auto_conversation_start: null,
|
|
27
|
-
multi_convo_enabled:
|
|
28
|
-
attachments_access: public,
|
|
29
|
-
attachments_token_expiration_seconds: 64028,
|
|
25
|
+
multi_convo_enabled: false,
|
|
30
26
|
app_localization_enabled: null)
|
|
31
27
|
```
|
|
32
28
|
|
data/docs/Apple.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**business_id** | **String** | Apple Messages for Business ID. |
|
|
9
9
|
**api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. |
|
|
10
10
|
**msp_id** | **String** | Your Messaging Service Provider ID. |
|
|
11
|
+
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional]
|
|
11
12
|
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide. | [optional]
|
|
12
13
|
**default_responder** | [**DefaultResponderDefaultResponder**](DefaultResponderDefaultResponder.md) | | [optional]
|
|
13
14
|
|
|
@@ -20,6 +21,7 @@ instance = SunshineConversationsClient::Apple.new(type: null,
|
|
|
20
21
|
business_id: 2740f141-89c1-515f-07eb-1128dd73491,
|
|
21
22
|
api_secret: QLA//Z13paUYo/2tLReQa-43c5JEAASujGamiY/QTvs=,
|
|
22
23
|
msp_id: e7e495d5-bf78-531d-baf6-7f419f7fb592,
|
|
24
|
+
authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ==,
|
|
23
25
|
default_responder_id: null,
|
|
24
26
|
default_responder: null)
|
|
25
27
|
```
|
data/docs/AppleAllOf.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**business_id** | **String** | Apple Messages for Business ID. |
|
|
9
9
|
**api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. |
|
|
10
10
|
**msp_id** | **String** | Your Messaging Service Provider ID. |
|
|
11
|
+
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional]
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
13
14
|
|
|
@@ -17,7 +18,8 @@ require 'SunshineConversationsClient'
|
|
|
17
18
|
instance = SunshineConversationsClient::AppleAllOf.new(type: null,
|
|
18
19
|
business_id: 2740f141-89c1-515f-07eb-1128dd73491,
|
|
19
20
|
api_secret: QLA//Z13paUYo/2tLReQa-43c5JEAASujGamiY/QTvs=,
|
|
20
|
-
msp_id: e7e495d5-bf78-531d-baf6-7f419f7fb592
|
|
21
|
+
msp_id: e7e495d5-bf78-531d-baf6-7f419f7fb592,
|
|
22
|
+
authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ==)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# SunshineConversationsClient::AppleMessageOverridePayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**payload** | [**Object**](.md) | | [optional]
|
|
8
|
+
**with_capabilities** | **Array<String>** | List of capabilities needed for the override message to be received by the end user. `LIST` : for list picker; `TIME` : for time picker; `FORM` : for form; `QUICK` : for quick reply; `AUTH2` : for authentication | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'SunshineConversationsClient'
|
|
14
|
+
|
|
15
|
+
instance = SunshineConversationsClient::AppleMessageOverridePayload.new(payload: null,
|
|
16
|
+
with_capabilities: ["LIST"])
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/AppleUpdate.md
CHANGED
|
@@ -4,13 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
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
|
+
**default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide. | [optional]
|
|
9
|
+
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional]
|
|
7
10
|
|
|
8
11
|
## Code Sample
|
|
9
12
|
|
|
10
13
|
```ruby
|
|
11
14
|
require 'SunshineConversationsClient'
|
|
12
15
|
|
|
13
|
-
instance = SunshineConversationsClient::AppleUpdate.new(
|
|
16
|
+
instance = SunshineConversationsClient::AppleUpdate.new(display_name: My awesome integration,
|
|
17
|
+
default_responder_id: null,
|
|
18
|
+
authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ==)
|
|
14
19
|
```
|
|
15
20
|
|
|
16
21
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SunshineConversationsClient::AppleUpdateAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'SunshineConversationsClient'
|
|
13
|
+
|
|
14
|
+
instance = SunshineConversationsClient::AppleUpdateAllOf.new(authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ==)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/AttachmentsApi.md
CHANGED
|
@@ -5,8 +5,6 @@ All URIs are relative to *https://api.smooch.io*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**delete_attachment**](AttachmentsApi.md#delete_attachment) | **POST** /v2/apps/{appId}/attachments/remove | Delete Attachment
|
|
8
|
-
[**generate_media_json_web_token**](AttachmentsApi.md#generate_media_json_web_token) | **POST** /v2/apps/{appId}/attachments/token | Generate Media Token
|
|
9
|
-
[**set_cookie**](AttachmentsApi.md#set_cookie) | **GET** /v2/apps/{appId}/attachments/cookie | Set Cookie
|
|
10
8
|
[**upload_attachment**](AttachmentsApi.md#upload_attachment) | **POST** /v2/apps/{appId}/attachments | Upload Attachment
|
|
11
9
|
|
|
12
10
|
|
|
@@ -71,120 +69,6 @@ Name | Type | Description | Notes
|
|
|
71
69
|
- **Accept**: application/json
|
|
72
70
|
|
|
73
71
|
|
|
74
|
-
## generate_media_json_web_token
|
|
75
|
-
|
|
76
|
-
> AttachmentMediaTokenResponse generate_media_json_web_token(app_id, attachment_media_token_body)
|
|
77
|
-
|
|
78
|
-
Generate Media Token
|
|
79
|
-
|
|
80
|
-
Generates a media JWT for a list of attachment paths.
|
|
81
|
-
|
|
82
|
-
### Example
|
|
83
|
-
|
|
84
|
-
```ruby
|
|
85
|
-
# load the gem
|
|
86
|
-
require 'sunshine-conversations-client'
|
|
87
|
-
# setup authorization
|
|
88
|
-
SunshineConversationsClient.configure do |config|
|
|
89
|
-
# Configure HTTP basic authorization: basicAuth
|
|
90
|
-
config.username = 'YOUR_USERNAME'
|
|
91
|
-
config.password = 'YOUR_PASSWORD'
|
|
92
|
-
|
|
93
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
94
|
-
# Uncomment this line to use JWTs
|
|
95
|
-
# config.access_token = 'YOUR_JWT'
|
|
96
|
-
end
|
|
97
|
-
|
|
98
|
-
api_instance = SunshineConversationsClient::AttachmentsApi.new
|
|
99
|
-
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
100
|
-
attachment_media_token_body = SunshineConversationsClient::AttachmentMediaTokenBody.new # AttachmentMediaTokenBody |
|
|
101
|
-
# Be sure to add the required body parameters
|
|
102
|
-
|
|
103
|
-
begin
|
|
104
|
-
#Generate Media Token
|
|
105
|
-
result = api_instance.generate_media_json_web_token(app_id, attachment_media_token_body)
|
|
106
|
-
p result
|
|
107
|
-
rescue SunshineConversationsClient::ApiError => e
|
|
108
|
-
puts "Exception when calling AttachmentsApi->generate_media_json_web_token: #{e}"
|
|
109
|
-
end
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
### Parameters
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
Name | Type | Description | Notes
|
|
116
|
-
------------- | ------------- | ------------- | -------------
|
|
117
|
-
**app_id** | **String**| Identifies the app. |
|
|
118
|
-
**attachment_media_token_body** | [**AttachmentMediaTokenBody**](AttachmentMediaTokenBody.md)| |
|
|
119
|
-
|
|
120
|
-
### Return type
|
|
121
|
-
|
|
122
|
-
[**AttachmentMediaTokenResponse**](AttachmentMediaTokenResponse.md)
|
|
123
|
-
|
|
124
|
-
### Authorization
|
|
125
|
-
|
|
126
|
-
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
|
|
127
|
-
|
|
128
|
-
### HTTP request headers
|
|
129
|
-
|
|
130
|
-
- **Content-Type**: application/json
|
|
131
|
-
- **Accept**: application/json
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
## set_cookie
|
|
135
|
-
|
|
136
|
-
> Object set_cookie(app_id)
|
|
137
|
-
|
|
138
|
-
Set Cookie
|
|
139
|
-
|
|
140
|
-
With the media JWT retrieved, pass it in the header of the below request as it’s authorization in order to set a cookie in the user’s browser corresponding to the path within the media JWT. The expiration date of this cookie will match the expiration date of the media JWT.
|
|
141
|
-
|
|
142
|
-
### Example
|
|
143
|
-
|
|
144
|
-
```ruby
|
|
145
|
-
# load the gem
|
|
146
|
-
require 'sunshine-conversations-client'
|
|
147
|
-
# setup authorization
|
|
148
|
-
SunshineConversationsClient.configure do |config|
|
|
149
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
150
|
-
# Uncomment this line to use JWTs
|
|
151
|
-
# config.access_token = 'YOUR_JWT'
|
|
152
|
-
end
|
|
153
|
-
|
|
154
|
-
api_instance = SunshineConversationsClient::AttachmentsApi.new
|
|
155
|
-
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
156
|
-
# Be sure to add the required body parameters
|
|
157
|
-
|
|
158
|
-
begin
|
|
159
|
-
#Set Cookie
|
|
160
|
-
result = api_instance.set_cookie(app_id)
|
|
161
|
-
p result
|
|
162
|
-
rescue SunshineConversationsClient::ApiError => e
|
|
163
|
-
puts "Exception when calling AttachmentsApi->set_cookie: #{e}"
|
|
164
|
-
end
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### Parameters
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
Name | Type | Description | Notes
|
|
171
|
-
------------- | ------------- | ------------- | -------------
|
|
172
|
-
**app_id** | **String**| Identifies the app. |
|
|
173
|
-
|
|
174
|
-
### Return type
|
|
175
|
-
|
|
176
|
-
**Object**
|
|
177
|
-
|
|
178
|
-
### Authorization
|
|
179
|
-
|
|
180
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
181
|
-
|
|
182
|
-
### HTTP request headers
|
|
183
|
-
|
|
184
|
-
- **Content-Type**: Not defined
|
|
185
|
-
- **Accept**: application/json
|
|
186
|
-
|
|
187
|
-
|
|
188
72
|
## upload_attachment
|
|
189
73
|
|
|
190
74
|
> AttachmentResponse upload_attachment(app_id, access, source, opts)
|
|
@@ -211,7 +95,7 @@ end
|
|
|
211
95
|
|
|
212
96
|
api_instance = SunshineConversationsClient::AttachmentsApi.new
|
|
213
97
|
app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
|
|
214
|
-
access = 'public' # String | The access level for the attachment. Currently the available access
|
|
98
|
+
access = 'public' # String | The access level for the attachment. Currently the only available access level is public. Private is not supported.
|
|
215
99
|
source = File.new('/path/to/file') # File |
|
|
216
100
|
# Be sure to add the required body parameters
|
|
217
101
|
opts = {
|
|
@@ -234,7 +118,7 @@ end
|
|
|
234
118
|
Name | Type | Description | Notes
|
|
235
119
|
------------- | ------------- | ------------- | -------------
|
|
236
120
|
**app_id** | **String**| Identifies the app. |
|
|
237
|
-
**access** | **String**| The access level for the attachment. Currently the available access
|
|
121
|
+
**access** | **String**| The access level for the attachment. Currently the only available access level is public. Private is not supported. | [default to 'public']
|
|
238
122
|
**source** | **File**| |
|
|
239
123
|
**_for** | **String**| Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details. | [optional]
|
|
240
124
|
**conversation_id** | **String**| Links the attachment getting uploaded to the conversation ID. | [optional]
|
data/docs/IntegrationUpdate.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**server_key** | **String** | Your server key from the fcm console. | [optional]
|
|
13
13
|
**sender_id** | **String** | Your sender id from the fcm console. | [optional]
|
|
14
14
|
**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
|
|
15
|
+
**authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional]
|
|
15
16
|
**page_access_token** | **String** | A Facebook Page Access Token. | [optional]
|
|
16
17
|
**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional]
|
|
17
18
|
**password** | **String** | The password for your APN certificate. | [optional]
|
|
@@ -50,6 +51,7 @@ instance = SunshineConversationsClient::IntegrationUpdate.new(display_name: My a
|
|
|
50
51
|
server_key: <server-key>,
|
|
51
52
|
sender_id: <sender-id>,
|
|
52
53
|
can_user_create_more_conversations: null,
|
|
54
|
+
authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ==,
|
|
53
55
|
page_access_token: your_access_token,
|
|
54
56
|
certificate: your_APN_certificate,
|
|
55
57
|
password: your_APN_password,
|
data/docs/MessageOverride.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**apple** | [**
|
|
7
|
+
**apple** | [**AppleMessageOverridePayload**](AppleMessageOverridePayload.md) | | [optional]
|
|
8
8
|
**line** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional]
|
|
9
9
|
**messenger** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional]
|
|
10
10
|
**whatsapp** | [**MessageOverridePayload**](MessageOverridePayload.md) | | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**apple** | [**
|
|
7
|
+
**apple** | [**AppleMessageOverridePayload**](AppleMessageOverridePayload.md) | | [optional]
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Sunshine Conversations API
|
|
3
3
|
|
|
4
|
-
The version of the OpenAPI document:
|
|
4
|
+
The version of the OpenAPI document: 13.2.0
|
|
5
5
|
|
|
6
6
|
Generated by: https://openapi-generator.tech
|
|
7
7
|
OpenAPI Generator version: 4.3.1
|
|
@@ -86,142 +86,10 @@ module SunshineConversationsClient
|
|
|
86
86
|
return data, status_code, headers
|
|
87
87
|
end
|
|
88
88
|
|
|
89
|
-
# Generate Media Token
|
|
90
|
-
# Generates a media JWT for a list of attachment paths.
|
|
91
|
-
# @param app_id [String] Identifies the app.
|
|
92
|
-
# @param attachment_media_token_body [AttachmentMediaTokenBody]
|
|
93
|
-
# @param [Hash] opts the optional parameters
|
|
94
|
-
# @return [AttachmentMediaTokenResponse]
|
|
95
|
-
def generate_media_json_web_token(app_id, attachment_media_token_body, opts = {})
|
|
96
|
-
data, _status_code, _headers = generate_media_json_web_token_with_http_info(app_id, attachment_media_token_body, opts)
|
|
97
|
-
data
|
|
98
|
-
end
|
|
99
|
-
|
|
100
|
-
# Generate Media Token
|
|
101
|
-
# Generates a media JWT for a list of attachment paths.
|
|
102
|
-
# @param app_id [String] Identifies the app.
|
|
103
|
-
# @param attachment_media_token_body [AttachmentMediaTokenBody]
|
|
104
|
-
# @param [Hash] opts the optional parameters
|
|
105
|
-
# @return [Array<(AttachmentMediaTokenResponse, Integer, Hash)>] AttachmentMediaTokenResponse data, response status code and response headers
|
|
106
|
-
def generate_media_json_web_token_with_http_info(app_id, attachment_media_token_body, opts = {})
|
|
107
|
-
if @api_client.config.debugging
|
|
108
|
-
@api_client.config.logger.debug 'Calling API: AttachmentsApi.generate_media_json_web_token ...'
|
|
109
|
-
end
|
|
110
|
-
# verify the required parameter 'app_id' is set
|
|
111
|
-
if @api_client.config.client_side_validation && app_id.nil?
|
|
112
|
-
fail ArgumentError, "Missing the required parameter 'app_id' when calling AttachmentsApi.generate_media_json_web_token"
|
|
113
|
-
end
|
|
114
|
-
# verify the required parameter 'attachment_media_token_body' is set
|
|
115
|
-
if @api_client.config.client_side_validation && attachment_media_token_body.nil?
|
|
116
|
-
fail ArgumentError, "Missing the required parameter 'attachment_media_token_body' when calling AttachmentsApi.generate_media_json_web_token"
|
|
117
|
-
end
|
|
118
|
-
# resource path
|
|
119
|
-
local_var_path = '/v2/apps/{appId}/attachments/token'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
|
|
120
|
-
|
|
121
|
-
# query parameters
|
|
122
|
-
query_params = opts[:query_params] || {}
|
|
123
|
-
|
|
124
|
-
# header parameters
|
|
125
|
-
header_params = opts[:header_params] || {}
|
|
126
|
-
# HTTP header 'Accept' (if needed)
|
|
127
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
128
|
-
# HTTP header 'Content-Type'
|
|
129
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
130
|
-
|
|
131
|
-
# form parameters
|
|
132
|
-
form_params = opts[:form_params] || {}
|
|
133
|
-
|
|
134
|
-
# http body (model)
|
|
135
|
-
post_body = opts[:body] || @api_client.object_to_http_body(attachment_media_token_body)
|
|
136
|
-
|
|
137
|
-
# return_type
|
|
138
|
-
return_type = opts[:return_type] || 'AttachmentMediaTokenResponse'
|
|
139
|
-
|
|
140
|
-
# auth_names
|
|
141
|
-
auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
|
|
142
|
-
|
|
143
|
-
new_options = opts.merge(
|
|
144
|
-
:header_params => header_params,
|
|
145
|
-
:query_params => query_params,
|
|
146
|
-
:form_params => form_params,
|
|
147
|
-
:body => post_body,
|
|
148
|
-
:auth_names => auth_names,
|
|
149
|
-
:return_type => return_type
|
|
150
|
-
)
|
|
151
|
-
|
|
152
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
153
|
-
if @api_client.config.debugging
|
|
154
|
-
@api_client.config.logger.debug "API called: AttachmentsApi#generate_media_json_web_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
155
|
-
end
|
|
156
|
-
return data, status_code, headers
|
|
157
|
-
end
|
|
158
|
-
|
|
159
|
-
# Set Cookie
|
|
160
|
-
# With the media JWT retrieved, pass it in the header of the below request as it’s authorization in order to set a cookie in the user’s browser corresponding to the path within the media JWT. The expiration date of this cookie will match the expiration date of the media JWT.
|
|
161
|
-
# @param app_id [String] Identifies the app.
|
|
162
|
-
# @param [Hash] opts the optional parameters
|
|
163
|
-
# @return [Object]
|
|
164
|
-
def set_cookie(app_id, opts = {})
|
|
165
|
-
data, _status_code, _headers = set_cookie_with_http_info(app_id, opts)
|
|
166
|
-
data
|
|
167
|
-
end
|
|
168
|
-
|
|
169
|
-
# Set Cookie
|
|
170
|
-
# With the media JWT retrieved, pass it in the header of the below request as it’s authorization in order to set a cookie in the user’s browser corresponding to the path within the media JWT. The expiration date of this cookie will match the expiration date of the media JWT.
|
|
171
|
-
# @param app_id [String] Identifies the app.
|
|
172
|
-
# @param [Hash] opts the optional parameters
|
|
173
|
-
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
174
|
-
def set_cookie_with_http_info(app_id, opts = {})
|
|
175
|
-
if @api_client.config.debugging
|
|
176
|
-
@api_client.config.logger.debug 'Calling API: AttachmentsApi.set_cookie ...'
|
|
177
|
-
end
|
|
178
|
-
# verify the required parameter 'app_id' is set
|
|
179
|
-
if @api_client.config.client_side_validation && app_id.nil?
|
|
180
|
-
fail ArgumentError, "Missing the required parameter 'app_id' when calling AttachmentsApi.set_cookie"
|
|
181
|
-
end
|
|
182
|
-
# resource path
|
|
183
|
-
local_var_path = '/v2/apps/{appId}/attachments/cookie'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
|
|
184
|
-
|
|
185
|
-
# query parameters
|
|
186
|
-
query_params = opts[:query_params] || {}
|
|
187
|
-
|
|
188
|
-
# header parameters
|
|
189
|
-
header_params = opts[:header_params] || {}
|
|
190
|
-
# HTTP header 'Accept' (if needed)
|
|
191
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
192
|
-
|
|
193
|
-
# form parameters
|
|
194
|
-
form_params = opts[:form_params] || {}
|
|
195
|
-
|
|
196
|
-
# http body (model)
|
|
197
|
-
post_body = opts[:body]
|
|
198
|
-
|
|
199
|
-
# return_type
|
|
200
|
-
return_type = opts[:return_type] || 'Object'
|
|
201
|
-
|
|
202
|
-
# auth_names
|
|
203
|
-
auth_names = opts[:auth_names] || ['bearerAuth']
|
|
204
|
-
|
|
205
|
-
new_options = opts.merge(
|
|
206
|
-
:header_params => header_params,
|
|
207
|
-
:query_params => query_params,
|
|
208
|
-
:form_params => form_params,
|
|
209
|
-
:body => post_body,
|
|
210
|
-
:auth_names => auth_names,
|
|
211
|
-
:return_type => return_type
|
|
212
|
-
)
|
|
213
|
-
|
|
214
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
215
|
-
if @api_client.config.debugging
|
|
216
|
-
@api_client.config.logger.debug "API called: AttachmentsApi#set_cookie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
217
|
-
end
|
|
218
|
-
return data, status_code, headers
|
|
219
|
-
end
|
|
220
|
-
|
|
221
89
|
# Upload Attachment
|
|
222
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://docs.smooch.io/guide/validating-files\">file validation</a> guide for more details.</aside>
|
|
223
91
|
# @param app_id [String] Identifies the app.
|
|
224
|
-
# @param access [String] The access level for the attachment. Currently the available access
|
|
92
|
+
# @param access [String] The access level for the attachment. Currently the only available access level is public. Private is not supported.
|
|
225
93
|
# @param source [File]
|
|
226
94
|
# @param [Hash] opts the optional parameters
|
|
227
95
|
# @option opts [String] :_for Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details.
|
|
@@ -235,7 +103,7 @@ module SunshineConversationsClient
|
|
|
235
103
|
# Upload Attachment
|
|
236
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://docs.smooch.io/guide/validating-files\">file validation</a> guide for more details.</aside>
|
|
237
105
|
# @param app_id [String] Identifies the app.
|
|
238
|
-
# @param access [String] The access level for the attachment. Currently the available access
|
|
106
|
+
# @param access [String] The access level for the attachment. Currently the only available access level is public. Private is not supported.
|
|
239
107
|
# @param source [File]
|
|
240
108
|
# @param [Hash] opts the optional parameters
|
|
241
109
|
# @option opts [String] :_for Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details.
|