amazon-creatorsapi-python-sdk 1.0.0__py3-none-any.whl

creatorsapi_python_sdk/models/contributor.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Contributor(BaseModel):
+    """
+    Container for contributor associated with the product.
+    """ # noqa: E501
+    locale: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    role: Optional[StrictStr] = None
+    role_type: Optional[StrictStr] = Field(default=None, alias="roleType")
+    __properties: ClassVar[List[str]] = ["locale", "name", "role", "roleType"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Contributor from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Contributor from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "locale": obj.get("locale"),
+            "name": obj.get("name"),
+            "role": obj.get("role"),
+            "roleType": obj.get("roleType")
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/customer_reviews.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from creatorsapi_python_sdk.models.rating import Rating
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CustomerReviews(BaseModel):
+    """
+    Container for customer reviews information associated with a product. Includes weighted star rating and total reviews count.
+    """ # noqa: E501
+    count: Optional[Union[StrictFloat, StrictInt]] = None
+    star_rating: Optional[Rating] = Field(default=None, alias="starRating")
+    __properties: ClassVar[List[str]] = ["count", "starRating"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CustomerReviews from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of star_rating
+        if self.star_rating:
+            _dict['starRating'] = self.star_rating.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CustomerReviews from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "count": obj.get("count"),
+            "starRating": Rating.from_dict(obj["starRating"]) if obj.get("starRating") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/deal_details.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DealDetails(BaseModel):
+    """
+    Specifies deal information about an offer.
+    """ # noqa: E501
+    access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
+    badge: Optional[StrictStr] = None
+    early_access_duration_in_milliseconds: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="earlyAccessDurationInMilliseconds")
+    end_time: Optional[StrictStr] = Field(default=None, alias="endTime")
+    percent_claimed: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="percentClaimed")
+    start_time: Optional[StrictStr] = Field(default=None, alias="startTime")
+    __properties: ClassVar[List[str]] = ["accessType", "badge", "earlyAccessDurationInMilliseconds", "endTime", "percentClaimed", "startTime"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DealDetails from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DealDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accessType": obj.get("accessType"),
+            "badge": obj.get("badge"),
+            "earlyAccessDurationInMilliseconds": obj.get("earlyAccessDurationInMilliseconds"),
+            "endTime": obj.get("endTime"),
+            "percentClaimed": obj.get("percentClaimed"),
+            "startTime": obj.get("startTime")
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/delivery_flag.py

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DeliveryFlag(str, Enum):
+    """
+    DeliveryFlag
+    """
+
+    """
+    allowed enum values
+    """
+    AMAZONGLOBAL = 'AmazonGlobal'
+    FREESHIPPING = 'FreeShipping'
+    FULFILLEDBYAMAZON = 'FulfilledByAmazon'
+    PRIME = 'Prime'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DeliveryFlag from a JSON string"""
+        return cls(json.loads(json_str))
+
+
+

creatorsapi_python_sdk/models/dimension_based_attribute.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.unit_based_attribute import UnitBasedAttribute
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionBasedAttribute(BaseModel):
+    """
+    Container for attributes which are dimension based for example ItemDimensions, etc.
+    """ # noqa: E501
+    height: Optional[UnitBasedAttribute] = None
+    length: Optional[UnitBasedAttribute] = None
+    weight: Optional[UnitBasedAttribute] = None
+    width: Optional[UnitBasedAttribute] = None
+    __properties: ClassVar[List[str]] = ["height", "length", "weight", "width"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DimensionBasedAttribute from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of height
+        if self.height:
+            _dict['height'] = self.height.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of length
+        if self.length:
+            _dict['length'] = self.length.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of weight
+        if self.weight:
+            _dict['weight'] = self.weight.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of width
+        if self.width:
+            _dict['width'] = self.width.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionBasedAttribute from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "height": UnitBasedAttribute.from_dict(obj["height"]) if obj.get("height") is not None else None,
+            "length": UnitBasedAttribute.from_dict(obj["length"]) if obj.get("length") is not None else None,
+            "weight": UnitBasedAttribute.from_dict(obj["weight"]) if obj.get("weight") is not None else None,
+            "width": UnitBasedAttribute.from_dict(obj["width"]) if obj.get("width") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/error_data.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ErrorData(BaseModel):
+    """
+    Error information for partial failures within a successful response. Used when an operation succeeds overall but encounters errors for specific items or resources.
+    """ # noqa: E501
+    code: StrictStr = Field(description="A unique code identifying the specific error condition (e.g., 'InvalidItemId', 'ItemNotFound')")
+    message: StrictStr = Field(description="A human-readable description of the error")
+    __properties: ClassVar[List[str]] = ["code", "message"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ErrorData from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ErrorData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "code": obj.get("code"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/external_ids.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+or in the "license" file accompanying this file. This file is distributed
+on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language governing
+permissions and limitations under the License.
+
+"""  # noqa: E501
+
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.multi_valued_attribute import MultiValuedAttribute
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExternalIds(BaseModel):
+    """
+    Container for set of identifiers that is used globally to identify a particular product.
+    """ # noqa: E501
+    eans: Optional[MultiValuedAttribute] = None
+    isbns: Optional[MultiValuedAttribute] = None
+    upcs: Optional[MultiValuedAttribute] = None
+    __properties: ClassVar[List[str]] = ["eans", "isbns", "upcs"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ExternalIds from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of eans
+        if self.eans:
+            _dict['eans'] = self.eans.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of isbns
+        if self.isbns:
+            _dict['isbns'] = self.isbns.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of upcs
+        if self.upcs:
+            _dict['upcs'] = self.upcs.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExternalIds from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "eans": MultiValuedAttribute.from_dict(obj["eans"]) if obj.get("eans") is not None else None,
+            "isbns": MultiValuedAttribute.from_dict(obj["isbns"]) if obj.get("isbns") is not None else None,
+            "upcs": MultiValuedAttribute.from_dict(obj["upcs"]) if obj.get("upcs") is not None else None
+        })
+        return _obj
+
+