Fix comments

sinch · Oct 1, 2024 · caff357 · caff357
1 parent 8b0c6cb
commit caff357
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 46 deletions.
diff --git a/packages/conversation/CHANGELOG.md b/packages/conversation/CHANGELOG.md
@@ -5,7 +5,7 @@
 - [Bugfix] Template V2: add an optional `id` property to the `V2Template` interface.
 - [Bugfix] `conversations.listRecent()`: Add a page_size value by default. Without it the API returns an empty list.
 - [Bugfix][Breaking] `InjectConversationEvent` interface: only `AppEvent` is allowed (`ContactEvent` and `ContactMessageEvent` are no longer allowed).
-- [Bugfix][Breaking TS] 
+- [Bugfix][Breaking]
   - Template V2: For "create" and "update" operations, the request bodies interface no longer accept read-only properties.
   - Webhooks: For "create" and "update" operations, the request bodies interface no longer accept read-only properties.
 - [E2E] Add Cucumber steps implementation.

diff --git a/packages/elastic-sip-trunking/CHANGELOG.md b/packages/elastic-sip-trunking/CHANGELOG.md
@@ -2,10 +2,10 @@
 - [Tech] Update dependency `@sinch/sdk-client` to `1.2.0`.
 - [Feature] Add the method `accessControlList.get()`.
 - Calls History:
-  - [Bugfix][Breaking TS] The `DirectionEnum` values are in lower case. E.g: INBOUND -> inbound.
-  - [Bugfix][Breaking TS] The price `amount` is now a `number` instead of a `string`.
+  - [Bugfix][Breaking] The `DirectionEnum` values are in lower case. E.g: INBOUND -> inbound.
+  - [Bugfix][Breaking] The price `amount` is now a `number` instead of a `string`.
   - [Feature] Support date range filter for listing calls.
-- [Bugfix][Breaking TS]
+- [Bugfix][Breaking]
   - ACLs: For "create", "update" and "addIPRange" operations, the request bodies interface no longer accept read-only properties.
   - SIP endpoints: For "create" and "update" operations, the request bodies interface no longer accept read-only properties.
   - SIP Trunks: For "create" and "update" operations, the request bodies interface no longer accept read-only properties.

diff --git a/packages/numbers/CHANGELOG.md b/packages/numbers/CHANGELOG.md
@@ -3,27 +3,17 @@
 - [Deprecation notice] `availableNumber` and `activeNumber` subdomain are deprecated and all methods are now defined on the upper numbers service.
    All the methods names are the same except `availableNumber.list()` -> `searchForAvailableNumbers()`
 
-```typescript
-// Deprecated
-numbersService.availableNumber.checkAvailability();
-numbersService.availableNumber.list();
-numbersService.availableNumber.rent();
-numbersService.availableNumber.rentAny();
-numbersService.activeNumber.get();
-numbersService.activeNumber.list();
-numbersService.activeNumber.update();
-numbersService.activeNumber.release();
+| Deprecated                                           | New                                          |
+|------------------------------------------------------|----------------------------------------------|
+| `numbersService.availableNumber.checkAvailability()` | `numbersService.checkAvailability()`         |
+| `numbersService.availableNumber.list()`              | `numbersService.searchForAvailableNumbers()` |
+| `numbersService.availableNumber.rent()`              | `numbersService.rent()`                      |
+| `numbersService.availableNumber.rentAny()`           | `numbersService.rentAny()`                   |
+| `numbersService.activeNumber.get()`                  | `numbersService.get()`                       |
+| `numbersService.activeNumber.list()`                 | `numbersService.list()`                      |
+| `numbersService.activeNumber.update()`               | `numbersService.update()`                    |
+| `numbersService.activeNumber.release()`              | `numbersService.release()`                   |
 
-// New
-numbersService.checkAvailability();
-numbersService.searchForAvailableNumbers(); // Mind the function name change
-numbersService.rent();
-numbersService.rentAny();
-numbersService.get();
-numbersService.list();
-numbersService.update();
-numbersService.release();
-```
 - [E2E] Add Cucumber steps implementation.
 
 ## Version 1.1.0

diff --git a/packages/verification/CHANGELOG.md b/packages/verification/CHANGELOG.md
@@ -49,17 +49,11 @@
 | SMSVerificationReportResponse | SmsVerificationReportResponse |
 
 - [Deprecation Notice] The type `VerificationCallback` becomes `VerificationCallbackEvent` and is accessible on the `Verification` namespace.
-```typescript
-// Deprecated
-handleEvent(event: VerificationCallback, res: Response) {
-  console.log(event);
-}
 
-// New
-handleEvent(event: Verification.VerificationCallbackEvent, res: Response) {
-  console.log(event);
-}
-```
+| Deprecated                                                                                                                  | New                                                                                                                                           |
+|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| <pre><code>handleEvent(event: VerificationCallback, res: Response) {<br/>&nbsp;&nbsp;console.log(event);<br/>}</code></pre> | <pre><code>handleEvent(event: Verification.VerificationCallbackEvent, res: Response) {<br/>&nbsp;&nbsp;console.log(event);<br/>}</code></pre> |
+
 - [Deprecation Notice] The type `TypeEnum` should be replaced with the type `IdentityType`.
 - [Deprecation Notice] The type `FlashCallContent` should be replaced with the type `FlashCallProperties`.
 - [Deprecation Notice] The type `SmsContent` should be replaced with the type `SmsProperties`.

diff --git a/packages/voice/CHANGELOG.md b/packages/voice/CHANGELOG.md
@@ -1,19 +1,13 @@
 ## Version 1.2.0
 - [Tech] Update dependency `@sinch/sdk-client` to `1.2.0`.
 - [Feature] In the interface `Participant`, the property `type` defines a list of string values on top of a generic string.
-- [Breaking TS] In the interface `ConferenceCalloutRequest`, the property `mohClass` was declared as a `string` and is now a `MusicOnHold` type;
+- [Breaking] In the interface `ConferenceCalloutRequest`, the property `mohClass` was declared as a `string` and is now a `MusicOnHold` type;
 - [Deprecation Notice] The type `VoiceCallback` becomes `VoiceCallbackEvent` and is accessible on the `Voice` namespace.
-```typescript
-// Deprecated
-handleEvent(event: VoiceCallback, res: Response) {
-  console.log(event);
-}
-
-// New
-handleEvent(event: Voice.VoiceCallbackEvent, res: Response) {
-  console.log(event);
-}
-```
+
+| Deprecated                                                                                                           | New                                                                                                                             |
+|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| <pre><code>handleEvent(event: VoiceCallback, res: Response) {<br/>&nbsp;&nbsp;console.log(event);<br/>}</code></pre> | <pre><code>handleEvent(event: Voice.VoiceCallbackEvent, res: Response) {<br/>&nbsp;&nbsp;console.log(event);<br/>}</code></pre> |
+
 - [E2E] Add Cucumber steps implementation.
 
 ## Version 1.1.0