Skip to content

Commit 04f460f

Browse files
committed
doc: PR comments and upper/lowercase consistency
1 parent a2ff24e commit 04f460f

1 file changed

Lines changed: 71 additions & 70 deletions

File tree

CHANGELOG.md

Lines changed: 71 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
All notable changes to the **Sinch Java SDK** are documented in this file.
44

55
> **Tag legend**
6-
> - `[Feature]` — new capability
6+
> - `[feature]` — new capability
77
> - `[fix]` — bug fix
88
> - `[deprecation notice]` — will be removed in a future release
99
> - `[dependency]` — third-party library update
@@ -22,31 +22,31 @@ All notable changes to the **Sinch Java SDK** are documented in this file.
2222
- see [MIGRATION-GUIDE](MIGRATION-GUIDE.md#200)
2323

2424
### Conversation
25-
- **[Feature]** Support `Project Settings` API
26-
- **[Feature]** Support `Contacts Identity Conflicts` API
27-
- **[Feature]** [Messages] Support new `direction` query parameter for `MessagesListQueryParameterslist`
28-
- **[Feature]** [Messages] Support `listLastMessagesByChannelIdentity` API
29-
- **[Feature]** [KakaoTalk] Support `COMMERCE` and `CAROUSEL_COMMERCE` channel specific message
30-
- **[Feature]** [LINE] Support `NOTIFICATION_MESSAGE_TEMPLATE` channel specific message
25+
- **[feature]** Support `Project Settings` API
26+
- **[feature]** Support `Contacts Identity Conflicts` API
27+
- **[feature]** [Messages] Support new `direction` query parameter for `MessagesListQueryParameters`
28+
- **[feature]** [Messages] Support `listLastMessagesByChannelIdentity` API
29+
- **[feature]** [KakaoTalk] Support `COMMERCE` and `CAROUSEL_COMMERCE` channel specific message
30+
- **[feature]** [LINE] Support `NOTIFICATION_MESSAGE_TEMPLATE` channel specific message
3131
- **[deprecation notice]** [OrderDetailsSettings] [`PaymentSettings`](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/1.7.1/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/payment/OrderDetailsPayment.html#getPaymentSettings()) deprecated in favor of [`PaymentButtons`](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/1.7.1/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/payment/OrderDetailsPayment.html#getPaymentButtons())
3232

3333
### Verification
34-
- **[Feature]** Support `VerificationSmsDeliveredEvent` webhook events
34+
- **[feature]** Support `VerificationSmsDeliveredEvent` webhook events
3535
- FlashCall
36-
- **[Feature]** `VerificationStartRequestFlashCall` support `interceptionTimeout` and additionalProperties
37-
- **[Feature]** `VerificationStartResponseFlashCall` support additionalProperties
38-
- **[Feature]** `VerificationRequestEventResponseFlashCall` support `interceptionTimeout` and additionalProperties
36+
- **[feature]** `VerificationStartRequestFlashCall` support `interceptionTimeout` and additionalProperties
37+
- **[feature]** `VerificationStartResponseFlashCall` support additionalProperties
38+
- **[feature]** `VerificationRequestEventResponseFlashCall` support `interceptionTimeout` and additionalProperties
3939
- PhoneCall
40-
- **[Feature]** `VerificationStartRequestPhoneCall` support additionalProperties
41-
- **[Feature]** `VerificationRequestEventResponsePhoneCall` support additionalProperties
40+
- **[feature]** `VerificationStartRequestPhoneCall` support additionalProperties
41+
- **[feature]** `VerificationRequestEventResponsePhoneCall` support additionalProperties
4242
- SMS
43-
- **[Feature]** `VerificationStartResponseSms` support `codeType` and additionalProperties
44-
- **[Feature]** `VerificationRequestEventResponseSms` support `codeType`, `expiry` and additionalProperties
43+
- **[feature]** `VerificationStartResponseSms` support `codeType` and additionalProperties
44+
- **[feature]** `VerificationRequestEventResponseSms` support `codeType`, `expiry` and additionalProperties
4545
- WhatsApp
46-
- **[Feature]** [BETA] Support `WhatsApp` verification method
46+
- **[feature]** [BETA] Support `WhatsApp` verification method
4747

4848
### Voice
49-
- **[Feature]** Support new DICE reason values
49+
- **[feature]** Support new DICE reason values
5050

5151

5252
---
@@ -61,27 +61,27 @@ All notable changes to the **Sinch Java SDK** are documented in this file.
6161
- **[dependency]** Bump Jackson dependency to '2.19.0'
6262
- **[dependency]** Bump generated sources based onto generator '7.13'
6363
- **[dependency]** Bump maven-gpg-plugin used to sign released artifacts to '1.6'
64-
- **[releasing]** migration to replace deprecated OSSRH in favor of SonaType Central
64+
- **[releasing]** Migration to replace deprecated OSSRH in favor of SonaType Central
6565
- **[test]** Activate parallel mode for unit tests
6666

6767
### Conversation
6868
- **[fix]** Specifications fixed:
6969
- `TemplateMessage.OmniTemplate` field is now requiring a `TemplateReference` with `version` field filled.
7070
- `TemplateMessage.ChannelTemplate` still use a `TemplateReference` with `version` field not required.
71-
To avoid breaking change and namespace pollution, SDK is accepting a common `TemplateReference` instance and validation about the required `version` field won't be performed at client level by client, but will validate at backend level after having sent the request.
72-
- **[Feature]** `Reason.channel_code` field added (only for supported by WhatsApp)
71+
To avoid breaking changes and namespace pollution, SDK is accepting a common `TemplateReference` instance and validation about the required `version` field won't be performed at client level by client, but will validate at backend level after having sent the request.
72+
- **[feature]** `Reason.channel_code` field added (only for supported by WhatsApp)
7373
- **[deprecation notice]** Emit a warning log onto using default region for Conversation (US). To avoid regulation issue, defaulting to US will no longer be supported in future version and defining the region will be required.
7474
- **[test]** Clean Jackson cache during unit tests
7575

7676
### Mailgun
77-
- **[Feature]** `copyVersion` API based now return `version` field in place of deprecated `template` one
77+
- **[feature]** `copyVersion` API based now return `version` field in place of deprecated `template` one
7878
- **[doc]** Improve Javadoc rendering by separating summary and notes
7979
- **[deprecation notice]** Emit a warning log onto using default region for Mailgun (US). To avoid regulation issue, defaulting to US will no longer be supported in future version and defining the region will be required.
8080

8181
### Numbers
82-
- **[Feature]** Support Emergency Address
83-
- **[Feature]** Add new API `rent(phoneNumber)` without configuration
84-
- **[Feature]** Switch from 'Basic' to 'OAuth' auth
82+
- **[feature]** Support Emergency Address
83+
- **[feature]** Add new API `rent(phoneNumber)` without configuration
84+
- **[feature]** Switch from 'Basic' to 'OAuth' auth
8585
- **[deprecation notice]**
8686
- [list(ActiveNumberListRequest)](https://www.javadoc.io/static/com.sinch.sdk/sinch-sdk-java/1.7.0/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#list(com.sinch.sdk.domains.numbers.models.v1.request.ActiveNumberListRequest)) replaced by [list(ActiveNumbersListQueryParameters)](https://www.javadoc.io/static/com.sinch.sdk/sinch-sdk-java/1.7.0/com/sinch/sdk/domains/numbers/api/v1/ActiveNumberService.html#list(com.sinch.sdk.domains.numbers.models.v1.request.ActiveNumbersListQueryParameters))
8787
- [searchForAvailableNumbers(AvailableNumberListRequest)](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#searchForAvailableNumbers(com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberListRequest)) replaced by [searchForAvailableNumbers(AvailableNumbersListQueryParameters)](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/AvailableNumberService.html#searchForAvailableNumbers(com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumbersListQueryParameters))
@@ -95,78 +95,79 @@ All notable changes to the **Sinch Java SDK** are documented in this file.
9595

9696
### Voice
9797
- **[test]** Extend end-to-end tests against `notify`
98-
- **[Feature]** Support SVAML `connectStream` action
99-
- **[Feature]** Support `asynch` field for `amdRequest`
100-
- **[Feature]** Define two new values for `AnsweringMachineDetection.Reason` enum
98+
- **[feature]** Support SVAML `connectStream` action
99+
- **[feature]** Support `asynch` field for `amdRequest`
100+
- **[feature]** Define two new values for `AnsweringMachineDetection.Reason` enum
101101

102102
---
103103

104104
## v1.6.0 – 2025-04-23
105105

106106
### SDK
107-
- **[Feature]** Lazy HTTP client initialization until really required
107+
- **[feature]** Lazy HTTP client initialization until really required
108108

109109
### Cross domains
110-
- **[Feature]** Relax domains init for Webhooks when credentials are not required
111-
- **[Feature]** Validation against missing required property at protocol level
110+
- **[feature]** Relax domains init for Webhooks when credentials are not required
111+
- **[feature]** Validation against missing required property at protocol level
112112

113113
### Conversation
114114
- **[fix]** `CardMessage.media_message` is now of `MediaMessage` type
115-
- **[Feature]** New `ListMessage.media` field is supported
116-
- **[Feature]** New SG (Singapore) country defined for WhatsApp order payment details
117-
- **[Feature]** New `ConversationChannelCredentials.credential_ordinal_number` field is supported
118-
- **[Feature]** New `LineEnterpriseCredentials` is supported
119-
- **[Feature]** New `LineCredentialsField.isDefault` field is supported
120-
- **[Feature]** New `SendMessageRequest.message_content_type` is supported (enum of `MessageContentType`)
121-
- **[Feature]** New `ChannelSpecificMessage` classes for WhatsApp:
115+
- **[feature]** New `ListMessage.media` field is supported
116+
- **[feature]** New SG (Singapore) country defined for WhatsApp order payment details
117+
- **[feature]** New `ConversationChannelCredentials.credential_ordinal_number` field is supported
118+
- **[feature]** New `LineEnterpriseCredentials` is supported
119+
- **[feature]** New `LineCredentialsField.isDefault` field is supported
120+
- **[feature]** New `SendMessageRequest.message_content_type` is supported (enum of `MessageContentType`)
121+
- **[feature]** New `ChannelSpecificMessage` classes for WhatsApp:
122122
- `OrderDetails`
123123
- `OrderStatus`
124124
- **[deprecation notice]** `CardMessageMedia` class is deprecated in favor of shared `MediaMessage`
125125

126126
### Mailgun as PREVIEW features
127127

128-
- **[Feature]** Support "Emails"
129-
- **[Feature]** Support "Templates"
128+
- **[feature]** Support "Emails"
129+
- **[feature]** Support "Templates"
130130

131131
### SMS
132132

133133
- **[fix]** `contentType` VS `content_type` JSON field name for `MediaMessageBodyDetails` at protocol level
134-
- **[fix]** body requests defined as required at protocol level
134+
- **[fix]** Body requests defined as required at protocol level
135135
- **[fix]** `UpdateBinaryRequest.udh` field is required at protocol level
136-
- **[Feature]** `DryRunPerRecipientDetails.encodingEnum` defined as an enum
137-
- **[Feature]** List batches query parameters is accepting a list from values of code
136+
- **[feature]** `DryRunPerRecipientDetails.encodingEnum` defined as an enum
137+
- **[feature]** List batches query parameters is accepting a list from values of code
138138
- **[deprecation notice]** List batches query parameters accepting a single from value (replaced by function above)
139139
- **[deprecation notice]** `DryRunPerRecipientDetails.encoding` is deprecated in favor of `DryRunPerRecipientDetails.encodingEnum`
140140

141141
### Voice
142142

143-
- **[Feature]** Define `AnsweringMachineDetection` used by `AnsweredCallEvent` and `NotificationEvent`
144-
- **[Feature]** `conferenceId` field is supported by
143+
- **[feature]** Define `AnsweringMachineDetection` used by `AnsweredCallEvent` and `NotificationEvent`
144+
- **[feature]** `conferenceId` field is supported by
145145
- `AnsweredCallEvent`
146146
- `DisconnectCallEvent`
147147
- `IncomingCallEvent`
148148
- `NotificationEvent`
149149
- `PromptInputEvent`
150-
- **[Feature]** `NotificationEvent` support `destination` and `amd` fields
150+
- **[feature]** `NotificationEvent` support `destination` and `amd` fields
151151
- **[deprecation notice]** `AnsweredCallEventAnsweringMachineDetection` is replaced by `AnsweringMachineDetection`
152152
- **[deprecation notice]** Following backend endpoint deprecation `applications.queryNumber` is deprecated
153153

154154
---
155155

156156
## v1.5.1 – 2025-03-04
157-
- **[fix]** conversation fix card message
157+
### Conversation
158+
- **[fix]** `CardMessage`
158159
- `CardMessage.media` field is of `MediaMessage` type (see Javadoc)
159160
- `CardMessageMedia` class is deprecated (see Javadoc)
160161

161162
---
162163

163164
## v1.5.0 – 2025-02-12
164165

165-
### chore
166+
### Chore
166167
- **[dependency]** Updated Jackson dependency to jackson-jakarta-rs-providers v2.18.2
167168

168169
### SMS
169-
- **[Feature]** Versioned access to SMS services
170+
- **[feature]** Versioned access to SMS services
170171
- **[deprecation notice]** Un-versioned access to SMS services (see SMS migration guide)
171172

172173
### Conversation
@@ -188,14 +189,14 @@ All notable changes to the **Sinch Java SDK** are documented in this file.
188189

189190
### Voice
190191

191-
- **[Feature]** support V1 design
192-
- **[Feature]** Follow specification update for SVAML `PlayFiles.locale`, field is no longer required
192+
- **[feature]** Support V1 design
193+
- **[feature]** Follow specification update for SVAML `PlayFiles.locale`, field is no longer required
193194
- **[fix]** Webhooks callbacks validation use case-insensitive headers (`validateAuthenticationHeader`)
194195
- **[test]** Extend tests coverage (introduced end-to-end tests)
195196

196197
### Numbers
197-
- **[Feature]** Specification update for `VoiceConfiguration.scheduledProvisioning` defined as readOnly
198-
- **[Feature]** Specification update for `SmSConfiguration.scheduledProvisioning` defined as readOnly
198+
- **[feature]** Specification update for `VoiceConfiguration.scheduledProvisioning` defined as readOnly
199+
- **[feature]** Specification update for `SmSConfiguration.scheduledProvisioning` defined as readOnly
199200

200201
---
201202

@@ -210,21 +211,21 @@ All notable changes to the **Sinch Java SDK** are documented in this file.
210211

211212
#### Generated sources
212213
- **[fix]** Generated sources with OptionalValue getter: guard against uninitialized value
213-
- **[Feature]** contains serializer/deserializer to be used for delegation pattern
214-
- **[Feature]** enhanced javadoc content
214+
- **[feature]** Contains serializer/deserializer to be used for delegation pattern
215+
- **[feature]** Enhanced javadoc content
215216

216217
#### Versioning
217-
- **[Feature]** Store SDK related information within sources
218+
- **[feature]** Store SDK related information within sources
218219

219220
### Conversation
220-
- **[Feature]** Support Conversation API
221+
- **[feature]** Support Conversation API
221222

222223
### Numbers
223-
- **[Feature]** Helper function for webhook authentication header
224-
- **[Feature]** readOnly fields are no longer sent over network
224+
- **[feature]** Helper function for webhook authentication header
225+
- **[feature]** `readOnly` fields are no longer sent over network
225226

226227
### SMS
227-
- **[Feature]** Align with updated specs for DryRun
228+
- **[feature]** Align with updated specs for DryRun
228229

229230
### Verification
230231
- **[fix]** Enforce webhooks validation logic for empty or missing `authorization` header
@@ -239,7 +240,7 @@ All notable changes to the **Sinch Java SDK** are documented in this file.
239240

240241
## v1.2.3 – 2024-09-04
241242
### Verification (SMS)
242-
- **[Feature]** Support additional properties onto Start verification by SMS
243+
- **[feature]** Support additional properties onto Start verification by SMS
243244

244245
---
245246

@@ -261,7 +262,7 @@ The existing non-versioned services will no longer be updated with new features/
261262

262263
### Numbers
263264
- **[design]** New versioned service simplified access to available or active: APIs are accessible directly under `v1()`
264-
- **[Feature]** FAX & EST number's configuration. The `VoiceConfiguration` and `ScheduledVoiceProvisioning` models have been updated to reflect the "Unified Numbers" API updates: they now hold values for Fax and Elastic SIP Trunking configuration (respectively with the properties `serviceId` and `trunkId`).
265+
- **[feature]** FAX & EST number's configuration. The `VoiceConfiguration` and `ScheduledVoiceProvisioning` models have been updated to reflect the "Unified Numbers" API updates: they now hold values for Fax and Elastic SIP Trunking configuration (respectively with the properties `serviceId` and `trunkId`).
265266

266267
### Verification
267268
- **[doc]** Error message related to invalid configuration (credentials) fixed
@@ -275,12 +276,12 @@ Starting with the `Verification` domain, you can access services by using the `v
275276
The existing non-versioned services will no longer be updated with new features/fields.
276277

277278
### Verification
278-
- **[Feature]** [Design] Non-versioned `Verification` domain is split into dedicated Start and Report new versioned services
279+
- **[feature]** [Design] Non-versioned `Verification` domain is split into dedicated Start and Report new versioned services
279280

280-
- **[Feature]** Synchronization with documentation terms
281+
- **[feature]** Synchronization with documentation terms
281282
- `Callout` related fields and APIs are now named Phone Call
282283
- `Seamless` related fields and APIs are now named Data
283-
- **[Feature]** Start Verification
284+
- **[feature]** Start Verification
284285
- `VerificationStartRequestSms`
285286
- Support `Accept-Language` option
286287
- Support `code type` option
@@ -289,10 +290,10 @@ The existing non-versioned services will no longer be updated with new features/
289290
- Support `speech` option
290291
- `VerificationStartResponseData`
291292
- **[fix]** `targetUri` field added
292-
- **[Feature]** Verification Report
293+
- **[feature]** Verification Report
293294
- **[fix]** `VerificationReportResponse`: Report service no longer returns a common status response shared with status service, but a dedicated verification report response.
294295

295-
- **[Feature]** Webhooks
296+
- **[feature]** Webhooks
296297
- **[deprecation notice]** `VerificationRequestEvent.acceptLanguage` field is deprecated
297298

298299
- **[tech]** Logs
@@ -301,8 +302,8 @@ The existing non-versioned services will no longer be updated with new features/
301302
---
302303

303304
## v1.0.0 – 2024-04-18
304-
- **[Feature]** Support Numbers API (SDK doc)
305-
- **[Feature]** Support SMS API (SDK doc). Support both unified credentials (projectId) and service planId
306-
- **[Feature]** Support Verification API (SDK doc)
307-
- **[Feature]** Support Voice API (REST API)
305+
- **[feature]** Support Numbers API (SDK doc)
306+
- **[feature]** Support SMS API (SDK doc). Support both unified credentials (projectId) and service planId
307+
- **[feature]** Support Verification API (SDK doc)
308+
- **[feature]** Support Voice API (REST API)
308309
- **[doc]** Online javadoc

0 commit comments

Comments
 (0)