feat!: Merge branch '8.0.0-rc' to main

.github/workflows/test-and-deploy.yml

@@ -13,17 +13,11 @@ on:
 jobs:
   test:
     name: Test
+    runs-on: ubuntu-latest
     timeout-minutes: 20
     strategy:
       matrix:
         python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
-        os: [ubuntu-latest]
-        # Need to pin ubuntu version for python 3.6 (see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877)
-        # Change this to use ubuntu-latest for all python versions after deprecating python 3.6
-        include:
-          - python-version: '3.6'
-            os: 'ubuntu-20.04'
-    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout twilio-python
         uses: actions/checkout@v3
@@ -43,6 +37,17 @@ jobs:
       - name: Run the tests
         run: make test-with-coverage
 
+      - name: Run Cluster Tests
+        if: (!github.event.pull_request.head.repo.fork)
+        env:
+          TWILIO_ACCOUNT_SID: ${{ secrets.TWILIO_ACCOUNT_SID }}
+          TWILIO_API_KEY: ${{ secrets.TWILIO_CLUSTER_TEST_API_KEY}}
+          TWILIO_API_SECRET: ${{ secrets.TWILIO_CLUSTER_TEST_API_KEY_SECRET }}
+          TWILIO_FROM_NUMBER: ${{ secrets.TWILIO_FROM_NUMBER }}
+          TWILIO_TO_NUMBER: ${{ secrets.TWILIO_TO_NUMBER }}
+          TWILIO_AUTH_TOKEN: ${{ secrets.TWILIO_AUTH_TOKEN }}
+        run: make cluster-test
+
       - name: Verify docs generation
         run: make docs
 

.gitignore

@@ -38,3 +38,5 @@ docs/source/_rst
 .python-version
 
 README.md.bak
+
+**/.openapi-generator*

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.6
+FROM python:3.7
 
 ENV PYTHONUNBUFFERED 1
 

Makefile

@@ -1,7 +1,7 @@
-.PHONY: clean install analysis test test-install test-docker develop docs docs-install
+.PHONY: clean install analysis test test-install test-docker develop docs docs-install prettier prettier-check
 
 venv:
-	@python --version || (echo "Python is not installed, Python 3.6+"; exit 1);
+	@python --version || (echo "Python is not installed, Python 3.7+"; exit 1);
 	virtualenv --python=python venv
 
 install: venv
@@ -12,23 +12,25 @@ test-install: install
 
 test-docker:
 	docker build -t twilio/twilio-python .
-	docker run twilio/twilio-python pytest tests
+	docker run twilio/twilio-python pytest tests --ignore=tests/cluster
 
 develop: venv
 	. venv/bin/activate; pip install -e . --use-mirrors
 	. venv/bin/activate; pip install -r tests/requirements.txt
 
 analysis:
-	. venv/bin/activate; flake8 --ignore=E123,E126,E128,E501,W391,W291,W293,F401 tests
-	. venv/bin/activate; flake8 --ignore=E402,F401,W391,W291,W293 twilio --max-line-length=300
+	. venv/bin/activate; flake8 --ignore=E123,E126,E128,E501,W391,W291,W293,F401,W503,E203 tests
+	. venv/bin/activate; flake8 --ignore=E402,F401,W391,W291,W293,W503,E203 twilio --max-line-length=300
 
-test: analysis
-	. venv/bin/activate; pytest tests
+test: analysis prettier-check
+	. venv/bin/activate; pytest tests --ignore=tests/cluster
 
-test-with-coverage:
+test-with-coverage: prettier-check
 	. venv/bin/activate; \
-  pytest --cov=twilio tests; \
-  coverage xml --omit 'twilio/rest/*' -o coverage.xml
+  	pytest --cov-config=setup.cfg --cov-report xml --cov=twilio tests --ignore=tests/cluster
+
+cluster-test:
+	. venv/bin/activate; pytest tests/cluster
 
 docs-install:
 	. venv/bin/activate; pip install -r tests/requirements.txt
@@ -54,6 +56,14 @@ clean:
 nopyc:
 	find . -name \*.pyc -delete
 
+prettier:
+	. venv/bin/activate; autoflake --remove-all-unused-imports -i -r --exclude venv .
+	. venv/bin/activate; black .
+
+prettier-check:
+	. venv/bin/activate; autoflake --check-diff --quiet --remove-all-unused-imports -r --exclude venv .
+	. venv/bin/activate; black --check .
+
 API_DEFINITIONS_SHA=$(shell git log --oneline | grep Regenerated | head -n1 | cut -d ' ' -f 5)
 CURRENT_TAG=$(shell expr "${GITHUB_TAG}" : ".*-rc.*" >/dev/null && echo "rc" || echo "latest")
 docker-build:

README.md

@@ -23,7 +23,6 @@ Please consult the [official migration guide](https://www.twilio.com/docs/librar
 
 This library supports the following Python implementations:
 
-* Python 3.6
 * Python 3.7
 * Python 3.8
 * Python 3.9
@@ -59,15 +58,26 @@ Getting started with the Twilio API couldn't be easier. Create a
 
 ### API Credentials
 
-The `Twilio` needs your Twilio credentials. You can either pass these
+The `Twilio` client needs your Twilio credentials. You can either pass these
 directly to the constructor (see the code below) or via environment variables.
 
+Authenticating with Account SID and Auth Token:
 ```python
 from twilio.rest import Client
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+account_sid = "ACXXXXXXXXXXXXXXXXX"
+auth_token = "YYYYYYYYYYYYYYYYYY"
+client = Client(account_sid, auth_token)
+```
+
+Authenticating with API Key and API Secret:
+```python
+from twilio.rest import Client
+
+api_key = "XXXXXXXXXXXXXXXXX"
+api_secret = "YYYYYYYYYYYYYYYYYY"
+account_sid = "ACXXXXXXXXXXXXXXXXX"
+client = Client(api_key, api_secret, account_sid)
 ```
 
 Alternatively, a `Client` constructor without these parameters will
@@ -112,9 +122,9 @@ This will result in the `hostname` transforming from `api.twilio.com` to `api.sy
 ```python
 from twilio.rest import Client
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+username = "ACXXXXXXXXXXXXXXXXX"
+password = "YYYYYYYYYYYYYYYYYY"
+client = Client(username, password)
 
 call = client.calls.create(to="9991231234",
                            from_="9991231234",
@@ -127,22 +137,42 @@ print(call.sid)
 ```python
 from twilio.rest import Client
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+username = "ACXXXXXXXXXXXXXXXXX"
+password = "YYYYYYYYYYYYYYYYYY"
+client = Client(username, password)
 
 message = client.messages.create(to="+12316851234", from_="+15555555555",
                                  body="Hello there!")
 ```
 
+### Asynchronous API Requests
+
+By default, the Twilio Client will make synchronous requests to the Twilio API. To allow for asynchronous, non-blocking requests, we've included an optional asynchronous HTTP client. When used with the Client and the accompanying `*_async` methods, requests made to the Twilio API will be performed asynchronously.
+
+```python
+from twilio.http.async_http_client import AsyncTwilioHttpClient
+from twilio.rest import Client
+
+async def main():
+    username = "ACXXXXXXXXXXXXXXXXX"
+    password = "YYYYYYYYYYYYYYYYYY"
+    http_client = AsyncTwilioHttpClient()
+    client = Client(username, password, http_client=http_client)
+
+    message = await client.messages.create_async(to="+12316851234", from_="+15555555555",
+                                                 body="Hello there!")
+
+asyncio.run(main())
+```
+
 ### Enable Debug Logging
 
 Log the API request and response data to the console:
 
 ```python
 import logging
 
-client = Client(account, token)
+client = Client(username, password)
 logging.basicConfig()
 client.http_client.logger.setLevel(logging.INFO)
 ```
@@ -152,7 +182,7 @@ Log the API request and response data to a file:
 ```python
 import logging
 
-client = Client(account, token)
+client = Client(username, password)
 logging.basicConfig(filename='./log.txt')
 client.http_client.logger.setLevel(logging.INFO)
 ```
@@ -163,9 +193,9 @@ client.http_client.logger.setLevel(logging.INFO)
 from twilio.rest import Client
 from twilio.base.exceptions import TwilioRestException
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+username = "ACXXXXXXXXXXXXXXXXX"
+password = "YYYYYYYYYYYYYYYYYY"
+client = Client(username, password)
 
 try:
   message = client.messages.create(to="+12316851234", from_="+15555555555",

UPGRADE.md

@@ -3,51 +3,122 @@
 _`MAJOR` version bumps will have upgrade notes
 posted here._
 
-[2021-09-22] 6.x.x to 7.x.x
----------------------------
+## [2023-04-05] 7.x.x to 8.x.x
+
+- **Supported Python versions updated**
+  - Dropped support for Python 3.6 ([#632](https://github.com/twilio/twilio-python/pull/632))
+  - Python 3.7 is the new required minimum version to use twilio-python helper library
+- **Deletion of TwiML Voice Deprecated Methods ([#643](https://github.com/twilio/twilio-python/pull/643))**
+
+  - [`<Refer>`](https://www.twilio.com/docs/voice/twiml/refer)
+    - `Refer.refer_sip()` replaced by `Refer.sip()`
+  - [`<Say>`](https://www.twilio.com/docs/voice/twiml/say/text-speech#generating-ssml-via-helper-libraries)
+
+    - `Say.ssml_break()` replaced by `Say.break_()`
+    - `Say.ssml_emphasis()` replaced by `Say.emphasis()`
+    - `Say.ssml_lang()` replaced by `Say.lang()`
+    - `Say.ssml_p()` replaced by `Say.p()`
+    - `Say.ssml_phoneme()` replaced by `Say.phoneme()`
+    - `Say.ssml_prosody()` replaced by `Say.prosody()`
+    - `Say.ssml_s()` replaced by `Say.s()`
+    - `Say.ssml_say_as()` replaced by `Say.say_as()`
+    - `Say.ssml_sub()` replaced by `Say.sub()`
+    - `Say.ssml_w()` replaced by `Say.w()`
+
+    Old:
+
+    ```python
+    from twilio.twiml.voice_response import VoiceResponse
+    resp = VoiceResponse()
+    say = resp.say("Hello")
+    say.ssml_emphasis("you")
+    ```
+
+    New:
+
+    ```python
+    from twilio.twiml.voice_response import VoiceResponse
+    resp = VoiceResponse()
+    say = resp.say("Hello")
+    say.emphasis("you")
+    ```
+
+- **JWT token building deprecations ([#644](https://github.com/twilio/twilio-python/pull/644))**
+  - `ConversationsGrant` has been deprecated in favor of `VoiceGrant`
+  - `IpMessagingGrant` has been removed
+- `twilio.rest.api.v2010.account.available_phone_number` has been renamed to `twilio.rest.api.v2010.account.available_phone_number_country`
+- **[TaskRouter Workers Statistics](https://www.twilio.com/docs/taskrouter/api/worker/statistics) operations updated ([#653](https://github.com/twilio/twilio-python/pull/653))**
+
+  - 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...).cumulative_statistics()`
+
+    New: `client.taskrouter.v1.workspaces('WS...').workers.cumulative_statistics()`
+
+  - `GET /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics`
+
+    Old: `client.taskrouter.v1.workspaces('WS...').workers('WK...).real_time_statistics()`
+
+    New: `client.taskrouter.v1.workspaces('WS...').workers.real_time_statistics()`
+
+- **Internal refactor of `instance._properties`**
+  - Instance properties moved out of the generic `_properties` dict ([#696](https://github.com/twilio/twilio-python/pull/696))
+  - This is an implementation detail that should not be depended upon
+
+## [2021-09-22] 6.x.x to 7.x.x
+
 ### Overview
+
 Version `7.x.x` is the first version that officially drops support for Python versions 2.7, 3.4, and 3.5.
-#### Removal of files and dependencies that were added to support Python 2.7, 3.4, and 3.5:
+
+#### Removal of files and dependencies that were added to support Python 2.7, 3.4, and 3.5
+
 - [Six](https://github.com/twilio/twilio-python/pull/560/files#diff-4d7c51b1efe9043e44439a949dfd92e5827321b34082903477fd04876edb7552L4)
-    - Removed use of `u` a fake unicode literal
-    - Removed use of `b` a fake bytes literal
-    - Removed `PY3` a boolean indicating if the code is running on Python 3
-    - `text_type` type for representing (Unicode) textual data --> `str`
-    - `iteritems` returns an iterator over dictionary’s items --> `items`
-    - `string_types` possible types for text data like basestring() in Python 2 and str in Python 3.--> `str`
+  - Removed use of `u` a fake unicode literal
+  - Removed use of `b` a fake bytes literal
+  - Removed `PY3` a boolean indicating if the code is running on Python 3
+  - `text_type` type for representing (Unicode) textual data --> `str`
+  - `iteritems` returns an iterator over dictionary’s items --> `items`
+  - `string_types` possible types for text data like basestring() in Python 2 and str in Python 3.--> `str`
 - [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)
-    - `from twilio.compat import urlencode` --> `from urllib.parse import urlencode`
-    - `izip` --> `zip`
+  - `from twilio.compat import urlencode` --> `from urllib.parse import urlencode`
+  - `izip` --> `zip`
 - [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)
-    - Removed `compat.compare_digest`
-- [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)
-    - Removed import for `simplejson` and `json`
+  - Removed `compat.compare_digest`
+- [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)
+  - Removed import for `simplejson` and `json`
 
 #### Updated dependencies
+
 - [Updated PyJWT to >=2.0.0](https://github.com/twilio/twilio-python/pull/560/files#diff-4d7c51b1efe9043e44439a949dfd92e5827321b34082903477fd04876edb7552L6)
 
-### CHANGED - [Remove the ability to override the `algorithm` in `Jwt.to_jwt()`](https://github.com/twilio/twilio-python/pull/560/commits/dab158f429015e0894217d6503f55b517c27c474).
-#### Removed the ability to override the algorithm while using a jwt access token:
+### CHANGED - [Remove the ability to override the `algorithm` in `Jwt.to_jwt()`](https://github.com/twilio/twilio-python/pull/560/commits/dab158f429015e0894217d6503f55b517c27c474)
+
+#### Removed the ability to override the algorithm while using a jwt access token
+
 ```python
 // 6.x.x
 from twilio.jwt.access_token import AccessToken
 token.to_jwt(algorithm='HS512')
 ```
+
 ```python
 // 7.x.x
 from twilio.jwt.access_token import AccessToken
 token.to_jwt()
 ```
 
-[2017-09-28] 6.6.x to 6.7.x
----------------------------
+## [2017-09-28] 6.6.x to 6.7.x
 
-### CHANGED - `Body` parameter on Chat `Message` creation is no longer required.
+### CHANGED - `Body` parameter on Chat `Message` creation is no longer required
 
 #### Rationale
+
 This was changed to add support for sending media in Chat messages, users can now either provide a `body` or a `media_sid`.
 
 #### 6.6.x
+
 ```python
 from twilio.rest import Client
 
@@ -56,6 +127,7 @@ client.chat.v2.services('IS123').channels('CH123').messages.create("this is the
 ```
 
 #### 6.7.x
+
 ```python
 from twilio.rest import Client