etsy-python 1.1.7__tar.gz → 1.1.9__tar.gz

{etsy_python-1.1.7/etsy_python.egg-info → etsy_python-1.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etsy-python
-Version: 1.1.7
+Version: 1.1.9
 Summary: Etsy API Client Library for Python
 Author: Amit Ray
 Author-email: mail@amitray.dev

{etsy_python-1.1.7 → etsy_python-1.1.9}/etsy_python/_version.py

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

{etsy_python-1.1.7 → etsy_python-1.1.9}/etsy_python/v3/models/Listing.py

@@ -14,6 +14,42 @@ from etsy_python.v3.models.Request import Request
 from etsy_python.v3.models.FileRequest import FileRequest
 
 
+_PERSONALIZATION_DEPRECATION_MSG = (
+    "is_personalizable, personalization_is_required, "
+    "personalization_char_count_max, and personalization_instructions "
+    "are deprecated by the Etsy API and scheduled for removal. "
+    "Use the personalization endpoint (update_listing_personalization) "
+    "instead. See "
+    "https://developers.etsy.com/documentation/tutorials/personalization-migration "
+    "for migration details."
+)
+
+
+def _warn_if_personalization_used(
+    is_personalizable: Optional[bool],
+    personalization_is_required: Optional[bool],
+    personalization_char_count_max: Optional[int],
+    personalization_instructions: Optional[str],
+) -> None:
+    """Emit DeprecationWarning when a deprecated personalization field is actively set.
+
+    Falsy values (False, 0, empty string, None) match the API's documented
+    defaults and remain no-ops after the fields are removed, so they do not
+    trigger the warning.
+    """
+    if any([
+        is_personalizable,
+        personalization_is_required,
+        personalization_char_count_max,
+        personalization_instructions,
+    ]):
+        warnings.warn(
+            _PERSONALIZATION_DEPRECATION_MSG,
+            DeprecationWarning,
+            stacklevel=3,
+        )
+
+
 class CreateDraftListingRequest(Request):
     nullable = [
         "shipping_profile_id",
@@ -105,20 +141,12 @@ class CreateDraftListingRequest(Request):
         self.personalization_is_required = personalization_is_required
         self.personalization_char_count_max = personalization_char_count_max
         self.personalization_instructions = personalization_instructions
-        if any(v is not None for v in [
-            personalization_is_required, personalization_char_count_max,
+        _warn_if_personalization_used(
+            is_personalizable,
+            personalization_is_required,
+            personalization_char_count_max,
             personalization_instructions,
-        ]):
-            warnings.warn(
-                "personalization_is_required, personalization_char_count_max, and "
-                "personalization_instructions are deprecated by the Etsy API and "
-                "scheduled for removal. Use the personalization endpoint "
-                "(update_listing_personalization) instead. See "
-                "https://developers.etsy.com/documentation/tutorials/personalization-migration "
-                "for migration details.",
-                DeprecationWarning,
-                stacklevel=2,
-            )
+        )
         self.production_partner_ids = production_partner_ids
         self.image_ids = image_ids
         self.is_supply = is_supply
@@ -208,20 +236,12 @@ class UpdateListingRequest(Request):
         self.personalization_is_required = personalization_is_required
         self.personalization_char_count_max = personalization_char_count_max
         self.personalization_instructions = personalization_instructions
-        if any(v is not None for v in [
-            personalization_is_required, personalization_char_count_max,
+        _warn_if_personalization_used(
+            is_personalizable,
+            personalization_is_required,
+            personalization_char_count_max,
             personalization_instructions,
-        ]):
-            warnings.warn(
-                "personalization_is_required, personalization_char_count_max, and "
-                "personalization_instructions are deprecated by the Etsy API and "
-                "scheduled for removal. Use the personalization endpoint "
-                "(update_listing_personalization) instead. See "
-                "https://developers.etsy.com/documentation/tutorials/personalization-migration "
-                "for migration details.",
-                DeprecationWarning,
-                stacklevel=2,
-            )
+        )
         self.state = state
         self.is_supply = is_supply
         self.production_partner_ids = production_partner_ids

etsy_python-1.1.9/etsy_python/v3/models/Receipt.py

@@ -0,0 +1,102 @@
+from typing import List, Optional, TypedDict
+
+from etsy_python.v3.models.Request import Request
+
+
+class CustomsItem(TypedDict):
+    # HS_code preserves Etsy's spec casing (Harmonized System code); do not snake_case.
+    country_of_origin: Optional[str]
+    declared_value: Optional[float]
+    HS_code: Optional[str]
+
+
+class CreateReceiptShipmentRequest(Request):
+    # Spec marks these fields nullable: true. Strings + array are added so callers
+    # can pass empty values to clear them; floats are intentionally excluded so
+    # legitimate zero values (free label, zero duty) serialize as 0, not null.
+    nullable: List[str] = [
+        "mail_class",
+        "weight_units",
+        "dimension_units",
+        "shipping_label_currency",
+        "revenue_eligibility",
+        "ship_from_country",
+        "ship_to_country",
+        "incoterm",
+        "customs_data",
+        "duty_currency",
+        "ship_date",
+    ]
+    mandatory: List[str] = []
+
+    def __init__(
+        self,
+        tracking_code: Optional[str] = None,
+        carrier_name: Optional[str] = None,
+        send_bcc: Optional[bool] = None,
+        note_to_buyer: Optional[str] = None,
+        mail_class: Optional[str] = None,
+        weight: Optional[float] = None,
+        weight_units: Optional[str] = None,
+        length: Optional[float] = None,
+        width: Optional[float] = None,
+        height: Optional[float] = None,
+        dimension_units: Optional[str] = None,
+        shipping_label_cost: Optional[float] = None,
+        shipping_label_currency: Optional[str] = None,
+        revenue_eligibility: Optional[str] = None,
+        ship_from_country: Optional[str] = None,
+        ship_to_country: Optional[str] = None,
+        incoterm: Optional[str] = None,
+        customs_data: Optional[List[CustomsItem]] = None,
+        duty_amount: Optional[float] = None,
+        duty_currency: Optional[str] = None,
+        ship_date: Optional[str] = None,
+    ):
+        self.tracking_code = tracking_code
+        self.carrier_name = carrier_name
+        self.send_bcc = send_bcc
+        self.note_to_buyer = note_to_buyer
+        self.mail_class = mail_class
+        self.weight = weight
+        self.weight_units = weight_units
+        self.length = length
+        self.width = width
+        self.height = height
+        self.dimension_units = dimension_units
+        self.shipping_label_cost = shipping_label_cost
+        self.shipping_label_currency = shipping_label_currency
+        self.revenue_eligibility = revenue_eligibility
+        self.ship_from_country = ship_from_country
+        self.ship_to_country = ship_to_country
+        self.incoterm = incoterm
+        self.customs_data = customs_data
+        self.duty_amount = duty_amount
+        self.duty_currency = duty_currency
+        self.ship_date = ship_date
+
+        super().__init__(
+            nullable=CreateReceiptShipmentRequest.nullable,
+            mandatory=CreateReceiptShipmentRequest.mandatory,
+        )
+
+
+class UpdateShopReceiptRequest(Request):
+    nullable: List[str] = [
+        "was_shipped",
+        "was_paid",
+    ]
+    mandatory: List[str] = []
+
+    def __init__(
+        self,
+        was_shipped: Optional[bool] = None,
+        was_paid: Optional[bool] = None,
+    ):
+        self.was_shipped = was_shipped
+        self.was_paid = was_paid
+
+        super().__init__(
+            nullable=UpdateShopReceiptRequest.nullable,
+            mandatory=UpdateShopReceiptRequest.mandatory,
+        )

{etsy_python-1.1.7 → etsy_python-1.1.9/etsy_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etsy-python
-Version: 1.1.7
+Version: 1.1.9
 Summary: Etsy API Client Library for Python
 Author: Amit Ray
 Author-email: mail@amitray.dev

etsy_python-1.1.7/etsy_python/v3/models/Receipt.py

@@ -1,46 +0,0 @@
-from typing import List, Optional
-
-from etsy_python.v3.models.Request import Request
-
-
-class CreateReceiptShipmentRequest(Request):
-    nullable: List[str] = []
-    mandatory: List[str] = []
-
-    def __init__(
-        self,
-        tracking_code: Optional[str] = None,
-        carrier_name: Optional[str] = None,
-        send_bcc: Optional[bool] = None,
-        note_to_buyer: Optional[str] = None,
-    ):
-        self.tracking_code = tracking_code
-        self.carrier_name = carrier_name
-        self.send_bcc = send_bcc
-        self.note_to_buyer = note_to_buyer
-
-        super().__init__(
-            nullable=CreateReceiptShipmentRequest.nullable,
-            mandatory=CreateReceiptShipmentRequest.mandatory,
-        )
-
-
-class UpdateShopReceiptRequest(Request):
-    nullable: List[str] = [
-        "was_shipped",
-        "was_paid",
-    ]
-    mandatory: List[str] = []
-
-    def __init__(
-        self,
-        was_shipped: Optional[bool] = None,
-        was_paid: Optional[bool] = None,
-    ):
-        self.was_shipped = was_shipped
-        self.was_paid = was_paid
-
-        super().__init__(
-            nullable=UpdateShopReceiptRequest.nullable,
-            mandatory=UpdateShopReceiptRequest.mandatory,
-        )