## Python SDK Changes:

* `shippo.batches.create()`: 
  *  `request.batch_shipments.[].shipment` **Changed** **Breaking** ⚠️
* `shippo.batches.add_shipments()`: 
  *  `request_body.[].shipment` **Changed** **Breaking** ⚠️
* `shippo.carrier_accounts.register()`:  `request` **Changed** **Breaking** ⚠️
* `shippo.rates_at_checkout.create()`: 
  *  `request.parcel.[parcel].template.[parcel_template_couriers_please_enum]` **Removed** **Breaking** ⚠️
* `shippo.parcels.create()`: 
  *  `request.[parcel_create_from_template_request].template.[parcel_template_couriers_please_enum]` **Removed** **Breaking** ⚠️
  *  `response.template.[parcel_template_couriers_please_enum]` **Removed**
* `shippo.shipments.create()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `response` **Changed**
* `shippo.transactions.create()`: 
  *  `request.[instant_transaction_create_request].shipment` **Changed** **Breaking** ⚠️
* `shippo.carrier_accounts.list()`: 
  *  `request.carrier` **Changed**
* `shippo.parcels.list()`:  `response.results.[].template.[parcel_template_couriers_please_enum]` **Removed**
* `shippo.parcels.get()`:  `response.template.[parcel_template_couriers_please_enum]` **Removed**
* `shippo.shipments.list()`:  `response.results.[]` **Changed**
* `shippo.shipments.get()`:  `response` **Changed**

Author: speakeasybot

.gitignore

@@ -1,3 +1,8 @@
+**/__pycache__/
+**/.speakeasy/temp/
+**/.speakeasy/logs/
+.env
+.env.local
 .venv/
 pyrightconfig.json
 .speakeasy/reports

.speakeasy/gen.lock

@@ -4,28 +4,45 @@ generation:
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: withExample
+    sdkInitStyle: constructor
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
     nameResolutionFeb2025: true
     parameterOrderingFeb2024: true
     requestResponseComponentNamesFeb2024: true
     securityFeb2025: false
+    sharedErrorComponentsApr2025: false
   auth:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
+    hoistGlobalSecurity: true
+  schemas:
+    allOfMergeStrategy: shallowMerge
+  requestBodyFieldName: ""
+  persistentEdits: {}
+  tests:
+    generateTests: true
+    generateNewTests: false
+    skipResponseBodyAssertions: false
 python:
-  version: 4.0.0
+  version: 4.1.0
   additionalDependencies:
     dev:
       httpretty: ==1.1.4
       marshmallow: ==3.23.1
       pytest: ==8.3.3
       pytest-asyncio: ==0.25.3
     main: {}
+  allowedRedefinedBuiltins:
+    - id
+    - object
+  asyncMode: both
   authors:
     - Shippo
+  baseErrorName: ShippoError
   clientServerStatusCodesAsErrors: true
+  constFieldCasing: upper
   defaultErrorName: SDKError
   description: Shipping API Python library (USPS, FedEx, UPS and more)
   enableCustomCodeRegions: false
@@ -43,13 +60,20 @@ python:
       operations: models/operations
       shared: models/components
       webhooks: models/webhooks
+  inferUnionDiscriminators: true
   inputModelSuffix: input
   license: MIT License
   maxMethodParams: 3
   methodArguments: require-security-and-request
+  moduleName: ""
+  multipartArrayFormat: legacy
   outputModelSuffix: output
+  packageManager: poetry
   packageName: shippo
+  preApplyUnionDiscriminators: false
   projectUrls: {}
+  pytestFilterWarnings: []
   pytestTimeout: 0
   responseFormat: flat
+  sseFlatResponse: false
   templateVersion: v2

.speakeasy/gen.yaml

@@ -1,19 +1,21 @@
-speakeasyVersion: 1.521.1
+speakeasyVersion: 1.684.0
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:e8ab98342833888dbc4dd20f683ee5fb7791107d8574b8dfabce743bc3675cd0
-        sourceBlobDigest: sha256:8c66d55b10c00886e8fd1f2b6ea6b233bccf17f622fed046dcf302d5da3f91f5
+        sourceRevisionDigest: sha256:e275ce6f8da1c8ae714c70cd579f4df62e737bce483d2e85200465dca1ed5018
+        sourceBlobDigest: sha256:9360f40dbc6ba321253ee21323ba97cafc6f738bd16a762d4d7da5739bf7e798
         tags:
             - latest
-            - speakeasy-sdk-regen-1732493299
+            - speakeasy-sdk-regen-1743448946
             - "2018-02-08"
 targets:
     first-target:
         source: openapi
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:e8ab98342833888dbc4dd20f683ee5fb7791107d8574b8dfabce743bc3675cd0
-        sourceBlobDigest: sha256:8c66d55b10c00886e8fd1f2b6ea6b233bccf17f622fed046dcf302d5da3f91f5
+        sourceRevisionDigest: sha256:e275ce6f8da1c8ae714c70cd579f4df62e737bce483d2e85200465dca1ed5018
+        sourceBlobDigest: sha256:9360f40dbc6ba321253ee21323ba97cafc6f738bd16a762d4d7da5739bf7e798
+        codeSamplesNamespace: openapi-python-code-samples
+        codeSamplesRevisionDigest: sha256:4f3ef5892e043ed125c5d72d4317b792159a4deab2b20e1a9cc2b251f2cd38e3
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -32,5 +34,5 @@ workflow:
                     token: $pypi_token
             codeSamples:
                 registry:
-                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-python-code-samples
                 blocking: false

.speakeasy/workflow.lock

@@ -15,5 +15,5 @@ targets:
                 token: $pypi_token
         codeSamples:
             registry:
-                location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                location: registry.speakeasyapi.dev/shippo/shippo/openapi-python-code-samples
             blocking: false

.speakeasy/workflow.yaml

@@ -47,7 +47,15 @@ Shippo external API.: Use this API to integrate with the Shippo service
 >
 > Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
 
-The SDK can be installed with either *pip* or *poetry* package managers.
+The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
+
+### uv
+
+*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
+
+```bash
+uv add shippo
+```
 
 ### PIP
 
@@ -140,15 +148,13 @@ from shippo.utils import BackoffStrategy, RetryConfig
 
 
 with Shippo(
-    api_key_header="<YOUR_API_KEY_HERE>",
     shippo_api_version="2018-02-08",
+    api_key_header="<YOUR_API_KEY_HERE>",
 ) as s_client:
 
-    res = s_client.addresses.list(,
+    res = s_client.addresses.list(page=1, results=5,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-    assert res is not None
-
     # Handle response
     print(res)
 
@@ -162,13 +168,11 @@ from shippo.utils import BackoffStrategy, RetryConfig
 
 with Shippo(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-    api_key_header="<YOUR_API_KEY_HERE>",
     shippo_api_version="2018-02-08",
+    api_key_header="<YOUR_API_KEY_HERE>",
 ) as s_client:
 
-    res = s_client.addresses.list()
-
-    assert res is not None
+    res = s_client.addresses.list(page=1, results=5)
 
     # Handle response
     print(res)
@@ -294,8 +298,8 @@ from shippo import Shippo
 def main():
 
     with Shippo(
-        api_key_header="<YOUR_API_KEY_HERE>",
         shippo_api_version="2018-02-08",
+        api_key_header="<YOUR_API_KEY_HERE>",
     ) as s_client:
         # Rest of application here...
 
@@ -304,8 +308,8 @@ def main():
 async def amain():
 
     async with Shippo(
-        api_key_header="<YOUR_API_KEY_HERE>",
         shippo_api_version="2018-02-08",
+        api_key_header="<YOUR_API_KEY_HERE>",
     ) as s_client:
         # Rest of application here...
 ```
@@ -344,22 +348,22 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 <details open>
 <summary>Available methods</summary>
 
-### [addresses](docs/sdks/addresses/README.md)
+### [Addresses](docs/sdks/addresses/README.md)
 
 * [list](docs/sdks/addresses/README.md#list) - List all addresses
 * [create](docs/sdks/addresses/README.md#create) - Create a new address
 * [get](docs/sdks/addresses/README.md#get) - Retrieve an address
 * [validate](docs/sdks/addresses/README.md#validate) - Validate an address
 
-### [batches](docs/sdks/batches/README.md)
+### [Batches](docs/sdks/batches/README.md)
 
 * [create](docs/sdks/batches/README.md#create) - Create a batch
 * [get](docs/sdks/batches/README.md#get) - Retrieve a batch
 * [add_shipments](docs/sdks/batches/README.md#add_shipments) - Add shipments to a batch
 * [purchase](docs/sdks/batches/README.md#purchase) - Purchase a batch
 * [remove_shipments](docs/sdks/batches/README.md#remove_shipments) - Remove shipments from a batch
 
-### [carrier_accounts](docs/sdks/carrieraccounts/README.md)
+### [CarrierAccounts](docs/sdks/carrieraccounts/README.md)
 
 * [list](docs/sdks/carrieraccounts/README.md#list) - List all carrier accounts
 * [create](docs/sdks/carrieraccounts/README.md#create) - Create a new carrier account
@@ -369,105 +373,104 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 * [register](docs/sdks/carrieraccounts/README.md#register) - Add a Shippo carrier account
 * [get_registration_status](docs/sdks/carrieraccounts/README.md#get_registration_status) - Get Carrier Registration status
 
-### [carrier_parcel_templates](docs/sdks/carrierparceltemplates/README.md)
+### [CarrierParcelTemplates](docs/sdks/carrierparceltemplates/README.md)
 
 * [list](docs/sdks/carrierparceltemplates/README.md#list) - List all carrier parcel templates
 * [get](docs/sdks/carrierparceltemplates/README.md#get) - Retrieve a carrier parcel templates
 
-### [customs_declarations](docs/sdks/customsdeclarations/README.md)
+### [CustomsDeclarations](docs/sdks/customsdeclarations/README.md)
 
 * [list](docs/sdks/customsdeclarations/README.md#list) - List all customs declarations
 * [create](docs/sdks/customsdeclarations/README.md#create) - Create a new customs declaration
 * [get](docs/sdks/customsdeclarations/README.md#get) - Retrieve a customs declaration
 
-### [customs_items](docs/sdks/customsitems/README.md)
+### [CustomsItems](docs/sdks/customsitems/README.md)
 
 * [list](docs/sdks/customsitems/README.md#list) - List all customs items
 * [create](docs/sdks/customsitems/README.md#create) - Create a new customs item
 * [get](docs/sdks/customsitems/README.md#get) - Retrieve a customs item
 
-### [manifests](docs/sdks/manifests/README.md)
+### [Manifests](docs/sdks/manifests/README.md)
 
 * [list](docs/sdks/manifests/README.md#list) - List all manifests
 * [create](docs/sdks/manifests/README.md#create) - Create a new manifest
 * [get](docs/sdks/manifests/README.md#get) - Retrieve a manifest
 
-### [orders](docs/sdks/orders/README.md)
+### [Orders](docs/sdks/orders/README.md)
 
 * [list](docs/sdks/orders/README.md#list) - List all orders
 * [create](docs/sdks/orders/README.md#create) - Create a new order
 * [get](docs/sdks/orders/README.md#get) - Retrieve an order
 
-### [parcels](docs/sdks/parcels/README.md)
+### [Parcels](docs/sdks/parcels/README.md)
 
 * [list](docs/sdks/parcels/README.md#list) - List all parcels
 * [create](docs/sdks/parcels/README.md#create) - Create a new parcel
 * [get](docs/sdks/parcels/README.md#get) - Retrieve an existing parcel
 
-### [pickups](docs/sdks/pickups/README.md)
+### [Pickups](docs/sdks/pickups/README.md)
 
 * [create](docs/sdks/pickups/README.md#create) - Create a pickup
 
-### [rates](docs/sdks/rates/README.md)
+### [Rates](docs/sdks/rates/README.md)
 
 * [get](docs/sdks/rates/README.md#get) - Retrieve a rate
 * [list_shipment_rates](docs/sdks/rates/README.md#list_shipment_rates) - Retrieve shipment rates
 * [list_shipment_rates_by_currency_code](docs/sdks/rates/README.md#list_shipment_rates_by_currency_code) - Retrieve shipment rates in currency
 
-### [rates_at_checkout](docs/sdks/ratesatcheckout/README.md)
+### [RatesAtCheckout](docs/sdks/ratesatcheckout/README.md)
 
 * [create](docs/sdks/ratesatcheckout/README.md#create) - Generate a live rates request
 * [get_default_parcel_template](docs/sdks/ratesatcheckout/README.md#get_default_parcel_template) - Show current default parcel template
 * [update_default_parcel_template](docs/sdks/ratesatcheckout/README.md#update_default_parcel_template) - Update default parcel template
 * [delete_default_parcel_template](docs/sdks/ratesatcheckout/README.md#delete_default_parcel_template) - Clear current default parcel template
 
-### [refunds](docs/sdks/refunds/README.md)
+### [Refunds](docs/sdks/refunds/README.md)
 
 * [create](docs/sdks/refunds/README.md#create) - Create a refund
 * [list](docs/sdks/refunds/README.md#list) - List all refunds
 * [get](docs/sdks/refunds/README.md#get) - Retrieve a refund
 
-### [service_groups](docs/sdks/servicegroups/README.md)
+### [ServiceGroups](docs/sdks/servicegroups/README.md)
 
 * [list](docs/sdks/servicegroups/README.md#list) - List all service groups
 * [create](docs/sdks/servicegroups/README.md#create) - Create a new service group
 * [update](docs/sdks/servicegroups/README.md#update) - Update an existing service group
 * [delete](docs/sdks/servicegroups/README.md#delete) - Delete a service group
 
-### [shipments](docs/sdks/shipments/README.md)
+### [Shipments](docs/sdks/shipments/README.md)
 
 * [list](docs/sdks/shipments/README.md#list) - List all shipments
 * [create](docs/sdks/shipments/README.md#create) - Create a new shipment
 * [get](docs/sdks/shipments/README.md#get) - Retrieve a shipment
 
-
-### [shippo_accounts](docs/sdks/shippoaccounts/README.md)
+### [ShippoAccounts](docs/sdks/shippoaccounts/README.md)
 
 * [list](docs/sdks/shippoaccounts/README.md#list) - List all Shippo Accounts
 * [create](docs/sdks/shippoaccounts/README.md#create) - Create a Shippo Account
 * [get](docs/sdks/shippoaccounts/README.md#get) - Retrieve a Shippo Account
 * [update](docs/sdks/shippoaccounts/README.md#update) - Update a Shippo Account
 
-### [tracking_status](docs/sdks/trackingstatus/README.md)
+### [TrackingStatus](docs/sdks/trackingstatus/README.md)
 
 * [create](docs/sdks/trackingstatus/README.md#create) - Register a tracking webhook
 * [get](docs/sdks/trackingstatus/README.md#get) - Get a tracking status
 
-### [transactions](docs/sdks/transactions/README.md)
+### [Transactions](docs/sdks/transactions/README.md)
 
 * [list](docs/sdks/transactions/README.md#list) - List all shipping labels
 * [create](docs/sdks/transactions/README.md#create) - Create a shipping label
 * [get](docs/sdks/transactions/README.md#get) - Retrieve a shipping label
 
-### [user_parcel_templates](docs/sdks/userparceltemplates/README.md)
+### [UserParcelTemplates](docs/sdks/userparceltemplates/README.md)
 
 * [list](docs/sdks/userparceltemplates/README.md#list) - List all user parcel templates
 * [create](docs/sdks/userparceltemplates/README.md#create) - Create a new user parcel template
 * [delete](docs/sdks/userparceltemplates/README.md#delete) - Delete a user parcel template
 * [get](docs/sdks/userparceltemplates/README.md#get) - Retrieves a user parcel template
 * [update](docs/sdks/userparceltemplates/README.md#update) - Update an existing user parcel template
 
-### [webhooks](docs/sdks/webhooks/README.md)
+### [Webhooks](docs/sdks/webhooks/README.md)
 
 * [create_webhook](docs/sdks/webhooks/README.md#create_webhook) - Create a new webhook
 * [list_webhooks](docs/sdks/webhooks/README.md#list_webhooks) - List all webhooks

README-PYPI.md

@@ -398,4 +398,14 @@ Based on:
 ### Generated
 - [python v3.9.0] .
 ### Releases
-- [PyPI v3.9.0] https://pypi.org/project/shippo/3.9.0 - .
+- [PyPI v3.9.0] https://pypi.org/project/shippo/3.9.0 - .
+
+## 2026-01-12 00:11:04
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.684.0 (2.793.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v4.1.0] .
+### Releases
+- [PyPI v4.1.0] https://pypi.org/project/shippo/4.1.0 - .

README.md

@@ -5,21 +5,20 @@ from shippo import Shippo
 
 
 with Shippo(
-    api_key_header="<YOUR_API_KEY_HERE>",
     shippo_api_version="2018-02-08",
+    api_key_header="<YOUR_API_KEY_HERE>",
 ) as s_client:
 
-    res = s_client.addresses.list()
-
-    assert res is not None
+    res = s_client.addresses.list(page=1, results=5)
 
     # Handle response
     print(res)
 ```
 
 </br>
 
-The same SDK client can also be used to make asychronous requests by importing asyncio.
+The same SDK client can also be used to make asynchronous requests by importing asyncio.
+
 ```python
 # Asynchronous Example
 import asyncio
@@ -28,13 +27,11 @@ from shippo import Shippo
 async def main():
 
     async with Shippo(
-        api_key_header="<YOUR_API_KEY_HERE>",
         shippo_api_version="2018-02-08",
+        api_key_header="<YOUR_API_KEY_HERE>",
     ) as s_client:
 
-        res = await s_client.addresses.list_async()
-
-        assert res is not None
+        res = await s_client.addresses.list_async(page=1, results=5)
 
         # Handle response
         print(res)