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

creatorsapi_python_sdk/models/browse_node_info.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, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.browse_node import BrowseNode
+from creatorsapi_python_sdk.models.website_sales_rank import WebsiteSalesRank
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BrowseNodeInfo(BaseModel):
+    """
+    Container for BrowseNode information associated with a product. Includes WebsiteSalesRank and list of BrowseNodes associated with the product.
+    """ # noqa: E501
+    browse_nodes: Optional[List[BrowseNode]] = Field(default=None, description="Container for list of BrowseNodes. BrowseNode contains information related to a BrowseNodeId including Id, DisplayName, ContextFreeName, IsRoot, Ancestor, Children, SalesRank associated, etc.", alias="browseNodes")
+    website_sales_rank: Optional[WebsiteSalesRank] = Field(default=None, alias="websiteSalesRank")
+    __properties: ClassVar[List[str]] = ["browseNodes", "websiteSalesRank"]
+
+    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 BrowseNodeInfo 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 each item in browse_nodes (list)
+        _items = []
+        if self.browse_nodes:
+            for _item_browse_nodes in self.browse_nodes:
+                if _item_browse_nodes:
+                    _items.append(_item_browse_nodes.to_dict())
+            _dict['browseNodes'] = _items
+        # override the default output from pydantic by calling `to_dict()` of website_sales_rank
+        if self.website_sales_rank:
+            _dict['websiteSalesRank'] = self.website_sales_rank.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BrowseNodeInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "browseNodes": [BrowseNode.from_dict(_item) for _item in obj["browseNodes"]] if obj.get("browseNodes") is not None else None,
+            "websiteSalesRank": WebsiteSalesRank.from_dict(obj["websiteSalesRank"]) if obj.get("websiteSalesRank") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/browse_nodes_result.py

@@ -0,0 +1,100 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.browse_node import BrowseNode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BrowseNodesResult(BaseModel):
+    """
+    The container for BrowseNodes response. It consists of resultant BrowseNodes for the GetBrowseNodes request.
+    """ # noqa: E501
+    browse_nodes: Optional[List[BrowseNode]] = Field(default=None, description="Container for BrowseNode information which includes BrowseNodeId, Name, Ancestor, Children, SalesRank associated, etc.", alias="browseNodes")
+    __properties: ClassVar[List[str]] = ["browseNodes"]
+
+    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 BrowseNodesResult 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 each item in browse_nodes (list)
+        _items = []
+        if self.browse_nodes:
+            for _item_browse_nodes in self.browse_nodes:
+                if _item_browse_nodes:
+                    _items.append(_item_browse_nodes.to_dict())
+            _dict['browseNodes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BrowseNodesResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "browseNodes": [BrowseNode.from_dict(_item) for _item in obj["browseNodes"]] if obj.get("browseNodes") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/by_line_info.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, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.contributor import Contributor
+from creatorsapi_python_sdk.models.single_string_valued_attribute import SingleStringValuedAttribute
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ByLineInfo(BaseModel):
+    """
+    Container for set of attributes that specifies basic information of the product like Brand, Manufacturer, etc.
+    """ # noqa: E501
+    brand: Optional[SingleStringValuedAttribute] = None
+    contributors: Optional[List[Contributor]] = Field(default=None, description="List of contributors associated with the product.")
+    manufacturer: Optional[SingleStringValuedAttribute] = None
+    __properties: ClassVar[List[str]] = ["brand", "contributors", "manufacturer"]
+
+    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 ByLineInfo 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 brand
+        if self.brand:
+            _dict['brand'] = self.brand.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in contributors (list)
+        _items = []
+        if self.contributors:
+            for _item_contributors in self.contributors:
+                if _item_contributors:
+                    _items.append(_item_contributors.to_dict())
+            _dict['contributors'] = _items
+        # override the default output from pydantic by calling `to_dict()` of manufacturer
+        if self.manufacturer:
+            _dict['manufacturer'] = self.manufacturer.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ByLineInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "brand": SingleStringValuedAttribute.from_dict(obj["brand"]) if obj.get("brand") is not None else None,
+            "contributors": [Contributor.from_dict(_item) for _item in obj["contributors"]] if obj.get("contributors") is not None else None,
+            "manufacturer": SingleStringValuedAttribute.from_dict(obj["manufacturer"]) if obj.get("manufacturer") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/classifications.py

@@ -0,0 +1,101 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.single_string_valued_attribute import SingleStringValuedAttribute
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Classifications(BaseModel):
+    """
+    Container for set of attributes that are used to classify an item into a particular category.
+    """ # noqa: E501
+    binding: Optional[SingleStringValuedAttribute] = None
+    product_group: Optional[SingleStringValuedAttribute] = Field(default=None, alias="productGroup")
+    __properties: ClassVar[List[str]] = ["binding", "productGroup"]
+
+    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 Classifications 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 binding
+        if self.binding:
+            _dict['binding'] = self.binding.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of product_group
+        if self.product_group:
+            _dict['productGroup'] = self.product_group.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Classifications from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "binding": SingleStringValuedAttribute.from_dict(obj["binding"]) if obj.get("binding") is not None else None,
+            "productGroup": SingleStringValuedAttribute.from_dict(obj["productGroup"]) if obj.get("productGroup") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/condition.py

@@ -0,0 +1,44 @@
+# 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 Condition(str, Enum):
+    """
+    The condition parameter filters offers by condition type.
+    """
+
+    """
+    allowed enum values
+    """
+    ANY = 'Any'
+    NEW = 'New'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Condition from a JSON string"""
+        return cls(json.loads(json_str))
+
+
+

creatorsapi_python_sdk/models/content_info.py

@@ -0,0 +1,113 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.languages import Languages
+from creatorsapi_python_sdk.models.single_integer_valued_attribute import SingleIntegerValuedAttribute
+from creatorsapi_python_sdk.models.single_string_valued_attribute import SingleStringValuedAttribute
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ContentInfo(BaseModel):
+    """
+    Container for set of attributes that are specific to the content like books, movies.
+    """ # noqa: E501
+    edition: Optional[SingleStringValuedAttribute] = None
+    languages: Optional[Languages] = None
+    pages_count: Optional[SingleIntegerValuedAttribute] = Field(default=None, alias="pagesCount")
+    publication_date: Optional[SingleStringValuedAttribute] = Field(default=None, alias="publicationDate")
+    __properties: ClassVar[List[str]] = ["edition", "languages", "pagesCount", "publicationDate"]
+
+    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 ContentInfo 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 edition
+        if self.edition:
+            _dict['edition'] = self.edition.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of languages
+        if self.languages:
+            _dict['languages'] = self.languages.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pages_count
+        if self.pages_count:
+            _dict['pagesCount'] = self.pages_count.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of publication_date
+        if self.publication_date:
+            _dict['publicationDate'] = self.publication_date.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ContentInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "edition": SingleStringValuedAttribute.from_dict(obj["edition"]) if obj.get("edition") is not None else None,
+            "languages": Languages.from_dict(obj["languages"]) if obj.get("languages") is not None else None,
+            "pagesCount": SingleIntegerValuedAttribute.from_dict(obj["pagesCount"]) if obj.get("pagesCount") is not None else None,
+            "publicationDate": SingleStringValuedAttribute.from_dict(obj["publicationDate"]) if obj.get("publicationDate") is not None else None
+        })
+        return _obj
+
+

creatorsapi_python_sdk/models/content_rating.py

@@ -0,0 +1,96 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from creatorsapi_python_sdk.models.single_string_valued_attribute import SingleStringValuedAttribute
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ContentRating(BaseModel):
+    """
+    Container for set of attributes that tell what age group is suitable to view said media.
+    """ # noqa: E501
+    audience_rating: Optional[SingleStringValuedAttribute] = Field(default=None, alias="audienceRating")
+    __properties: ClassVar[List[str]] = ["audienceRating"]
+
+    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 ContentRating 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 audience_rating
+        if self.audience_rating:
+            _dict['audienceRating'] = self.audience_rating.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ContentRating from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "audienceRating": SingleStringValuedAttribute.from_dict(obj["audienceRating"]) if obj.get("audienceRating") is not None else None
+        })
+        return _obj
+
+