Skip to content

CHANGELOG_RB.md

Latest commit

 

History

History
397 lines (217 loc) · 11.4 KB

CHANGELOG_RB.md

File metadata and controls

397 lines (217 loc) · 11.4 KB
Raw

Changelog

[17.0.0] - 2025-08-25

  • Fixes #27
  • Final release.
  • Going forward, the Ruby Language wrapper for the Sunshine Conversations API will no longer be generated in accordance with specification updates. Existing versions will continue to work, however new additions to the API specification will not be captured. Customers are encouraged to use existing open-source tooling such as https://github.com/OpenAPITools/openapi-generator to generate their own wrappers based on the API specification.
  • Refer to the public https://github.com/zendesk/sunshine-conversations-api-spec repository for the official Sunshine Conversations API specification.

[16.0.1] - 2025-08-20

  • Documentation updates

[16.0.0] - 2025-08-13

  • Added conversion events API.
  • Added reason field to switchboard:passControl and switchboard:releaseControl webhook events.
  • Updated various links in documentation.

[15.5.2] - 2025-07-08

  • Added release control in the webhook and webhook event documentation.

[15.5.1] - 2025-06-02

  • Fix various docs links

[15.5.0] - 2025-05-06

  • Added new optional field metadata to release control.
  • Documented optional field reason on release control and pass control.
  • Added documentation for the /tokenInfo endpoint.

[15.4.0] - 2025-04-30

  • Moved authenticated User property into the userTruncated base schema.
  • Added surviving_zendesk_id body parameter to the Synchronize User API.

[15.3.2] - 2025-04-21

  • Added new optional field blockChatInput to all message types

[15.3.1] - 2025-04-08

  • Updated tooling to resolve package publishing issue.

[15.3.0] - 2025-04-07

  • Added new sync endpoint for synchronizing a messaging user with its core Zendesk user counterpart.

[15.2.0] - 2025-04-01

  • Added new authenticated property to User and all relevant APIs.

[15.1.0] - 2025-03-13

  • Added new zendeskId property to User and all relevant APIs.

[15.0.1] - 2025-03-05

Fixed

  • No code changes.

[15.0.0] - 2025-03-05

Fixed

  • Fixed nullable definition on next_switchbard_integration_id property
  • Fixed nullable definition on required integration credentials
  • Changed typing of metadata fields from Object to Hash<String, Object>
  • Changed return type of download_message_ref() from Object to Hash<String, Object>
  • Changed typing of device info property from Object to Hash<String, Object>
  • Removed switchboard_id and app_id properties in default_responder schema
  • Removed deployment_id in WhatsApp Integration

[14.4.0] - 2025-03-03

Added

  • Add can_user_see_conversation_list to all SDK integrations and their update schemas
  • Added new fields html_text, markdown_text to Text, Image and File messages.
  • See our rich text guide for more information.
  • Add definitions for ErrorResponse and Error

[14.3.5] - 2025-02-01

Added

  • Update author.subtype enum to include 'activity'.

[14.3.4] - 2025-01-14

Added

  • Add a side note in the api documentation about providing authentication header when accessing mediaUrl with private attachments

[14.3.1 - 14.3.3] - 2025-01-07

  • Fixed errors that prevented publishing language wrappers for the new version.

[14.3.0] - 2024-12-30

Added

  • Added new read-only activity property to Messages to denote system activities.

[14.2.0] - 2024-12-11

Added

[14.1.0] - 2024-11-22

Added

  • Added new downloadMessageRef Conversation API endpoint.

[14.0.0] - 2024-11-21

Fixed

  • Fixed: Removed erroneous "uri" format from uri property in the "webview" action type.
  • Removed allOf from customUpdate.

[13.2.0] - 2024-11-13

Added

  • Added new withCapabilities property to the Passthrought API endpoints, to Apple override MessagesPayload.
  • Added authenticationMessageSecret to the Integrations create and update endpoints

[13.1.0] - 2024-09-18

Changed

  • Removed private attachments support.

[13.0.0] - 2024-09-17

Added

  • List devices response changed from clients to devices

[12.8.0] - 2024-09-12

Added

  • Added new createdAt property on the conversation content of the Conversations API endpoints.

[12.7.0] - 2024-07-24

Added

  • Added new attachmentId property on the file and image message content of the Messages API endpoints.

[12.6.0] - 2024-06-12

Added

  • Added new defaultResponderId and defaultResponder property to the Integrations API endpoints.

[12.5.1] - 2024-06-11

Changed

  • Updated dropdown limit and removed private attachments.

[12.5.0] - 2024-05-01

Added

  • Added Devices endpoint to the Users API.

[12.4.0] - 2024-04-24

Changed

  • Changed Android integration creation and update: added properties for new Firebase credentials and deprecated legacy properties

[12.3.1] - 2024-03-07

Fixed

  • Fixed an issue with the author schema that was causing Java build failures

[12.3.0] - 2024-03-06

Added

  • Added new subtypes property on the business author object.

[12.2.2] - 2024-01-31

Fixed

  • Fixed private Attachments not compatible with Zendesk customers
  • Fixed python wrapper publish with API Token

[12.2.1] - 2024-01-29

Fixed

  • Fixed python wrapper publish.

[12.2.0] - 2024-01-23

Added

  • Added new attachmentsEnabled optional response field for SDK integrations.

[12.1.0] - 2023-12-13

Added

  • Added new unity integration type.

[12.0.0] - 2023-11-03

Changed

  • [Java] Changed: javax namespace to jakarta
  • [Java] Changed: Upgraded resteasy dependency to use jakarta namespace

[11.0.0] - 2023-11-01

Updated

  • Updated: Updated maximum value for text type form message maxSize field to 256.
  • Updated: Updated maximum value for text type form message minSize field to 256.

Fixed

  • Fixed: Fixed list of valid properties for formMessage vs formResponseMessage.
  • Fixed: Removed erroneous "uri" format from uri property in the "link" action type.

[10.0.1] - 2023-09-13

Fixed

  • Fixed: Added missing mediaType and mediaSize properties to imageMessage schema.

[10.0.0] - 2023-09-07

Fixed

  • Fixed: Removed deprecated enums from Twitter Integration definition

[9.15.0] - 2023-09-06

Fixed

  • Fixed: Added missing client types to the schema: apple, gbm, googlercs, instagram, kakao, slackconnect

[9.14.0] - 2023-04-10

Added

  • Added a new identities read only property on the user object.

[9.13.0] - 2023-03-30

Added

  • Added a new proactiveMessaging creation reason for the conversation:create webhook event.
  • Added a campaign object to the source object of the following webhook events:
    • conversation:create
    • conversation:message
    • conversation:postback
    • conversation:referral

[9.12.0] - 2022-08-30

  • 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 or Custom Integration API Key credentials. Duplicate passControl actions using the next keyword and their metadata are disregarded.
  • For more information, see Switchboard passControl.

[9.11.0] - 2022-07-28

Added

  • Added conversation:referral event. This currently fires when a user is referred to an existing conversation.

[9.10.0] - 2022-07-19

Added

  • Added a new unblocked reason for the client:update webhook event.

[9.9.0] - 2022-07-12

Added

  • Added new appLocalizationEnabled parameter to app settings.

[9.8.0] - 2022-06-29

Added

  • metadata property now appear in the conversation object in webhook events

[9.7.0] - 2022-05-05

Added

  • Added a releaseControl action endpoint to the Switchboard Actions API.

[9.6.0] - 2022-03-23

Added

  • Added user:update event. This event currently fires when an anonymous user is converted to an authenticated user.
  • Added missing reason in the user:merge webhook payload example.

[9.5.7] - 2022-01-04

  • Added missing pageId and pageName properties on Messenger integration.

[9.5.6] - 2021-11-30

  • Dependencies security update; Ruby wrapper not affected.

[9.4.6] - 2021-09-28

  • Added channel linking events
  • Added canUserSeeConversationList in the web integration
  • Updated RESTeasy to the latest version

[9.4.5] - 2021-08-23

  • Added page[before|after|size] query parameter constraints.

[9.4.4] - 2021-04-12

Added

  • Added messagingServiceSid field when creating a Twilio integration that will use Messaging Services.

[9.4.3] - 2021-02-16

Fixed

  • Fixed: query Page1 instead of Page being used in the v2 List Messages API
  • Fixed: property displayName should not be nullable in v2 App Key API

[9.4.2] - 2021-01-06

Added

  • Added phoneNumber to the integration whatsapp response
  • Added a message type template in the Post Message API

Changed

  • Removed channelId and channelSecret as required fields when creating a LINE integration

Fixed

  • Fixed: property messageSchema should be schema in v2 Post Message API

[9.4.1] - 2020-12-16

Changed

  • Changed the limit of the select field options from 20 to 100

[9.4.0] - 2020-12-15

Added

  • Added a new user profile field locale

[9.3.0] - 2020-11-18

Added

  • Added a new optional field altText to the message schema when sending an image or a file

[9.2.0] - 2020-11-16

Added

  • Added support for Instagram Direct

[9.1.1] - 2020-11-11

Fixed

  • Fixed rubygems upload issues

[9.1.0] - 2020-11-11

Added

  • Release of Ruby wrappers