Merge pull request #17 from 1415003719/2025-04

support 2025-04 version

Author: 1415003719

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Setup Python # Set Python version
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v3
         with:
           python-version: 3.11
 
@@ -37,7 +37,7 @@ jobs:
         run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ steps.get_version.outputs.VERSION }}
           path: dist

README.md

@@ -22,6 +22,7 @@ If you need support using AfterShip products, please contact [email protected]
   - [Endpoints](#endpoints)
     - [/trackings](#trackings)
     - [/couriers](#couriers)
+    - [/courier-connections](#courier-connections)
     - [/estimated-delivery-date](#estimated-delivery-date)
   - [Help](#help)
   - [License](#license)
@@ -41,6 +42,7 @@ Each SDK version is designed to work with a specific API version. Please refer t
 
 | SDK Version | Supported API Version | Branch                                                        |
 | ----------- | --------------------- | ------------------------------------------------------------- |
+| 6.x.x      | 2025-04               | https://github.com/AfterShip/tracking-sdk-python/tree/2025-04 |
 | 5.x.x      | 2025-01               | https://github.com/AfterShip/tracking-sdk-python/tree/2025-01 |
 | 4.x.x      | 2024-10               | https://github.com/AfterShip/tracking-sdk-python/tree/2024-10 |
 | 3.x.x      | 2024-07               | https://github.com/AfterShip/tracking-sdk-python/tree/2024-07 |
@@ -96,7 +98,7 @@ except exceptions.RateLimitExceedError:
 
 ## Rate Limiter
 
-See the [Rate Limit](https://www.aftership.com/docs/tracking/2025-01/quickstart/api-quick-start) to understand the AfterShip rate limit policy.
+See the [Rate Limit](https://www.aftership.com/docs/tracking/2025-04/quickstart/api-quick-start) to understand the AfterShip rate limit policy.
 
 ## Error Handling
 
@@ -145,6 +147,7 @@ The AfterShip instance has the following properties which are exactly the same a
 
 - courier - Get a list of our supported couriers.
 - tracking - Create trackings, update trackings, and get tracking results.
+- courier-connection - Create courier connections, update courier connections, and get courier connections results.
 - estimated-delivery-date - Get estimated delivery date for your order.
 
 
@@ -225,23 +228,57 @@ print(result)
 **GET** /couriers
 
 ```python
-result = sdk.courier.get_user_couriers()
+result = sdk.courier.get_couriers()
 print(result)
 ```
 
-**GET** /couriers/all
+**POST** /couriers/detect
 
 ```python
-result = sdk.courier.get_all_couriers()
+data = tracking.DetectCourierRequest()
+data.tracking_number = "<tracking_number>"
+result = sdk.courier.detect_courier(data)
 print(result)
 ```
 
-**POST** /couriers/detect
+### /courier-connections
+**GET** /courier-connections
 
 ```python
-data = tracking.DetectCourierRequest()
-data.tracking_number = "<tracking_number>"
-result = sdk.courier.detect_courier(data)
+result = sdk.courier_connection.get_courier_connections()
+print(result)
+```
+
+**POST** /courier-connections
+
+```python
+data = tracking.PostCourierConnectionsRequest()
+data.courier_slug = "dhl-api"
+data.credentials = {"api_key": "<api_key>"}
+result = sdk.courier_connection.post_courier_connections(data)
+print(result)
+```
+
+**GET** /courier-connections/:id
+
+```python
+result = sdk.courier_connection.get_courier_connections_by_id("<courier_connection_id>")
+print(result)
+```
+
+**PATCH** /courier-connections/:id
+
+```python
+data = PutCourierConnectionsByIdRequest()
+data.credentials={"api_key": "<api_key>"}
+result = sdk.courier_connection.put_courier_connections_by_id("<courier_connection_id>", data)
+print(result)
+```
+
+**DELETE** /courier-connections/:id
+
+```python
+result = sdk.courier_connection.delete_courier_connections_by_id("<courier_connection_id>")
 print(result)
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aftership-tracking-sdk"
-version = "5.0.1"
+version = "6.0.0"
 description = "The official AfterShip Tracking Python API library"
 authors = ["AfterShip <[email protected]>"]
 license = "MIT"

tracking/__init__.py

@@ -11,4 +11,4 @@
 from . import exceptions
 from .models import *
 
-__version__ = "5.0.1"
+__version__ = "6.0.0"

tracking/api/__init__.py

@@ -5,10 +5,12 @@
 
 __all__ = [
     "CourierApi",
+    "CourierConnectionApi",
     "EstimatedDeliveryDateApi",
     "TrackingApi",
 ]
 
 from .courier import CourierApi
+from .courier_connection import CourierConnectionApi
 from .estimated_delivery_date import EstimatedDeliveryDateApi
 from .tracking import TrackingApi

tracking/api/courier.py

@@ -4,15 +4,13 @@
 # Do not edit the class manually.
 
 import json
-from typing import Union, Annotated
+from typing import Union
 
-from pydantic import Field
 
 from tracking.models import (
     DetectCourierRequest,
     DetectCourierResponse,
-    GetAllCouriersResponse,
-    GetUserCouriersResponse,
+    GetCouriersResponse,
 )
 from tracking.request import ApiClient, validate_params
 
@@ -35,7 +33,7 @@ def detect_courier(
                     a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                     (which will disable verification).
         """
-        url = "/tracking/2025-01/couriers/detect"
+        url = "/tracking/2025-04/couriers/detect"
 
         body = detect_courier_request
         if not isinstance(body, dict):
@@ -46,35 +44,26 @@ def detect_courier(
         return DetectCourierResponse().from_dict(result)
 
     @validate_params
-    def get_all_couriers(self, **kwargs) -> GetAllCouriersResponse:
+    def get_couriers(self, **kwargs) -> GetCouriersResponse:
         """
-        Return a list of all couriers.
+        Return a list of couriers.
         :param kwargs:
             request options:
                 **headers** (dict): support custom headers.
                 **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
                     verify the identity of requested hosts. Either `True` (default CA bundle),
                     a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                     (which will disable verification).
+            query params:
+                **active**: bool. get user activated couriers
+                **slug**: str. Unique courier code Use comma for multiple values. (Example: dhl,ups,usps)
         """
-        url = "/tracking/2025-01/couriers/all"
+        url = "/tracking/2025-04/couriers"
+        params_keys = {
+            "active",
+            "slug",
+        }
+        params = {key: kwargs.pop(key) for key in params_keys if key in kwargs}
 
-        result = self._request("GET", url=url, **kwargs)
-        return GetAllCouriersResponse().from_dict(result)
-
-    @validate_params
-    def get_user_couriers(self, **kwargs) -> GetUserCouriersResponse:
-        """
-        Return a list of .
-        :param kwargs:
-            request options:
-                **headers** (dict): support custom headers.
-                **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
-                    verify the identity of requested hosts. Either `True` (default CA bundle),
-                    a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
-                    (which will disable verification).
-        """
-        url = "/tracking/2025-01/couriers"
-
-        result = self._request("GET", url=url, **kwargs)
-        return GetUserCouriersResponse().from_dict(result)
+        result = self._request("GET", url=url, params=params, **kwargs)
+        return GetCouriersResponse().from_dict(result)

tracking/api/courier_connection.py

@@ -0,0 +1,150 @@
+# coding: utf-8
+#
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+
+import json
+from typing import Union, Annotated
+
+from pydantic import Field
+
+from tracking.models import (
+    DeleteCourierConnectionsByIdResponse,
+    GetCourierConnectionsResponse,
+    GetCourierConnectionsByIdResponse,
+    PostCourierConnectionsRequest,
+    PostCourierConnectionsResponse,
+    PutCourierConnectionsByIdRequest,
+    PutCourierConnectionsByIdResponse,
+)
+from tracking.request import ApiClient, validate_params
+
+
+class CourierConnectionApi(ApiClient):
+    """CourierConnectionApi api implements"""
+
+    @validate_params
+    def delete_courier_connections_by_id(
+        self, courier_connection_id: Annotated[str, Field(min_length=1)], **kwargs
+    ) -> DeleteCourierConnectionsByIdResponse:
+        """
+        Delete a courier connection.
+        :param courier_connection_id: str.
+        :param kwargs:
+            request options:
+                **headers** (dict): support custom headers.
+                **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
+                    verify the identity of requested hosts. Either `True` (default CA bundle),
+                    a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
+                    (which will disable verification).
+        """
+        url = f"/tracking/2025-04/courier-connections/{courier_connection_id}"
+
+        result = self._request("DELETE", url=url, **kwargs)
+        return DeleteCourierConnectionsByIdResponse().from_dict(result)
+
+    @validate_params
+    def get_courier_connections(self, **kwargs) -> GetCourierConnectionsResponse:
+        """
+        Get courier connection results of multiple courier connections.
+        :param kwargs:
+            request options:
+                **headers** (dict): support custom headers.
+                **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
+                    verify the identity of requested hosts. Either `True` (default CA bundle),
+                    a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
+                    (which will disable verification).
+            query params:
+                **courier_slug**: str. Unique courier code.(Example: dhl-api)
+                **cursor**: str. A string representing the cursor value for the current page of results.
+                **limit**: str. Number of courier connections each page contain. (Default: 100, Max: 200)
+        """
+        url = "/tracking/2025-04/courier-connections"
+        params_keys = {
+            "courier_slug",
+            "cursor",
+            "limit",
+        }
+        params = {key: kwargs.pop(key) for key in params_keys if key in kwargs}
+
+        result = self._request("GET", url=url, params=params, **kwargs)
+        return GetCourierConnectionsResponse().from_dict(
+            {
+                "pagination": result.get("pagination"),
+                "courier_connections": result.get("courier_connections"),
+            }
+        )
+
+    @validate_params
+    def get_courier_connections_by_id(
+        self, courier_connection_id: Annotated[str, Field(min_length=1)], **kwargs
+    ) -> GetCourierConnectionsByIdResponse:
+        """
+        Get courier connection results of a single courier connection.
+        :param courier_connection_id: str.
+        :param kwargs:
+            request options:
+                **headers** (dict): support custom headers.
+                **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
+                    verify the identity of requested hosts. Either `True` (default CA bundle),
+                    a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
+                    (which will disable verification).
+        """
+        url = f"/tracking/2025-04/courier-connections/{courier_connection_id}"
+
+        result = self._request("GET", url=url, **kwargs)
+        return GetCourierConnectionsByIdResponse().from_dict(result)
+
+    @validate_params
+    def post_courier_connections(
+        self, post_courier_connections_request: Union[PostCourierConnectionsRequest, dict], **kwargs
+    ) -> PostCourierConnectionsResponse:
+        """
+
+        :param post_courier_connections_request:
+        :param kwargs:
+            request options:
+                **headers** (dict): support custom headers.
+                **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
+                    verify the identity of requested hosts. Either `True` (default CA bundle),
+                    a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
+                    (which will disable verification).
+        """
+        url = "/tracking/2025-04/courier-connections"
+
+        body = post_courier_connections_request
+        if not isinstance(body, dict):
+            body = post_courier_connections_request.model_dump(exclude_none=True)
+        body = json.dumps(body)
+
+        result = self._request("POST", url=url, body=body, **kwargs)
+        return PostCourierConnectionsResponse().from_dict(result)
+
+    @validate_params
+    def put_courier_connections_by_id(
+        self,
+        courier_connection_id: Annotated[str, Field(min_length=1)],
+        put_courier_connections_by_id_request: Union[PutCourierConnectionsByIdRequest, dict],
+        **kwargs,
+    ) -> PutCourierConnectionsByIdResponse:
+        """
+        Update a courier connection.
+        :param courier_connection_id: str.
+        :param put_courier_connections_by_id_request:
+        :param kwargs:
+            request options:
+                **headers** (dict): support custom headers.
+                **verify** bool|str|SSLContext: SSL certificates (a.k.a CA bundle) used to
+                    verify the identity of requested hosts. Either `True` (default CA bundle),
+                    a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
+                    (which will disable verification).
+        """
+        url = f"/tracking/2025-04/courier-connections/{courier_connection_id}"
+
+        body = put_courier_connections_by_id_request
+        if not isinstance(body, dict):
+            body = put_courier_connections_by_id_request.model_dump(exclude_none=True)
+        body = json.dumps(body)
+
+        result = self._request("PATCH", url=url, body=body, **kwargs)
+        return PutCourierConnectionsByIdResponse().from_dict(result)

tracking/api/estimated_delivery_date.py

@@ -4,9 +4,8 @@
 # Do not edit the class manually.
 
 import json
-from typing import Union, Annotated
+from typing import Union
 
-from pydantic import Field
 
 from tracking.models import (
     PredictRequest,
@@ -33,7 +32,7 @@ def predict(self, predict_request: Union[PredictRequest, dict], **kwargs) -> Pre
                     a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                     (which will disable verification).
         """
-        url = "/tracking/2025-01/estimated-delivery-date/predict"
+        url = "/tracking/2025-04/estimated-delivery-date/predict"
 
         body = predict_request
         if not isinstance(body, dict):
@@ -58,7 +57,7 @@ def predict_batch(
                     a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                     (which will disable verification).
         """
-        url = "/tracking/2025-01/estimated-delivery-date/predict-batch"
+        url = "/tracking/2025-04/estimated-delivery-date/predict-batch"
 
         body = predict_batch_request
         if not isinstance(body, dict):