recharge-api 2.0.2__tar.gz → 2.0.4__tar.gz

{recharge_api-2.0.2/recharge_api.egg-info → recharge_api-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: recharge-api
-Version: 2.0.2
+Version: 2.0.4
 Summary: Python API Client for Recharge
 Author-email: ChemicalLuck <j.tebbett@outlook.com>
 Project-URL: Homepage, http://github.com/ChemicalLuck/recharge-api
@@ -23,6 +23,7 @@ Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: responses; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
 Dynamic: license-file
 
 # Recharge API Wrapper

{recharge_api-2.0.2 → recharge_api-2.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "recharge-api"
-version = "2.0.2"
+version = "2.0.4"
 authors = [
 	{ name="ChemicalLuck", email="j.tebbett@outlook.com" }
 ]
@@ -20,7 +20,7 @@ classifiers = [
 dependencies = ["requests", "pydantic>=2.0"]
 
 [project.optional-dependencies]
-dev = ["ruff", "pre-commit", "pytest", "pytest-cov", "responses"]
+dev = ["ruff", "pre-commit", "pytest", "pytest-cov", "responses", "python-dotenv"]
 
 [project.urls]
 Homepage = "http://github.com/ChemicalLuck/recharge-api"

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v1/token.py

@@ -2,8 +2,6 @@ from typing import Optional
 
 from pydantic import BaseModel, ConfigDict
 
-from recharge.types import RechargeScope
-
 
 class TokenClient(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -18,4 +16,4 @@ class TokenInformation(BaseModel):
     client: Optional[TokenClient] = None
     contact_email: Optional[str] = None
     name: Optional[str] = None
-    scopes: list[RechargeScope] = []
+    scopes: list[str] = []

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/account.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from pydantic import BaseModel, ConfigDict
 
 
@@ -7,5 +9,5 @@ class Account(BaseModel):
     id: int
     user_id: int
     created_at: str
-    invited_at: str
+    invited_at: Optional[str] = None
     is_owner: bool

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/address.py

@@ -2,7 +2,7 @@ from typing import Literal, Optional
 
 from pydantic import BaseModel, ConfigDict
 
-AddressDiscountType = Literal["percentage", "fixed_amount"]
+AddressDiscountValueType = Literal["percentage", "fixed_amount"]
 
 
 class AddressOrderAttribute(BaseModel):
@@ -15,10 +15,10 @@ class AddressOrderAttribute(BaseModel):
 class AddressDiscount(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    id: Optional[str] = None
+    id: Optional[int] = None
     code: Optional[str] = None
-    value: Optional[int] = None
-    discount_type: Optional[AddressDiscountType] = None
+    value: Optional[float] = None
+    value_type: Optional[AddressDiscountValueType] = None
 
 
 class AddressNoteAttribute(BaseModel):

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/charge.py

@@ -24,14 +24,7 @@ class ChargeAnalyticsDataUtmParams(BaseModel):
 class ChargeAnalyticsData(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    utm_params: Optional[ChargeAnalyticsDataUtmParams] = None
-
-    @field_validator("utm_params", mode="before")
-    @classmethod
-    def coerce_utm_params(cls, v: Any) -> Any:
-        if isinstance(v, list):
-            return None
-        return v
+    utm_params: Optional[list[ChargeAnalyticsDataUtmParams]] = None
 
 
 class ChargeBillingAddress(BaseModel):
@@ -92,7 +85,7 @@ class ChargeExternalOrderId(BaseModel):
 class ChargeExternalTransactionId(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    ecommerce: Optional[str] = None
+    payment_processor: Optional[str] = None
 
 
 class ChargeLineItemImages(BaseModel):
@@ -128,8 +121,12 @@ class ChargeTaxLine(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     price: Optional[str] = None
-    rate: Optional[str] = None
+    rate: Optional[Union[str, float]] = None
     title: Optional[str] = None
+    unit_price: Optional[str] = None
+
+
+ChargeLineItemPurchaseItemType = Literal["subscription", "onetime"]
 
 
 class ChargeLineItem(BaseModel):
@@ -143,6 +140,7 @@ class ChargeLineItem(BaseModel):
     images: Optional[ChargeLineItemImages] = None
     original_price: Optional[str] = None
     properties: list[ChargeLineItemProperty] = []
+    purchase_item_type: Optional[ChargeLineItemPurchaseItemType] = None
     quantity: Optional[int] = None
     sku: Optional[str] = None
     tax_due: Optional[str] = None

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/collection.py

@@ -15,7 +15,7 @@ class Collection(BaseModel):
     description: Optional[str] = None
     sort_order: Optional[CollectionSortOrder] = None
     title: Optional[str] = None
-    type: Optional[Literal["manual"]] = None
+    type: Optional[str] = None
     updated_at: Optional[str] = None
 
 

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/customer.py

@@ -45,6 +45,7 @@ class Customer(BaseModel):
     hash: str
     last_name: str
     phone: Optional[str] = None
+    status: Optional[CustomerStatus] = None
     subscriptions_active_count: int
     subscriptions_total_count: int
     tax_exempt: bool
@@ -97,7 +98,7 @@ class CustomerDeliveryOrderLineItem(BaseModel):
     subscription_id: int
     external_product_id: CustomerDeliveryOrderLineItemExternalProductId
     external_variant_id: CustomerDeliveryOrderLineItemExternalVariantId
-    images: list[CustomerDeliveryOrderLineItemImage]
+    images: Optional[CustomerDeliveryOrderLineItemImage] = None
     is_prepaid: bool
     is_skippable: bool
     is_skipped: bool
@@ -167,7 +168,7 @@ class CustomerDeliveryOrder(BaseModel):
 
     id: Optional[int] = None
     address_id: int
-    charge_id: int
+    charge_id: Optional[int] = None
     line_items: list[CustomerDeliveryOrderLineItem]
     order_subtotal: str
     payment_method: CustomerDeliveryOrderPaymentMethod

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/discount.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Any, Literal, Optional, Union
 
 from pydantic import BaseModel, ConfigDict
 
@@ -10,7 +10,7 @@ DiscountAppliesToResource = Literal["shopify_product", "shopify_collection_id"]
 class DiscountAppliesTo(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    ids: Optional[list[str]] = None
+    ids: Optional[list[Union[str, int]]] = None
     purchase_item_type: Optional[DiscountAppliesToPurchaseItemType] = None
     resource: Optional[DiscountAppliesToResource] = None
 
@@ -21,7 +21,7 @@ DiscountProductType = Literal["ALL", "ONETIME", "SUBSCRIPTION"]
 class DiscountChannelSettingsValue(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    can_apply: bool
+    can_apply: Optional[bool] = None
 
 
 class DiscountChannelSettings(BaseModel):
@@ -44,9 +44,9 @@ class DiscountUsageLimits(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     one_application_per_customer: bool
-    first_time_customer_restriction: DiscountFirstTimeCustomerRestriction
-    max_subsequent_redemptions: int
-    redemptions: int
+    first_time_customer_restriction: Optional[Any] = None
+    max_subsequent_redemptions: Optional[int] = None
+    redemptions: Optional[int] = None
 
 
 DiscountStatus = Literal["enabled", "disabled", "fully_disabled"]
@@ -55,7 +55,7 @@ DiscountStatus = Literal["enabled", "disabled", "fully_disabled"]
 class DiscountExternalDiscountId(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    ecommerce: str
+    ecommerce: Optional[str] = None
 
 
 class Discount(BaseModel):

recharge_api-2.0.4/recharge/model/v2/event.py

@@ -0,0 +1,29 @@
+from typing import Any, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+
+class EventSource(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    account_id: Optional[Any] = None
+    api_token_id: Optional[Any] = None
+    api_token_name: Optional[str] = None
+    account_email: Optional[str] = None
+    origin: Optional[str] = None
+    user_type: Optional[str] = None
+
+
+class Event(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: int
+    object_id: int
+    customer_id: int
+    created_at: str
+    object_type: str
+    verb: str
+    description: str
+    updated_attributes: Any = None
+    source: Optional[EventSource] = None
+    custom_attributes: Any = None

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/onetime.py

@@ -33,7 +33,7 @@ class Onetime(BaseModel):
     external_variant_id: Optional[OnetimeExternalVariantId] = None
     is_cancelled: Optional[bool] = None
     next_charge_scheduled_at: Optional[str] = None
-    price: Optional[int] = None
+    price: Optional[str] = None
     product_title: Optional[str] = None
     properties: list[OnetimeProperty] = []
     quantity: Optional[int] = None

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/order.py

@@ -1,6 +1,6 @@
-from typing import Literal, Optional
+from typing import Any, Literal, Optional, Union
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, field_validator
 
 
 class OrderBillingAddress(BaseModel):
@@ -11,7 +11,7 @@ class OrderBillingAddress(BaseModel):
     address2: Optional[str] = None
     city: Optional[str] = None
     company: Optional[str] = None
-    country: Optional[str] = None
+    country_code: Optional[str] = None
     first_name: Optional[str] = None
     last_name: Optional[str] = None
     phone: Optional[str] = None
@@ -26,7 +26,7 @@ class OrderShippingAddress(BaseModel):
     address2: Optional[str] = None
     city: Optional[str] = None
     company: Optional[str] = None
-    country: Optional[str] = None
+    country_code: Optional[str] = None
     first_name: Optional[str] = None
     last_name: Optional[str] = None
     phone: Optional[str] = None
@@ -76,7 +76,7 @@ class OrderLineItemTaxLine(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     price: str
-    rate: str
+    rate: Union[str, float]
     title: str
 
 
@@ -119,7 +119,7 @@ OrderType = Literal["checkout", "recurring"]
 class OrderExternalTransactionId(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    ecommerce: str
+    payment_processor: Optional[str] = None
 
 
 class OrderExternalOrderNumber(BaseModel):
@@ -138,11 +138,11 @@ class OrderCharge(BaseModel):
 class OrderClientDetails(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    browser_ip: str
-    user_agent: str
+    browser_ip: Optional[str] = None
+    user_agent: Optional[str] = None
 
 
-OrderDiscountValueType = Literal["percentage", "fixed_amount"]
+OrderDiscountValueType = Literal["percentage", "fixed_amount", "shipping"]
 
 
 class OrderDiscount(BaseModel):
@@ -158,31 +158,38 @@ class OrderAttribute(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     name: str
-    value: str
+    value: Optional[str] = None
 
 
 class OrderTaxLine(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     price: str
-    rate: str
+    rate: Union[str, float]
     title: str
 
 
 class OrderShippingLine(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
-    code: str
-    price: str
-    source: str
-    title: str
-    taxable: bool
+    code: Optional[str] = None
+    price: Optional[str] = None
+    source: Optional[str] = None
+    title: Optional[str] = None
+    taxable: Optional[Union[str, bool]] = None
     tax_lines: list[OrderTaxLine] = []
 
 
 class Order(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
+    @field_validator("tags", mode="before")
+    @classmethod
+    def parse_tags(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            return [t.strip() for t in v.split(",") if t.strip()]
+        return v
+
     id: int
     address_id: int
     billing_address: Optional[OrderBillingAddress] = None
@@ -209,7 +216,7 @@ class Order(BaseModel):
     taxable: bool
     total_discounts: str
     total_duties: Optional[str] = None
-    total_line_items_price: Optional[int] = None
+    total_line_items_price: Optional[str] = None
     total_price: str
     total_tax: str
     total_weight_grams: int

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/payment_method.py

@@ -1,6 +1,6 @@
-from typing import Literal, Optional
+from typing import Any, Literal, Optional
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, field_validator
 
 PaymentMethodType = Literal[
     "CREDIT_CARD", "PAYPAL", "APPLE_PAY", "GOOGLE_PAY", "SEPA_DEBIT"
@@ -30,8 +30,8 @@ class PaymentMethodDetails(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     brand: Optional[str] = None
-    exp_month: Optional[str] = None
-    exp_year: Optional[str] = None
+    exp_month: Optional[int] = None
+    exp_year: Optional[int] = None
     last4: Optional[str] = None
     paypal_email: Optional[str] = None
     paypal_payer_id: Optional[str] = None
@@ -45,8 +45,16 @@ PaymentMethodStatus = Literal["unvalidated", "valid", "invalid", "empty"]
 class PaymentMethod(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
+    @field_validator("payment_type", mode="before")
+    @classmethod
+    def uppercase_payment_type(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            return v.upper()
+        return v
+
     id: int
     customer_id: int
+    billing_address: Optional[PaymentMethodBillingAddress] = None
     created_at: str
     default: bool
     payment_details: Optional[PaymentMethodDetails] = None

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/plan.py

@@ -40,14 +40,14 @@ class PlanSubscriptionPreferences(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     apply_cutoff_date_to_checkout: Optional[bool] = None
-    charge_interval_frequency: int
+    charge_interval_frequency: Optional[int] = None
     cutoff_day_of_month: Optional[int] = None
     cutoff_day_of_week: Optional[int] = None
     expire_after_specific_number_of_charges: Optional[int] = None
     order_day_of_month: Optional[int] = None
     order_day_of_week: Optional[int] = None
-    order_interval_frequency: int
-    interval_unit: PlanIntervalUnit
+    order_interval_frequency: Optional[int] = None
+    interval_unit: Optional[PlanIntervalUnit] = None
 
 
 class PlanChannelSettings(BaseModel):

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/retention_strategy.py

@@ -1,4 +1,4 @@
-from typing import Literal
+from typing import Literal, Optional
 
 from pydantic import BaseModel, ConfigDict
 
@@ -15,8 +15,8 @@ class RetentionStrategy(BaseModel):
     id: int
     cancellation_flow_type: RetentionStrategyCancellationFlowType
     created_at: str
-    discount_code: str
-    incentive_type: RetentionStrategyIncentiveType
+    discount_code: Optional[str] = None
+    incentive_type: Optional[RetentionStrategyIncentiveType] = None
     prevention_text: str
     reason: str
     updated_at: str

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/store.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from pydantic import BaseModel, ConfigDict
 
 
@@ -8,6 +10,14 @@ class StoreTimezone(BaseModel):
     name: str
 
 
+class StorePresentmentCurrencySymbol(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    currency: Optional[str] = None
+    locale_name: Optional[str] = None
+    symbol: Optional[str] = None
+
+
 class Store(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
@@ -20,7 +30,7 @@ class Store(BaseModel):
     default_api_version: str
     email: str
     enabled_presentment_currencies: list[str]
-    enabled_presentment_currencies_symbols: list[str]
+    enabled_presentment_currencies_symbols: list[StorePresentmentCurrencySymbol]
     disabled_currencies_historical: list[str]
     external_platform: str
     identifier: str

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/subscription.py

@@ -1,6 +1,6 @@
-from typing import Literal, Optional
+from typing import Any, Literal, Optional
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, field_validator
 
 SubscriptionOrderIntervalUnit = Literal["day", "week", "month"]
 
@@ -48,10 +48,18 @@ class SubscriptionExternalVariantId(BaseModel):
 class Subscription(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
+    @field_validator("status", mode="before")
+    @classmethod
+    def uppercase_status(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            return v.upper()
+        return v
+
     id: int
     address_id: int
     customer_id: int
     analytics_data: Optional[SubscriptionAnalyticsData] = None
+    plan_id: Optional[int] = None
     cancellation_reason: Optional[str] = None
     cancellation_reason_comment: Optional[str] = None
     cancelled_at: Optional[str] = None

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge/model/v2/token.py

@@ -1,7 +1,5 @@
 from pydantic import BaseModel, ConfigDict
 
-from recharge.types import RechargeScope
-
 
 class TokenClient(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -16,4 +14,4 @@ class TokenInformation(BaseModel):
     client: TokenClient
     contact_email: str
     name: str
-    scopes: list[RechargeScope]
+    scopes: list[str]

{recharge_api-2.0.2 → recharge_api-2.0.4/recharge_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: recharge-api
-Version: 2.0.2
+Version: 2.0.4
 Summary: Python API Client for Recharge
 Author-email: ChemicalLuck <j.tebbett@outlook.com>
 Project-URL: Homepage, http://github.com/ChemicalLuck/recharge-api
@@ -23,6 +23,7 @@ Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: responses; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
 Dynamic: license-file
 
 # Recharge API Wrapper

{recharge_api-2.0.2 → recharge_api-2.0.4}/recharge_api.egg-info/requires.txt

@@ -7,3 +7,4 @@ pre-commit
 pytest
 pytest-cov
 responses
+python-dotenv

recharge_api-2.0.2/recharge/model/v2/event.py

@@ -1,34 +0,0 @@
-from pydantic import BaseModel, ConfigDict
-
-
-class EventSource(BaseModel):
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    account_id: str
-    api_token_id: str
-    api_token_name: str
-    account_email: str
-    origin: str
-    user_type: str
-
-
-class EventCustomAttributes(BaseModel):
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    key: str
-    value: str
-
-
-class Event(BaseModel):
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: int
-    object_id: int
-    customer_id: int
-    created_at: str
-    object_type: str
-    verb: str
-    description: str
-    updated_attributes: dict
-    source: EventSource
-    custom_attributes: EventCustomAttributes