Skip to content

Commit 8fcb6ac

Browse files
authored
docs: update UPGRADE.md to include resource links for Voice TwiML changes; apply markdownlint (#677)
Updates the UPGRADE.md doc to provide docs links to relevant resources for changes that could be confusing to customers. Fixes markdownlint warnings.
1 parent 39fc5fe commit 8fcb6ac

File tree

1 file changed

+71
-48
lines changed

1 file changed

+71
-48
lines changed

UPGRADE.md

Lines changed: 71 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,96 +3,118 @@
33
_`MAJOR` version bumps will have upgrade notes
44
posted here._
55

6-
[2023-03-22] 7.x.x to 8.x.x
7-
---------------------------
6+
## [2023-03-22] 7.x.x to 8.x.x
87

98
- **Supported Python versions updated**
10-
- Dropped support for Python 3.6 (https://github.com/twilio/twilio-python/pull/632)
11-
- Python 3.7 is the new required minimum version to use twilio-python helper library
12-
- **Deletion of TwiML Voice Deprecated Methods (https://github.com/twilio/twilio-python/pull/643)**
9+
- Dropped support for Python 3.6 ([#632](https://github.com/twilio/twilio-python/pull/632))
10+
- Python 3.7 is the new required minimum version to use twilio-python helper library
11+
- **Deletion of TwiML Voice Deprecated Methods ([#643](https://github.com/twilio/twilio-python/pull/643))**
12+
13+
- [`<Refer>`](https://www.twilio.com/docs/voice/twiml/refer)
1314
- `Refer.refer_sip()` replaced by `Refer.sip()`
14-
- `ssml_break()` replaced by `break_()`
15-
- `ssml_emphasis()` replaced by `emphasis()`
16-
- `ssml_lang()` replaced by `lang()`
17-
- `ssml_p()` replaced by `p()`
18-
- `ssml_phoneme()` replaced by `phoneme()`
19-
- `ssml_prosody()` replaced by `prosody()`
20-
- `ssml_s()` replaced by `s()`
21-
- `ssml_say_as()` replaced by `say_as()`
22-
- `ssml_sub()` replaced by `sub()`
23-
- `ssml_w()` replaced by `w()`
24-
- **Old:**
15+
- [`<Say>`](https://www.twilio.com/docs/voice/twiml/say/text-speech#generating-ssml-via-helper-libraries)
16+
17+
- `Say.ssml_break()` replaced by `Say.break_()`
18+
- `Say.ssml_emphasis()` replaced by `Say.emphasis()`
19+
- `Say.ssml_lang()` replaced by `Say.lang()`
20+
- `Say.ssml_p()` replaced by `Say.p()`
21+
- `Say.ssml_phoneme()` replaced by `Say.phoneme()`
22+
- `Say.ssml_prosody()` replaced by `Say.prosody()`
23+
- `Say.ssml_s()` replaced by `Say.s()`
24+
- `Say.ssml_say_as()` replaced by `Say.say_as()`
25+
- `Say.ssml_sub()` replaced by `Say.sub()`
26+
- `Say.ssml_w()` replaced by `Say.w()`
27+
28+
Old:
29+
2530
```python
2631
from twilio.twiml.voice_response import VoiceResponse
2732
resp = VoiceResponse()
2833
say = resp.say("Hello")
2934
say.ssml_emphasis("you")
3035
```
31-
- **New:**
36+
37+
New:
38+
3239
```python
3340
from twilio.twiml.voice_response import VoiceResponse
3441
resp = VoiceResponse()
3542
say = resp.say("Hello")
3643
say.emphasis("you")
3744
```
38-
- **JWT token building deprecations (https://github.com/twilio/twilio-python/pull/644)**
39-
- `ConversationsGrant` has been deprecated in favor of `VoiceGrant`
40-
- `IpMessagingGrant` has been removed
45+
46+
- **JWT token building deprecations ([#644](https://github.com/twilio/twilio-python/pull/644))**
47+
- `ConversationsGrant` has been deprecated in favor of `VoiceGrant`
48+
- `IpMessagingGrant` has been removed
4149
- `twilio.rest.api.v2010.account.available_phone_number` has been renamed to `twilio.rest.api.v2010.account.available_phone_number_country`
42-
- **[TaskRouter Workers Statistics](https://www.twilio.com/docs/taskrouter/api/worker/statistics) operations updated (https://github.com/twilio/twilio-python/pull/653)**
43-
- Cumulative and Real-Time Workers Statistics no longer accept a WorkerSid
44-
- `GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics`
45-
- Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).cumulativeStatistics()`
46-
- New: `client.taskrouter.v1.workspaces('WS...').workers.cumulativeStatistics()`
47-
- `GET /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics`
48-
- Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).realTimeStatistics()`
49-
- New: `client.taskrouter.v1.workspaces('WS...').workers.realTimeStatistics()`
50-
51-
[2021-09-22] 6.x.x to 7.x.x
52-
---------------------------
50+
- **[TaskRouter Workers Statistics](https://www.twilio.com/docs/taskrouter/api/worker/statistics) operations updated ([#653](https://github.com/twilio/twilio-python/pull/653))**
51+
52+
- Cumulative and Real-Time Workers Statistics no longer accept a WorkerSid
53+
- `GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics`
54+
55+
Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).cumulativeStatistics()`
56+
57+
New: `client.taskrouter.v1.workspaces('WS...').workers.cumulativeStatistics()`
58+
59+
- `GET /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics`
60+
61+
Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).realTimeStatistics()`
62+
63+
New: `client.taskrouter.v1.workspaces('WS...').workers.realTimeStatistics()`
64+
65+
## [2021-09-22] 6.x.x to 7.x.x
66+
5367
### Overview
68+
5469
Version `7.x.x` is the first version that officially drops support for Python versions 2.7, 3.4, and 3.5.
55-
#### Removal of files and dependencies that were added to support Python 2.7, 3.4, and 3.5:
70+
71+
#### Removal of files and dependencies that were added to support Python 2.7, 3.4, and 3.5
72+
5673
- [Six](https://github.com/twilio/twilio-python/pull/560/files#diff-4d7c51b1efe9043e44439a949dfd92e5827321b34082903477fd04876edb7552L4)
57-
- Removed use of `u` a fake unicode literal
58-
- Removed use of `b` a fake bytes literal
59-
- Removed `PY3` a boolean indicating if the code is running on Python 3
60-
- `text_type` type for representing (Unicode) textual data --> `str`
61-
- `iteritems` returns an iterator over dictionary’s items --> `items`
62-
- `string_types` possible types for text data like basestring() in Python 2 and str in Python 3.--> `str`
74+
- Removed use of `u` a fake unicode literal
75+
- Removed use of `b` a fake bytes literal
76+
- Removed `PY3` a boolean indicating if the code is running on Python 3
77+
- `text_type` type for representing (Unicode) textual data --> `str`
78+
- `iteritems` returns an iterator over dictionary’s items --> `items`
79+
- `string_types` possible types for text data like basestring() in Python 2 and str in Python 3.--> `str`
6380
- [twilio/compat.py](https://github.com/twilio/twilio-python/pull/560/files?file-filters%5B%5D=.md&file-filters%5B%5D=.py&file-filters%5B%5D=.toml&file-filters%5B%5D=.txt&file-filters%5B%5D=.yml&file-filters%5B%5D=No+extension#diff-e327449701a8717c94e1a084cdfc7dbf334c634cddf3867058b8f991d2de52c1L1)
64-
- `from twilio.compat import urlencode` --> `from urllib.parse import urlencode`
65-
- `izip` --> `zip`
81+
- `from twilio.compat import urlencode` --> `from urllib.parse import urlencode`
82+
- `izip` --> `zip`
6683
- [twilio/jwt/compat.py](https://github.com/twilio/twilio-python/pull/560/files?file-filters%5B%5D=.md&file-filters%5B%5D=.py&file-filters%5B%5D=.toml&file-filters%5B%5D=.txt&file-filters%5B%5D=.yml&file-filters%5B%5D=No+extension#diff-03276a6bdd4ecdf37ab6bedf60032dd05f640e1b470e4353badc787d80ba73d5L1)
67-
- Removed `compat.compare_digest`
68-
- [twilio/jwt/__init__.py](https://github.com/twilio/twilio-python/pull/560/files?file-filters%5B%5D=.ini&file-filters%5B%5D=.py&file-filters%5B%5D=.yml#diff-9152dd65476e69cc34a307781d5cef195070f48da5670ed0934fd34a9ac91150L12-L16)
69-
- Removed import for `simplejson` and `json`
84+
- Removed `compat.compare_digest`
85+
- [twilio/jwt/**init**.py](https://github.com/twilio/twilio-python/pull/560/files?file-filters%5B%5D=.ini&file-filters%5B%5D=.py&file-filters%5B%5D=.yml#diff-9152dd65476e69cc34a307781d5cef195070f48da5670ed0934fd34a9ac91150L12-L16)
86+
- Removed import for `simplejson` and `json`
7087
7188
#### Updated dependencies
89+
7290
- [Updated PyJWT to >=2.0.0](https://github.com/twilio/twilio-python/pull/560/files#diff-4d7c51b1efe9043e44439a949dfd92e5827321b34082903477fd04876edb7552L6)
7391
74-
### CHANGED - [Remove the ability to override the `algorithm` in `Jwt.to_jwt()`](https://github.com/twilio/twilio-python/pull/560/commits/dab158f429015e0894217d6503f55b517c27c474).
75-
#### Removed the ability to override the algorithm while using a jwt access token:
92+
### CHANGED - [Remove the ability to override the `algorithm` in `Jwt.to_jwt()`](https://github.com/twilio/twilio-python/pull/560/commits/dab158f429015e0894217d6503f55b517c27c474)
93+
94+
#### Removed the ability to override the algorithm while using a jwt access token
95+
7696
```python
7797
// 6.x.x
7898
from twilio.jwt.access_token import AccessToken
7999
token.to_jwt(algorithm='HS512')
80100
```
101+
81102
```python
82103
// 7.x.x
83104
from twilio.jwt.access_token import AccessToken
84105
token.to_jwt()
85106
```
86107
87-
[2017-09-28] 6.6.x to 6.7.x
88-
---------------------------
108+
## [2017-09-28] 6.6.x to 6.7.x
89109
90-
### CHANGED - `Body` parameter on Chat `Message` creation is no longer required.
110+
### CHANGED - `Body` parameter on Chat `Message` creation is no longer required
91111
92112
#### Rationale
113+
93114
This was changed to add support for sending media in Chat messages, users can now either provide a `body` or a `media_sid`.
94115
95116
#### 6.6.x
117+
96118
```python
97119
from twilio.rest import Client
98120
@@ -101,6 +123,7 @@ client.chat.v2.services('IS123').channels('CH123').messages.create("this is the
101123
```
102124
103125
#### 6.7.x
126+
104127
```python
105128
from twilio.rest import Client
106129

0 commit comments

Comments
 (0)