From e02dfa033bae1df4bdecfa0bef4e729c96241612 Mon Sep 17 00:00:00 2001 From: Shawn Stern Date: Wed, 18 Jan 2023 11:48:37 -0800 Subject: [PATCH 1/5] docs: add relevant Refer/Say/ssml links to upgrade guide; formatting --- UPGRADE.md | 74 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 42 insertions(+), 32 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index bced5763bd..783a2346d8 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -2,8 +2,9 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ -[2023-01-25] 3.x.x to 4.x.x ------------------------------ +## [2023-01-25] 3.x.x to 4.x.x + +--- * Supported Node.js versions updated * Upgrade to Node.js >= 14 @@ -11,38 +12,45 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ * Added support for Node.js 18 ([#794](https://github.com/twilio/twilio-node/pull/794)) * Lazy loading enabled by default ([#752](https://github.com/twilio/twilio-node/pull/752)) * Required Twilio modules now lazy load by default - * See the [README](README.md) for how to disable lazy loading + * See the [README](README.md#lazy-loading) for how to disable lazy loading * Type changes from `object` to `Record` ([#873](https://github.com/twilio/twilio-node/pull/873)) * Certain response properties now use the `Record` type with `string` keys * Including the `subresourceUris` property for v2010 APIs and the `links` properties for non-v2010 APIs -* Creating an AccessToken requires an `identity` in the options ([#875](https://github.com/twilio/twilio-node/pull/875)) -* JWT token building deprecations +* Access Tokens + * Creating an [AccessToken](https://www.twilio.com/docs/iam/access-tokens) requires an `identity` in the options ([#875](https://github.com/twilio/twilio-node/pull/875)) * `ConversationsGrant` has been deprecated in favor of `VoiceGrant` ([#783](https://github.com/twilio/twilio-node/pull/783)) * `IpMessagingGrant` has been removed ([#784](https://github.com/twilio/twilio-node/pull/784)) * TwiML function deprecations ([#788](https://github.com/twilio/twilio-node/pull/788)) - * `Refer.referSip()` replaced by `Refer.sip()` - * `ssmlBreak()` replaced by `break_()` - * `ssmlEmphasis()` replaced by `emphasis()` - * `ssmlLang()` replaced by `lang()` - * `ssmlP()` replaced by `p()` - * `ssmlPhoneme()` replaced by `phoneme()` - * `ssmlProsody()` replaced by `prosody()` - * `ssmlS()` replaced by `s()` - * `ssmlSayAs()` replaced by `sayAs()` - * `ssmlSub()` replaced by `sub()` - * `ssmlW()` replaced by `w()` - * Old: - ```js - const response = new VoiceResponse(); - const say = response.say("Hello"); - say.ssmlEmphasis("you"); - ``` - * New: - ```js - const response = new VoiceResponse(); - const say = response.say("Hello"); - say.emphasis("you"); - ``` + * [``](https://www.twilio.com/docs/voice/twiml/refer) + * `Refer.referSip()` replaced by `Refer.sip()` + * [``](https://www.twilio.com/docs/voice/twiml/say/text-speech#generating-ssml-via-helper-libraries) + * `Say.ssmlBreak()` replaced by `Say.break_()` + * `Say.ssmlEmphasis()` replaced by `Say.emphasis()` + * `Say.ssmlLang()` replaced by `Say.lang()` + * `Say.ssmlP()` replaced by `Say.p()` + * `Say.ssmlPhoneme()` replaced by `Say.phoneme()` + * `Say.ssmlProsody()` replaced by `Say.prosody()` + * `Say.ssmlS()` replaced by `Say.s()` + * `Say.ssmlSayAs()` replaced by `Say.sayAs()` + * `Say.ssmlSub()` replaced by `Say.sub()` + * `Say.ssmlW()` replaced by `Say.w()` + + Old: + + ```js + const response = new VoiceResponse(); + const say = response.say("Hello"); + say.ssmlEmphasis("you"); + ``` + + New: + + ```js + const response = new VoiceResponse(); + const say = response.say("Hello"); + say.emphasis("you"); + ``` + * TaskRouter Workers Statistics operations updated ([#820](https://github.com/twilio/twilio-node/pull/820)) * Cumulative and Real-Time Workers Statistics no longer accept a WorkerSid * `GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics` @@ -52,11 +60,13 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ * Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).realTimeStatistics()` * New: `client.taskrouter.v1.workspaces('WS...').workers.realTimeStatistics()` -[2017-05-22] 3.1.x to 3.2.x ---------------------------- +## [2017-05-22] 3.1.x to 3.2.x + +--- ### CHANGED - Rename video room `Recordings` class to `RoomRecordings` #### Rationale -- This was done to avoid a class name conflict with another resource. -- Client code should be unaffected unless you manipulate the Recording/RoomRecordings class directly. Accessing room recording metadata via the client should work the same way as before. + +* This was done to avoid a class name conflict with another resource. +* Client code should be unaffected unless you manipulate the Recording/RoomRecordings class directly. Accessing room recording metadata via the client should work the same way as before. From 4f4fc8b75fab942b7e6095496ba5b918f85f57a7 Mon Sep 17 00:00:00 2001 From: Shawn Stern Date: Wed, 18 Jan 2023 11:58:46 -0800 Subject: [PATCH 2/5] docs: doc link and formatting for TaskRouter 4.x changes --- UPGRADE.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index 783a2346d8..19d40bc916 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -51,14 +51,18 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ say.emphasis("you"); ``` -* TaskRouter Workers Statistics operations updated ([#820](https://github.com/twilio/twilio-node/pull/820)) +* [TaskRouter Workers Statistics](https://www.twilio.com/docs/taskrouter/api/worker/statistics) operations updated ([#820](https://github.com/twilio/twilio-node/pull/820)) * Cumulative and Real-Time Workers Statistics no longer accept a WorkerSid * `GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics` - * Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).cumulativeStatistics()` - * New: `client.taskrouter.v1.workspaces('WS...').workers.cumulativeStatistics()` + + Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).cumulativeStatistics()` + + New: `client.taskrouter.v1.workspaces('WS...').workers.cumulativeStatistics()` * `GET /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics` - * Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).realTimeStatistics()` - * New: `client.taskrouter.v1.workspaces('WS...').workers.realTimeStatistics()` + + Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).realTimeStatistics()` + + New: `client.taskrouter.v1.workspaces('WS...').workers.realTimeStatistics()` ## [2017-05-22] 3.1.x to 3.2.x From 8d998e39616329db0e34e91238912d647fce097f Mon Sep 17 00:00:00 2001 From: Shawn Stern Date: Wed, 18 Jan 2023 15:22:46 -0800 Subject: [PATCH 3/5] docs: test adding a disclaimer to deprecations --- UPGRADE.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/UPGRADE.md b/UPGRADE.md index 19d40bc916..9ceb075700 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -51,6 +51,9 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ say.emphasis("you"); ``` + **Note** + These TwiML methods were deprecated in 2019, so you may already be using the updated methods. This change removes the previously-deprecated methods from twilio-node entirely. + * [TaskRouter Workers Statistics](https://www.twilio.com/docs/taskrouter/api/worker/statistics) operations updated ([#820](https://github.com/twilio/twilio-node/pull/820)) * Cumulative and Real-Time Workers Statistics no longer accept a WorkerSid * `GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics` From fe3b34baf3e0b426ac41d122b84057af793d6e8f Mon Sep 17 00:00:00 2001 From: Shawn Stern Date: Wed, 18 Jan 2023 15:25:10 -0800 Subject: [PATCH 4/5] Revert "docs: test adding a disclaimer to deprecations" This reverts commit 8d998e39616329db0e34e91238912d647fce097f. --- UPGRADE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index 9ceb075700..19d40bc916 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -51,9 +51,6 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ say.emphasis("you"); ``` - **Note** - These TwiML methods were deprecated in 2019, so you may already be using the updated methods. This change removes the previously-deprecated methods from twilio-node entirely. - * [TaskRouter Workers Statistics](https://www.twilio.com/docs/taskrouter/api/worker/statistics) operations updated ([#820](https://github.com/twilio/twilio-node/pull/820)) * Cumulative and Real-Time Workers Statistics no longer accept a WorkerSid * `GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics` From 02cb01f0675c1214544297d35db9d8ad1cee0ad3 Mon Sep 17 00:00:00 2001 From: childish-sambino Date: Thu, 19 Jan 2023 12:13:33 -0600 Subject: [PATCH 5/5] Update UPGRADE.md --- UPGRADE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/UPGRADE.md b/UPGRADE.md index 19d40bc916..6bc0f23e38 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -24,7 +24,7 @@ _All `MAJOR` version bumps will have upgrade notes posted here._ * [``](https://www.twilio.com/docs/voice/twiml/refer) * `Refer.referSip()` replaced by `Refer.sip()` * [``](https://www.twilio.com/docs/voice/twiml/say/text-speech#generating-ssml-via-helper-libraries) - * `Say.ssmlBreak()` replaced by `Say.break_()` + * `Say.ssmlBreak()` replaced by `Say.break()` * `Say.ssmlEmphasis()` replaced by `Say.emphasis()` * `Say.ssmlLang()` replaced by `Say.lang()` * `Say.ssmlP()` replaced by `Say.p()`