etsy-python 1.0.20__tar.gz → 1.1.0__tar.gz

etsy_python-1.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include LICENSE
+include README.md
+
+# Exclude maintenance and development files
+prune scripts
+prune specs
+prune docs
+prune .claude
+prune .github
+prune tests
+
+exclude .bumpversion.cfg
+exclude .pre-commit-config.yaml

{etsy_python-1.0.20 → etsy_python-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: etsy-python
-Version: 1.0.20
+Version: 1.1.0
 Summary: Etsy API Client Library for Python
 Author: Amit Ray
 Author-email: mail@amitray.dev
@@ -328,19 +328,25 @@ The SDK provides comprehensive coverage of Etsy API v3 resources:
 - **Listing** - Create, read, update, delete listings
 - **Shop** - Manage shop information and settings
 - **Receipt** - Handle orders and transactions
+- **ReceiptTransactions** - Individual transaction details
 - **User** - User profiles and addresses
-- **ShippingProfile** - Configure shipping options
+- **UserAddress** - User address management
+- **ShippingProfile** - Configure shipping options and destinations
 
 ### Media Resources
 
 - **ListingImage** - Upload and manage listing images
 - **ListingVideo** - Upload and manage listing videos
 - **ListingFile** - Digital file management
+- **ListingVariationImages** - Variation-specific images
 
 ### Commerce Resources
 
 - **ListingInventory** - Stock and SKU management
-- **Payment** - Payment processing and ledger entries
+- **ListingOffering** - Product offering details
+- **ListingProduct** - Product variant management
+- **Payment** - Payment processing
+- **PaymentLedgerEntry** - Payment ledger entries
 - **Review** - Customer reviews management
 
 ### Shop Management
@@ -348,6 +354,14 @@ The SDK provides comprehensive coverage of Etsy API v3 resources:
 - **ShopSection** - Organize listings into sections
 - **ShopReturnPolicy** - Define return policies
 - **ShopProductionPartner** - Manage production partners
+- **HolidayPreferences** - Shop holiday schedule
+- **ProcessingProfile** - Processing time profiles
+
+### Taxonomy & Translation
+
+- **BuyerTaxonomy** / **SellerTaxonomy** - Product categories and attributes
+- **ListingTranslation** - Listing localization
+- **Miscellaneous** - Ping and other utility endpoints
 
 ## Error Handling
 
@@ -383,16 +397,24 @@ export ETSY_ENV=PROD
 ```
 etsy-python-sdk/
 ├── etsy_python/
+│   ├── _version.py            # Single source of truth for version
 │   └── v3/
-│       ├── auth/          # OAuth authentication
-│       ├── common/        # Shared utilities
-│       ├── enums/         # API enum definitions
-│       ├── exceptions/    # Custom exceptions
-│       ├── models/        # Request/response models
-│       └── resources/     # API endpoint implementations
-├── setup.py               # Package configuration
-├── LICENSE                # MIT License
-└── README.md              # Documentation
+│       ├── auth/              # OAuth 2.0 PKCE authentication
+│       ├── common/            # Shared utilities and HTTP constants
+│       ├── enums/             # Type-safe API parameter constants
+│       ├── exceptions/        # Custom exceptions with rate limit info
+│       ├── models/            # Request data models with validation
+│       └── resources/         # ~28 API endpoint resource classes
+├── tests/                     # pytest test suite
+│   └── fixtures/              # Shared test fixtures and mock responses
+├── scripts/                   # Maintenance and release scripts
+├── specs/                     # OAS spec files and audit reports
+├── .github/
+│   ├── workflows/             # CI/CD and PR automation
+│   └── CODEOWNERS             # Required reviewers for sensitive files
+├── setup.py                   # Package configuration
+├── requirements-dev.txt       # Development/testing dependencies
+└── README.md                  # Documentation
 ```
 
 ## Contributing
@@ -459,16 +481,28 @@ python scripts/release.py patch --no-push
 4. Install dependencies:
    ```bash
    pip install -r etsy_python/requirements.txt
+   pip install -r requirements-dev.txt
+   ```
+5. Run the test suite:
+   ```bash
+   pytest -v
+   pytest --cov=etsy_python --cov-report=term-missing
    ```
-5. Create a feature branch:
+6. Create a feature branch:
    ```bash
    git checkout -b feature/your-feature-name
    ```
-6. Make your changes and commit:
+7. Make your changes and commit:
    ```bash
-   git commit -m "Add your feature"
+   git commit -m "feat: add your feature"
    ```
-7. Push and create a pull request
+8. Push and create a pull request
+
+### CI on Pull Requests
+
+Pull requests automatically trigger:
+- **pr-tests.yml** — Runs the full test suite with coverage reporting (posts/updates a comment on the PR)
+- **pr-coverage.yml** — SDK coverage audit against the Etsy OAS spec (triggered by the `sdk-check` label)
 
 ## Support
 

{etsy_python-1.0.20 → etsy_python-1.1.0}/README.md

@@ -307,19 +307,25 @@ The SDK provides comprehensive coverage of Etsy API v3 resources:
 - **Listing** - Create, read, update, delete listings
 - **Shop** - Manage shop information and settings
 - **Receipt** - Handle orders and transactions
+- **ReceiptTransactions** - Individual transaction details
 - **User** - User profiles and addresses
-- **ShippingProfile** - Configure shipping options
+- **UserAddress** - User address management
+- **ShippingProfile** - Configure shipping options and destinations
 
 ### Media Resources
 
 - **ListingImage** - Upload and manage listing images
 - **ListingVideo** - Upload and manage listing videos
 - **ListingFile** - Digital file management
+- **ListingVariationImages** - Variation-specific images
 
 ### Commerce Resources
 
 - **ListingInventory** - Stock and SKU management
-- **Payment** - Payment processing and ledger entries
+- **ListingOffering** - Product offering details
+- **ListingProduct** - Product variant management
+- **Payment** - Payment processing
+- **PaymentLedgerEntry** - Payment ledger entries
 - **Review** - Customer reviews management
 
 ### Shop Management
@@ -327,6 +333,14 @@ The SDK provides comprehensive coverage of Etsy API v3 resources:
 - **ShopSection** - Organize listings into sections
 - **ShopReturnPolicy** - Define return policies
 - **ShopProductionPartner** - Manage production partners
+- **HolidayPreferences** - Shop holiday schedule
+- **ProcessingProfile** - Processing time profiles
+
+### Taxonomy & Translation
+
+- **BuyerTaxonomy** / **SellerTaxonomy** - Product categories and attributes
+- **ListingTranslation** - Listing localization
+- **Miscellaneous** - Ping and other utility endpoints
 
 ## Error Handling
 
@@ -362,16 +376,24 @@ export ETSY_ENV=PROD
 ```
 etsy-python-sdk/
 ├── etsy_python/
+│   ├── _version.py            # Single source of truth for version
 │   └── v3/
-│       ├── auth/          # OAuth authentication
-│       ├── common/        # Shared utilities
-│       ├── enums/         # API enum definitions
-│       ├── exceptions/    # Custom exceptions
-│       ├── models/        # Request/response models
-│       └── resources/     # API endpoint implementations
-├── setup.py               # Package configuration
-├── LICENSE                # MIT License
-└── README.md              # Documentation
+│       ├── auth/              # OAuth 2.0 PKCE authentication
+│       ├── common/            # Shared utilities and HTTP constants
+│       ├── enums/             # Type-safe API parameter constants
+│       ├── exceptions/        # Custom exceptions with rate limit info
+│       ├── models/            # Request data models with validation
+│       └── resources/         # ~28 API endpoint resource classes
+├── tests/                     # pytest test suite
+│   └── fixtures/              # Shared test fixtures and mock responses
+├── scripts/                   # Maintenance and release scripts
+├── specs/                     # OAS spec files and audit reports
+├── .github/
+│   ├── workflows/             # CI/CD and PR automation
+│   └── CODEOWNERS             # Required reviewers for sensitive files
+├── setup.py                   # Package configuration
+├── requirements-dev.txt       # Development/testing dependencies
+└── README.md                  # Documentation
 ```
 
 ## Contributing
@@ -438,16 +460,28 @@ python scripts/release.py patch --no-push
 4. Install dependencies:
    ```bash
    pip install -r etsy_python/requirements.txt
+   pip install -r requirements-dev.txt
+   ```
+5. Run the test suite:
+   ```bash
+   pytest -v
+   pytest --cov=etsy_python --cov-report=term-missing
    ```
-5. Create a feature branch:
+6. Create a feature branch:
    ```bash
    git checkout -b feature/your-feature-name
    ```
-6. Make your changes and commit:
+7. Make your changes and commit:
    ```bash
-   git commit -m "Add your feature"
+   git commit -m "feat: add your feature"
    ```
-7. Push and create a pull request
+8. Push and create a pull request
+
+### CI on Pull Requests
+
+Pull requests automatically trigger:
+- **pr-tests.yml** — Runs the full test suite with coverage reporting (posts/updates a comment on the PR)
+- **pr-coverage.yml** — SDK coverage audit against the Etsy OAS spec (triggered by the `sdk-check` label)
 
 ## Support
 

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/_version.py

@@ -1,3 +1,3 @@
 """Version information for etsy-python package."""
 
-__version__ = "1.0.20"
+__version__ = "1.1.0"

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/common/Utils.py

@@ -2,14 +2,15 @@ from enum import Enum
 from typing import Any, Dict, List, Optional
 
 
-def generate_get_uri(uri: str, **kwargs: Dict[str, Any]) -> str:
-    if kwargs == {} or kwargs is None:
+def generate_get_uri(uri: str, params: Optional[Dict[str, Any]] = None) -> str:
+    if not params:
         return uri
-    params = "&".join(
-        [f"{key}={value}" for key, value in kwargs.items() if value is not None]
+    formatted = "&".join(
+        f"{key}={str(value).lower() if isinstance(value, bool) else value}"
+        for key, value in params.items()
+        if value is not None
     )
-    uri = f"{uri}?{params}" if params != "" else uri
-    return uri
+    return f"{uri}?{formatted}" if formatted else uri
 
 
 def todict(
@@ -31,9 +32,10 @@ def todict(
     elif hasattr(obj, "__dict__"):
         data = dict(
             [
+                # _type -> "type": avoids shadowing Python's builtin in model attrs
                 ("type" if key == "_type" else key, todict(value, classkey))
                 if key not in nullable
-                and (value not in [[], "" or 0] or isinstance(value, bool))
+                or (value != [] and value != "" and (value != 0 or isinstance(value, bool)))
                 else (key, None)
                 for key, value in obj.__dict__.items()
                 if not callable(value)

etsy_python-1.1.0/etsy_python/v3/enums/HolidayPreferences.py

@@ -0,0 +1,42 @@
+from enum import Enum
+
+"""
+Reference:
+Official Documentation: https://developer.etsy.com/documentation/tutorials/fulfillment/#country-holidays
+"""
+
+class HOLIDAYS(Enum):
+    """
+    # Note:
+    Integer values from 1 to 105 are supported by Etsy based on selected regions.
+    Use US_HOLIDAYS or CA_HOLIDAYS for named constants, or pass integer IDs directly
+    for holidays not yet mapped to named constants.
+    """
+    pass
+
+class US_HOLIDAYS(Enum):
+    NEW_YEARS_DAY = 1
+    MARTIN_LUTHER_KING_JR_DAY = 2
+    PRESIDENTS_DAY = 3
+    MEMORIAL_DAY = 4
+    JUNETEENTH = 5
+    INDEPENDENCE_DAY = 6
+    LABOR_DAY = 7
+    COLUMBUS_DAY = 8
+    VETERANS_DAY = 9
+    THANKSGIVING_DAY = 10
+    CHRISTMAS_DAY = 11
+
+class CA_HOLIDAYS(Enum):
+    GOOD_FRIDAY = 12
+    EASTER = 13
+    VICTORIA_DAY = 14
+    CANADA_DAY = 15
+    TRUTH_AND_RECONCILIATION_DAY = 16
+    REMEMBRANCE_DAY = 17
+    CIVIC_HOLIDAY = 18
+    BOXING_DAY = 19
+    NEW_YEARS_DAY = 20
+    LABOR_DAY = 21
+    THANKSGIVING_DAY = 22
+    CHRISTMAS_DAY = 23

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/enums/Listing.py

@@ -9,11 +9,11 @@ class WhoMade(Enum):
 
 class WhenMade(Enum):
     MADE_TO_ORDER = "made_to_order"
-    TWENTY_TWENTIES = "2020_2025"
+    TWENTY_TWENTIES = "2020_2026"
     TWENTY_TENS = "2010_2019"
-    TWENTY_OH_SIX_TO_NINE = "2006_2009"
-    BEFORE_2006 = "before_2006"
-    TWO_THOUSAND_TO_FIVE = "2000_2005"
+    TWENTY_OH_SEVEN_TO_NINE = "2007_2009"
+    BEFORE_2007 = "before_2007"
+    TWO_THOUSAND_TO_SIX = "2000_2006"
     NINETEEN_NINETIES = "1990s"
     NINETEEN_EIGHTIES = "1980s"
     NINETEEN_SEVENTIES = "1970s"
@@ -58,6 +58,14 @@ class State(Enum):
     SOLD_OUT = "sold_out"
     DRAFT = "draft"
     EXPIRED = "expired"
+    REMOVED = "removed"
+
+
+class VideoState(Enum):
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+    DELETED = "deleted"
+    FLAGGED = "flagged"
 
 
 class SortOn(Enum):

etsy_python-1.1.0/etsy_python/v3/enums/ProcessingProfile.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class ReadinessState(Enum):
+    READY_TO_SHIP = "ready_to_ship"
+    MADE_TO_ORDER = "made_to_order"
+
+
+class ProcessingTimeUnit(Enum):
+    DAYS = "days"
+    WEEKS = "weeks"

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/enums/ShippingProfile.py

@@ -13,8 +13,8 @@ class DestinationRegion(Enum):
 
 
 class Type(Enum):
-    ZERO = "0"  # Domestic Shipping
-    ONE = "1"  # International Shipping
+    ZERO = 0  # Domestic Shipping
+    ONE = 1  # International Shipping
 
 
 class Providers(Enum):

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/models/Listing.py

@@ -31,6 +31,7 @@ class CreateDraftListingRequest(Request):
         "item_dimensions_unit",
         "production_partner_ids",
         "image_ids",
+        "readiness_state_id",
     ]
     mandatory = [
         "quantity",
@@ -76,6 +77,7 @@ class CreateDraftListingRequest(Request):
         should_auto_renew: Optional[bool] = None,
         is_taxable: Optional[bool] = None,
         listing_type: Optional[Type] = None,
+        readiness_state_id: Optional[int] = None,
     ):
         self.quantity = quantity
         self.title = title
@@ -109,6 +111,7 @@ class CreateDraftListingRequest(Request):
         self.should_auto_renew = should_auto_renew
         self.is_taxable = is_taxable
         self._type = listing_type
+        self.readiness_state_id = readiness_state_id
         super().__init__(
             nullable=CreateDraftListingRequest.nullable,
             mandatory=CreateDraftListingRequest.mandatory,
@@ -201,7 +204,7 @@ class UpdateListingRequest(Request):
 
 
 class UpdateListingInventoryRequest(Request):
-    nullable: List[str] = []
+    nullable: List[str] = ["readiness_state_on_property"]
     mandatory: List[str] = ["products"]
 
     def __init__(
@@ -210,11 +213,13 @@ class UpdateListingInventoryRequest(Request):
         price_on_property: Optional[List[int]] = None,
         quantity_on_property: Optional[List[int]] = None,
         sku_on_property: Optional[List[int]] = None,
+        readiness_state_on_property: Optional[List[int]] = None,
     ):
         self.products = products
         self.price_on_property = price_on_property
         self.quantity_on_property = quantity_on_property
         self.sku_on_property = sku_on_property
+        self.readiness_state_on_property = readiness_state_on_property
         super().__init__(
             nullable=UpdateListingInventoryRequest.nullable,
             mandatory=UpdateListingInventoryRequest.mandatory,
@@ -349,6 +354,21 @@ class UpdateListingTranslationRequest(Request):
         )
 
 
+class UpdateListingPersonalizationRequest(Request):
+    nullable: List[str] = []
+    mandatory: List[str] = ["personalization_questions"]
+
+    def __init__(
+        self,
+        personalization_questions: Optional[List[Dict[str, Any]]] = None,
+    ):
+        self.personalization_questions = personalization_questions
+        super().__init__(
+            nullable=UpdateListingPersonalizationRequest.nullable,
+            mandatory=UpdateListingPersonalizationRequest.mandatory,
+        )
+
+
 class UpdateListingVideoRequest(FileRequest):
     nullable: List[str] = ["file"]
     mandatory: List[str] = []

etsy_python-1.1.0/etsy_python/v3/models/ProcessingProfile.py

@@ -0,0 +1,61 @@
+from typing import List, Optional
+
+from etsy_python.v3.enums.ProcessingProfile import ProcessingTimeUnit, ReadinessState
+from etsy_python.v3.models.Request import Request
+
+
+class CreateShopReadinessStateDefinitionRequest(Request):
+    nullable: List[str] = [
+        "processing_time_unit",
+    ]
+    mandatory: List[str] = [
+        "readiness_state",
+        "min_processing_time",
+        "max_processing_time",
+    ]
+
+    def __init__(
+        self,
+        readiness_state: Optional[ReadinessState] = None,
+        min_processing_time: Optional[int] = None,
+        max_processing_time: Optional[int] = None,
+        processing_time_unit: Optional[ProcessingTimeUnit] = None,
+    ):
+        self.readiness_state = readiness_state.value if readiness_state else None
+        self.min_processing_time = min_processing_time
+        self.max_processing_time = max_processing_time
+        self.processing_time_unit = (
+            processing_time_unit.value if processing_time_unit else None
+        )
+        super().__init__(
+            nullable=CreateShopReadinessStateDefinitionRequest.nullable,
+            mandatory=CreateShopReadinessStateDefinitionRequest.mandatory,
+        )
+
+
+class UpdateShopReadinessStateDefinitionRequest(Request):
+    nullable: List[str] = [
+        "readiness_state",
+        "min_processing_time",
+        "max_processing_time",
+        "processing_time_unit",
+    ]
+    mandatory: List[str] = []
+
+    def __init__(
+        self,
+        readiness_state: Optional[ReadinessState] = None,
+        min_processing_time: Optional[int] = None,
+        max_processing_time: Optional[int] = None,
+        processing_time_unit: Optional[ProcessingTimeUnit] = None,
+    ):
+        self.readiness_state = readiness_state.value if readiness_state else None
+        self.min_processing_time = min_processing_time
+        self.max_processing_time = max_processing_time
+        self.processing_time_unit = (
+            processing_time_unit.value if processing_time_unit else None
+        )
+        super().__init__(
+            nullable=UpdateShopReadinessStateDefinitionRequest.nullable,
+            mandatory=UpdateShopReadinessStateDefinitionRequest.mandatory,
+        )

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/models/Request.py

@@ -15,6 +15,7 @@ class Request:
             raise ValueError
 
     def check_mandatory(self) -> bool:
+        # Keys must match the attribute name (e.g. "_type", not "type").
         if self._mandatory is not None:
             for key in self._mandatory:
                 try:
@@ -28,7 +29,7 @@ class Request:
         return [
             key
             for key, value in self.__dict__.items()
-            if key in self._nullable and (value == [] or value == "" or value == 0)
+            if key in self._nullable and (value == [] or value == "" or (value == 0 and not isinstance(value, bool)))
         ]
 
     def get_dict(self) -> Any:

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/models/ShippingProfile.py

@@ -10,6 +10,8 @@ from etsy_python.v3.models.Request import Request
 
 class CreateShopShippingProfileRequest(Request):
     nullable: List[str] = [
+        "min_processing_time",
+        "max_processing_time",
         "destination_country_iso",
         "mail_class",
         "min_delivery_days",
@@ -20,8 +22,6 @@ class CreateShopShippingProfileRequest(Request):
         "origin_country_iso",
         "primary_cost",
         "secondary_cost",
-        "min_processing_time",
-        "max_processing_time",
     ]
 
     def __init__(
@@ -131,7 +131,8 @@ class CreateShopShippingProfileDestinationRequest(Request):
 class UpdateShopShippingProfileDestinationRequest(Request):
     nullable: List[str] = [
         "primary_cost",
-        "secondary_cost" "destination_country_iso",
+        "secondary_cost",
+        "destination_country_iso",
         "shipping_carrier_id",
         "mail_class",
         "min_delivery_days",
@@ -172,7 +173,7 @@ class CreateShopShippingProfileUpgradeRequest(Request):
         "max_delivery_days",
     ]
     mandatory: List[str] = [
-        "type",
+        "_type",
         "upgrade_name",
         "price",
         "secondary_price",
@@ -189,6 +190,8 @@ class CreateShopShippingProfileUpgradeRequest(Request):
         min_delivery_days: Optional[int] = None,
         max_delivery_days: Optional[int] = None,
     ) -> None:
+        # Stored as _type to avoid shadowing Python's builtin `type`.
+        # todict() maps _type -> "type" for API serialization.
         self._type = profile_type.value if profile_type else None
         self.upgrade_name = upgrade_name
         self.price = price
@@ -209,7 +212,8 @@ class UpdateShopShippingProfileUpgradeRequest(Request):
         "upgrade_name",
         "price",
         "secondary_price",
-        "shipping_carrier_id" "mail_class",
+        "shipping_carrier_id",
+        "mail_class",
         "min_delivery_days",
         "max_delivery_days",
     ]
@@ -227,6 +231,8 @@ class UpdateShopShippingProfileUpgradeRequest(Request):
         max_delivery_days: Optional[int] = None,
     ) -> None:
         self.upgrade_name = upgrade_name
+        # Stored as _type to avoid shadowing Python's builtin `type`.
+        # todict() maps _type -> "type" for API serialization.
         self._type = profile_type.value if profile_type else None
         self.price = price
         self.secondary_price = secondary_price

{etsy_python-1.0.20 → etsy_python-1.1.0}/etsy_python/v3/resources/HolidayPreferences.py

@@ -20,7 +20,7 @@ class HolidayPreferencesResource:
     def update_holiday_preferences(
         self,
         shop_id: int,
-        holiday_id: Optional[Union[HOLIDAYS, US_HOLIDAYS, CA_HOLIDAYS, str]],
+        holiday_id: Optional[Union[HOLIDAYS, US_HOLIDAYS, CA_HOLIDAYS, int]],
         holiday_preference: UpdateHolidayPreferencesRequest,
     ) -> Union[Response, RequestException]:
         endpoint = f"/shops/{shop_id}/holiday-preferences/{holiday_id}"