python-amazon-sp-api 2.0.15__py3-none-any.whl → 2.1.3__py3-none-any.whl

sp_api/api/notifications/notifications.py

@@ -11,7 +11,23 @@ class Notifications(Client):
 
     @deprecated
     def add_subscription(self, notification_type: NotificationType or str, **kwargs):
-        """deprecated, use create_subscription"""
+        """
+        add_subscription(self, notification_type, **kwargs) -> ApiResponse
+        
+        deprecated, use create_subscription
+        
+        Examples:
+            literal blocks::
+            
+                Notifications().add_subscription("value")
+        
+        Args:
+            notification_type:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
         return self.create_subscription(notification_type, **kwargs)
 
     @sp_endpoint("/notifications/v1/subscriptions/{}", method="POST")
@@ -22,34 +38,31 @@ class Notifications(Client):
         **kwargs
     ) -> ApiResponse:
         """
-        create_subscription(self, notification_type: NotificationType or str, destination_id: str = None, **kwargs) -> ApiResponse
-        Creates a subscription for the specified notification type to be delivered to the specified destination.
-        Before you can subscribe, you must first create the destination by calling the createDestination operation.
-
+        create_subscription(self, notification_type, destination_id, **kwargs) -> ApiResponse
+        
+        Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version.
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       5
         ======================================  ==============
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
         Examples:
             literal blocks::
-
-                Notifications().create_subscription(NotificationType.MFN_ORDER_STATUS_CHANGE, destination_id='dest_id')
-
+            
+                Notifications().create_subscription("value", "value")
+        
         Args:
-            notification_type: NotificationType or str
-            destination_id: str
-            **kwargs:
-
-
+            body: CreateSubscriptionRequest | required
+            param: object |
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         data = {
             "destinationId": kwargs.pop("destinationId", destination_id),
@@ -72,31 +85,21 @@ class Notifications(Client):
         self, notification_type: NotificationType or str, **kwargs
     ) -> ApiResponse:
         """
-        get_subscription(self, notification_type: NotificationType or str, **kwargs) -> ApiResponse
-        Returns information about subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       5
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        get_subscription(self, notification_type, **kwargs) -> ApiResponse
+        
+        Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription's information. You can use this API to get subscription information when you do not have a subscription identifier.
+        
         Examples:
             literal blocks::
-
-                Notifications().get_subscription(NotificationType.REPORT_PROCESSING_FINISHED)
-
+            
+                Notifications().get_subscription("value")
+        
         Args:
-            notification_type: NotificationType or str
+            notification_type:  | required
             **kwargs:
-
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         return self._request(
             fill_query_params(
@@ -115,31 +118,31 @@ class Notifications(Client):
         self, notification_type: NotificationType or str, subscription_id: str, **kwargs
     ) -> ApiResponse:
         """
-        delete_notification_subscription(self, notification_type: NotificationType or str, subscription_id: str, **kwargs) -> ApiResponse
-        Deletes the subscription indicated by the subscription identifier and notification type that you specify.
-        The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
-
+        delete_notification_subscription(self, notification_type, subscription_id, **kwargs) -> ApiResponse
+        
+        Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       5
         ======================================  ==============
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
         Examples:
-            Notifications().delete_notification_subscription(NotificationType.MFN_ORDER_STATUS_CHANGE, 'subscription_id')
-
+            literal blocks::
+            
+                Notifications().delete_notification_subscription("value", "value")
+        
         Args:
-            notification_type: NotificationType or str
-            subscription_id: str
-            **kwargs:
-
+            subscriptionId: object | required The identifier for the subscription that you want to delete.
+            param: object |
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         return self._request(
             fill_query_params(
@@ -164,32 +167,24 @@ class Notifications(Client):
         **kwargs
     ) -> ApiResponse:
         """
-        create_destination(self, name: str, arn: str, **kwargs) -> ApiResponse
+        create_destination(self, name, arn, account_id, region, **kwargs) -> ApiResponse
+        
         Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       5
-        ======================================  ==============
-
+        
         Examples:
             literal blocks::
-
-                Notifications().create_destination(name='test', arn='arn:aws:sqs:us-east-2:444455556666:queue1')
-
+            
+                Notifications().create_destination("value", "value", "value", "value")
+        
         Args:
-            account_id:
-            region:
-            name: str
-            arn: str
+            name:  | required
+            arn:  | required
+            account_id:  | required
+            region:  | required
             **kwargs:
-
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         resource_name = "sqs" if not account_id else "eventBridge"
         region = region if region else self.region
@@ -213,53 +208,59 @@ class Notifications(Client):
     def get_destinations(self, **kwargs) -> ApiResponse:
         """
         get_destinations(self, **kwargs) -> ApiResponse
-        Returns information about all destinations. The getDestinations API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
-
+        
+        Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       5
         ======================================  ==============
-
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Notifications().get_destinations()
+        
         Args:
             **kwargs:
-
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         return self._request_grantless_operation(kwargs.pop("path"), params={**kwargs})
 
     @sp_endpoint("/notifications/v1/destinations/{}", method="GET")
     def get_destination(self, destination_id: str, **kwargs) -> ApiResponse:
         """
-        get_destination(self, destination_id: str, **kwargs) -> ApiResponse
-        Returns information about all destinations. The getDestinations API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
-
+        get_destination(self, destination_id, **kwargs) -> ApiResponse
+        
+        Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       5
         ======================================  ==============
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
-
+        
+        Examples:
+            literal blocks::
+            
+                Notifications().get_destination("value")
+        
         Args:
-            destination_id: str
-            **kwargs:
-
+            destinationId: object | required The identifier generated when you created the destination.
+        
         Returns:
-            ApiResponse:
-
-
+            ApiResponse
         """
         return self._request_grantless_operation(
             fill_query_params(kwargs.pop("path"), destination_id), params={**kwargs}
@@ -268,27 +269,64 @@ class Notifications(Client):
     @sp_endpoint("/notifications/v1/destinations/{}", method="DELETE")
     def delete_destination(self, destination_id: str, **kwargs) -> ApiResponse:
         """
-        delete_destination(self, destination_id: str, **kwargs) -> ApiResponse
-        Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
-
+        delete_destination(self, destination_id, **kwargs) -> ApiResponse
+        
+        Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       5
         ======================================  ==============
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Notifications().delete_destination("value")
+        
         Args:
-            destination_id: str
-            **kwargs:
-
+            destinationId: object | required The identifier for the destination that you want to delete.
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         return self._request_grantless_operation(
             fill_query_params(kwargs.pop("path"), destination_id), params={**kwargs}
         )
+
+
+
+    @sp_endpoint("/notifications/v1/subscriptions/{}/{}", method="GET")
+    def get_subscription_by_id(self, notificationType, subscriptionId, **kwargs) -> ApiResponse:
+        """
+        get_subscription_by_id(self, notificationType, subscriptionId, **kwargs) -> ApiResponse
+        
+        Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                Notifications().get_subscription_by_id("value", "value")
+        
+        Args:
+            subscriptionId: object | required The identifier for the subscription that you want to get.
+            param: object |
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(fill_query_params(kwargs.pop("path"), notificationType, subscriptionId), params=kwargs)

sp_api/api/orders/orders.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import enum
 from typing import Any, Literal, TYPE_CHECKING, overload
+from sp_api.util.versioned_client import VersionedClientMeta
 
 from sp_api.base import ApiResponse, Client, Marketplaces, deprecated, fill_query_params, sp_endpoint
 from sp_api.util import normalize_csv_param
@@ -15,52 +16,12 @@ class OrdersVersion(str, enum.Enum):
     LATEST = "2026-01-01"
 
 
-class _VersionedClientMeta(type):
-    """Metaclass that dispatches construction to a version-specific implementation.
-
-    This keeps the call-site ergonomic (`Orders(version=...)`) while allowing a single
-    place to implement the dispatch logic.
-
-    Subclasses should define:
-      - `_VERSION_MAP`: mapping of normalized version strings to implementation classes
-      - `_VERSION_ALIASES` (optional): mapping of alias strings to normalized versions
-
-    If no version is provided, the default version is used.
-    """
-
-    def __call__(cls, *args: Any, **kwargs: Any):
-        version = kwargs.pop("version", None)
-
-        # Only dispatch for the public front class itself.
-        if cls is Orders:
-            # Backwards-compatible default: if no version is provided, return the
-            # oldest supported implementation.
-            v_raw = version if version is not None else getattr(cls, "_DEFAULT_VERSION", None)
-            if v_raw is None:
-                return super().__call__(*args, **kwargs)
-
-            v_raw = getattr(v_raw, "value", v_raw)
-            v = str(v_raw)
-            aliases: dict[str, str] = getattr(cls, "_VERSION_ALIASES", {})
-            v_norm = aliases.get(v, v)
-
-            impl_map: dict[str, type] = getattr(cls, "_VERSION_MAP", {})
-            impl = impl_map.get(v_norm)
-            if impl is not None:
-                return impl(*args, **kwargs)
-
-            supported = ", ".join(sorted(impl_map.keys()))
-            raise ValueError(f"Unsupported version {v!r}. Supported: {supported}")
-
-        return super().__call__(*args, **kwargs)
-
-
 if TYPE_CHECKING:
 
-    class _OrdersMeta(_VersionedClientMeta):
+    class _OrdersMeta(VersionedClientMeta):
         @overload
         def __call__(
-            self,
+            cls,
             *args: Any,
             version: Literal[OrdersVersion.V_2026_01_01, OrdersVersion.LATEST, "2026-01-01"],
             **kwargs: Any,
@@ -68,7 +29,7 @@ if TYPE_CHECKING:
 
         @overload
         def __call__(
-            self,
+            cls,
             *args: Any,
             version: Literal[OrdersVersion.V0, "v0"],
             **kwargs: Any,
@@ -76,7 +37,7 @@ if TYPE_CHECKING:
 
         @overload
         def __call__(
-            self,
+            cls,
             *args: Any,
             version: None = None,
             **kwargs: Any,
@@ -84,7 +45,7 @@ if TYPE_CHECKING:
 
         @overload
         def __call__(
-            self,
+            cls,
             *args: Any,
             version: str | OrdersVersion,
             **kwargs: Any,
@@ -92,7 +53,7 @@ if TYPE_CHECKING:
 
 
 else:
-    _OrdersMeta = _VersionedClientMeta
+    _OrdersMeta = VersionedClientMeta
 
 class Orders(Client, metaclass=_OrdersMeta):
     """Orders API client.
@@ -137,6 +98,8 @@ class Orders(Client, metaclass=_OrdersMeta):
             **kwargs: Any,
         ) -> Client: ...
 
+    _DISPATCH = True
+
     _DEFAULT_VERSION = "v0"
 
     _VERSION_MAP = {

sp_api/api/orders/orders_2026_01_01.py

@@ -20,47 +20,19 @@ class OrdersV20260101(Client):
     def search_orders(self, **kwargs: Any) -> ApiResponse:
         """
         search_orders(self, **kwargs) -> ApiResponse
-        Returns orders that are created or updated during the time period that you specify.
-        You can filter the response for specific types of orders.
-
-        **Usage Plan:**
-
-        ======================================  =====================
-        Rate (requests per second)               Burst
-        ======================================  =====================
-        See x-amzn-ratelimit-limit response      See Amazon docs
-        ======================================  =====================
-
-        Note:
-            The SP-API returns an `x-amzn-ratelimit-limit` (or similar) response header indicating the rate limit
-            applied to the request. Rate and burst can vary by seller/account and by any Amazon-granted overrides.
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Returns orders that are created or updated during the time period that you specify. You can filter the response for specific types of orders.
+        
         Examples:
             literal blocks::
-
-                OrdersV20260101().search_orders(
-                    createdAfter="2026-01-01T00:00:00Z",
-                    marketplaceIds=["A1PA6795UKMFR9"]
-                )
-
+            
+                OrdersV20260101().search_orders()
+        
         Args:
-            key createdAfter: str
-            key createdBefore: str
-            key lastUpdatedAfter: str
-            key lastUpdatedBefore: str
-            key fulfillmentStatuses: [str] | str
-            key marketplaceIds: [str] | str
-            key fulfilledBy: [str] | str
-            key includedData: [str] | str
-            key paginationToken: str
-            key maxResultsPerPage: int
-
+            **kwargs:
+        
         Returns:
-            ApiResponse:
-
-
+            ApiResponse
         """
 
         normalize_csv_param(kwargs, "fulfillmentStatuses")
@@ -72,39 +44,21 @@ class OrdersV20260101(Client):
     @sp_endpoint("/orders/2026-01-01/orders/{}")
     def get_order(self, order_id: str, **kwargs: Any) -> ApiResponse:
         """
-        get_order(self, order_id: str, **kwargs) -> ApiResponse
+        get_order(self, order_id, **kwargs) -> ApiResponse
+        
         Returns the order that you specify.
-
-        **Usage Plan:**
-
-        ======================================  =====================
-        Rate (requests per second)               Burst
-        ======================================  =====================
-        See x-amzn-ratelimit-limit response      See Amazon docs
-        ======================================  =====================
-
-        Note:
-            The SP-API returns an `x-amzn-ratelimit-limit` (or similar) response header indicating the rate limit
-            applied to the request. Rate and burst can vary by seller/account and by any Amazon-granted overrides.
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
         Examples:
             literal blocks::
-
-                OrdersV20260101().get_order(
-                    "306-9860906-6213927",
-                    includedData=["orderItems"]
-                )
-
+            
+                OrdersV20260101().get_order("value")
+        
         Args:
-            order_id: str
-            key includedData: [str] | str
-
+            order_id:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
-
-
+            ApiResponse
         """
 
         normalize_csv_param(kwargs, "includedData")