dodopayments 1.34.2__py3-none-any.whl → 1.37.0__py3-none-any.whl

dodopayments/types/discount_update_params.py

@@ -37,5 +37,6 @@ class DiscountUpdateParams(TypedDict, total=False):
     """
 
     type: Optional[DiscountType]
+    """If present, update the discount type."""
 
     usage_limit: Optional[int]

dodopayments/types/dispute.py

@@ -30,8 +30,10 @@ class Dispute(BaseModel):
     """The unique identifier of the dispute."""
 
     dispute_stage: DisputeStage
+    """The current stage of the dispute process."""
 
     dispute_status: DisputeStatus
+    """The current status of the dispute."""
 
     payment_id: str
     """The unique identifier of the payment associated with the dispute."""

dodopayments/types/dispute_list_params.py

@@ -2,35 +2,41 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import Union
 from datetime import datetime
-from typing_extensions import Annotated, TypedDict
+from typing_extensions import Literal, Annotated, TypedDict
 
 from .._utils import PropertyInfo
-from .dispute_stage import DisputeStage
-from .dispute_status import DisputeStatus
 
 __all__ = ["DisputeListParams"]
 
 
 class DisputeListParams(TypedDict, total=False):
-    created_at_gte: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    created_at_gte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
     """Get events after this created time"""
 
-    created_at_lte: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    created_at_lte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
     """Get events created before this time"""
 
-    customer_id: Optional[str]
+    customer_id: str
     """Filter by customer_id"""
 
-    dispute_stage: Optional[DisputeStage]
+    dispute_stage: Literal["pre_dispute", "dispute", "pre_arbitration"]
     """Filter by dispute stage"""
 
-    dispute_status: Optional[DisputeStatus]
+    dispute_status: Literal[
+        "dispute_opened",
+        "dispute_expired",
+        "dispute_accepted",
+        "dispute_cancelled",
+        "dispute_challenged",
+        "dispute_won",
+        "dispute_lost",
+    ]
     """Filter by dispute status"""
 
-    page_number: Optional[int]
+    page_number: int
     """Page number default is 0"""
 
-    page_size: Optional[int]
+    page_size: int
     """Page size default is 10 max is 100"""

dodopayments/types/dispute_list_response.py

@@ -29,8 +29,10 @@ class DisputeListResponse(BaseModel):
     """The unique identifier of the dispute."""
 
     dispute_stage: DisputeStage
+    """The current stage of the dispute process."""
 
     dispute_status: DisputeStatus
+    """The current status of the dispute."""
 
     payment_id: str
     """The unique identifier of the payment associated with the dispute."""

dodopayments/types/dispute_retrieve_response.py

@@ -28,13 +28,16 @@ class DisputeRetrieveResponse(BaseModel):
     """The currency of the disputed amount, represented as an ISO 4217 currency code."""
 
     customer: CustomerLimitedDetails
+    """The customer who filed the dispute"""
 
     dispute_id: str
     """The unique identifier of the dispute."""
 
     dispute_stage: DisputeStage
+    """The current stage of the dispute process."""
 
     dispute_status: DisputeStatus
+    """The current status of the dispute."""
 
     payment_id: str
     """The unique identifier of the payment associated with the dispute."""

dodopayments/types/license_key.py

@@ -35,6 +35,7 @@ class LicenseKey(BaseModel):
     """The unique identifier of the product associated with the license key."""
 
     status: LicenseKeyStatus
+    """The current status of the license key (e.g., active, inactive, expired)."""
 
     activations_limit: Optional[int] = None
     """The maximum number of activations allowed for this license key."""

dodopayments/types/license_key_list_params.py

@@ -2,26 +2,23 @@
 
 from __future__ import annotations
 
-from typing import Optional
-from typing_extensions import TypedDict
-
-from .license_key_status import LicenseKeyStatus
+from typing_extensions import Literal, TypedDict
 
 __all__ = ["LicenseKeyListParams"]
 
 
 class LicenseKeyListParams(TypedDict, total=False):
-    customer_id: Optional[str]
+    customer_id: str
     """Filter by customer ID"""
 
-    page_number: Optional[int]
+    page_number: int
     """Page number default is 0"""
 
-    page_size: Optional[int]
+    page_size: int
     """Page size default is 10 max is 100"""
 
-    product_id: Optional[str]
+    product_id: str
     """Filter by product ID"""
 
-    status: Optional[LicenseKeyStatus]
+    status: Literal["active", "expired", "disabled"]
     """Filter by license key status"""

dodopayments/types/payment.py

@@ -23,6 +23,7 @@ class ProductCart(BaseModel):
 
 class Payment(BaseModel):
     billing: BillingAddress
+    """Billing address details for payments"""
 
     brand_id: str
     """brand id this payment belongs to"""
@@ -34,8 +35,10 @@ class Payment(BaseModel):
     """Timestamp when the payment was created"""
 
     currency: Currency
+    """Currency used for the payment"""
 
     customer: CustomerLimitedDetails
+    """Details about the customer who made the payment"""
 
     digital_products_delivered: bool
     """brand id this payment belongs to"""
@@ -44,6 +47,7 @@ class Payment(BaseModel):
     """List of disputes associated with this payment"""
 
     metadata: Dict[str, str]
+    """Additional custom data associated with the payment"""
 
     payment_id: str
     """Unique identifier for the payment"""
@@ -59,6 +63,11 @@ class Payment(BaseModel):
     """
 
     settlement_currency: Currency
+    """
+    The currency in which the settlement_amount will be credited to your Dodo
+    balance. This may differ from the customer's payment currency in adaptive
+    pricing scenarios.
+    """
 
     total_amount: int
     """
@@ -67,7 +76,7 @@ class Payment(BaseModel):
     """
 
     card_issuing_country: Optional[CountryCode] = None
-    """ISO country code alpha2 variant"""
+    """ISO2 country code of the card"""
 
     card_last_four: Optional[str] = None
     """The last four digits of the card"""
@@ -107,6 +116,7 @@ class Payment(BaseModel):
     """
 
     status: Optional[IntentStatus] = None
+    """Current status of the payment intent"""
 
     subscription_id: Optional[str] = None
     """Identifier of the subscription if payment is part of a subscription"""

dodopayments/types/payment_create_params.py

@@ -15,8 +15,10 @@ __all__ = ["PaymentCreateParams"]
 
 class PaymentCreateParams(TypedDict, total=False):
     billing: Required[BillingAddressParam]
+    """Billing address details for the payment"""
 
     customer: Required[CustomerRequestParam]
+    """Customer information for the payment"""
 
     product_cart: Required[Iterable[OneTimeProductCartItemParam]]
     """List of products in the cart. Must contain at least 1 and at most 100 items."""
@@ -54,11 +56,19 @@ class PaymentCreateParams(TypedDict, total=False):
     """
 
     billing_currency: Optional[Currency]
+    """
+    Fix the currency in which the end customer is billed. If Dodo Payments cannot
+    support that currency for this transaction, it will not proceed
+    """
 
     discount_code: Optional[str]
     """Discount Code to apply to the transaction"""
 
     metadata: Dict[str, str]
+    """
+    Additional metadata associated with the payment. Defaults to empty if not
+    provided.
+    """
 
     payment_link: Optional[bool]
     """Whether to generate a payment link. Defaults to false if not specified."""

dodopayments/types/payment_create_response.py

@@ -1,6 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from typing import Dict, List, Optional
+from datetime import datetime
 
 from .._models import BaseModel
 from .customer_limited_details import CustomerLimitedDetails
@@ -17,8 +18,10 @@ class PaymentCreateResponse(BaseModel):
     """
 
     customer: CustomerLimitedDetails
+    """Limited details about the customer making the payment"""
 
     metadata: Dict[str, str]
+    """Additional metadata associated with the payment"""
 
     payment_id: str
     """Unique identifier for the payment"""
@@ -29,6 +32,9 @@ class PaymentCreateResponse(BaseModel):
     discount_id: Optional[str] = None
     """The discount id if discount is applied"""
 
+    expires_on: Optional[datetime] = None
+    """Expiry timestamp of the payment link"""
+
     payment_link: Optional[str] = None
     """Optional URL to a hosted payment page"""
 

dodopayments/types/payment_list_params.py

@@ -2,37 +2,48 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import Union
 from datetime import datetime
-from typing_extensions import Annotated, TypedDict
+from typing_extensions import Literal, Annotated, TypedDict
 
 from .._utils import PropertyInfo
-from .intent_status import IntentStatus
 
 __all__ = ["PaymentListParams"]
 
 
 class PaymentListParams(TypedDict, total=False):
-    brand_id: Optional[str]
+    brand_id: str
     """filter by Brand id"""
 
-    created_at_gte: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    created_at_gte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
     """Get events after this created time"""
 
-    created_at_lte: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    created_at_lte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
     """Get events created before this time"""
 
-    customer_id: Optional[str]
+    customer_id: str
     """Filter by customer id"""
 
-    page_number: Optional[int]
+    page_number: int
     """Page number default is 0"""
 
-    page_size: Optional[int]
+    page_size: int
     """Page size default is 10 max is 100"""
 
-    status: Optional[IntentStatus]
+    status: Literal[
+        "succeeded",
+        "failed",
+        "cancelled",
+        "processing",
+        "requires_customer_action",
+        "requires_merchant_action",
+        "requires_payment_method",
+        "requires_confirmation",
+        "requires_capture",
+        "partially_captured",
+        "partially_captured_and_capturable",
+    ]
     """Filter by status"""
 
-    subscription_id: Optional[str]
+    subscription_id: str
     """Filter by subscription id"""

dodopayments/types/payout_list_params.py

@@ -2,15 +2,14 @@
 
 from __future__ import annotations
 
-from typing import Optional
 from typing_extensions import TypedDict
 
 __all__ = ["PayoutListParams"]
 
 
 class PayoutListParams(TypedDict, total=False):
-    page_number: Optional[int]
+    page_number: int
     """Page number default is 0"""
 
-    page_size: Optional[int]
+    page_size: int
     """Page size default is 10 max is 100"""

dodopayments/types/payout_list_response.py

@@ -24,6 +24,7 @@ class PayoutListResponse(BaseModel):
     """The timestamp when the payout was created, in UTC."""
 
     currency: Currency
+    """The currency of the payout, represented as an ISO 4217 currency code."""
 
     fee: int
     """The fee charged for processing the payout."""
@@ -38,6 +39,7 @@ class PayoutListResponse(BaseModel):
     """The total value of refunds associated with the payout."""
 
     status: Literal["not_initiated", "in_progress", "on_hold", "failed", "success"]
+    """The current status of the payout."""
 
     tax: int
     """The tax applied to the payout."""

dodopayments/types/price.py

@@ -1,9 +1,8 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from typing import Union, Optional
-from typing_extensions import Literal, Annotated, TypeAlias
+from typing_extensions import Literal, TypeAlias
 
-from .._utils import PropertyInfo
 from .._models import BaseModel
 from .currency import Currency
 from .time_interval import TimeInterval
@@ -13,6 +12,7 @@ __all__ = ["Price", "OneTimePrice", "RecurringPrice"]
 
 class OneTimePrice(BaseModel):
     currency: Currency
+    """The currency in which the payment is made."""
 
     discount: float
     """Discount applied to the price, represented as a percentage (0 to 100)."""
@@ -53,6 +53,7 @@ class OneTimePrice(BaseModel):
 
 class RecurringPrice(BaseModel):
     currency: Currency
+    """The currency in which the payment is made."""
 
     discount: float
     """Discount applied to the price, represented as a percentage (0 to 100)."""
@@ -64,6 +65,7 @@ class RecurringPrice(BaseModel):
     """
 
     payment_frequency_interval: TimeInterval
+    """The time interval for the payment frequency (e.g., day, month, year)."""
 
     price: int
     """The payment amount.
@@ -85,6 +87,7 @@ class RecurringPrice(BaseModel):
     """
 
     subscription_period_interval: TimeInterval
+    """The time interval for the subscription period (e.g., day, month, year)."""
 
     type: Literal["recurring_price"]
 
@@ -95,4 +98,4 @@ class RecurringPrice(BaseModel):
     """Number of days for the trial period. A value of `0` indicates no trial period."""
 
 
-Price: TypeAlias = Annotated[Union[OneTimePrice, RecurringPrice], PropertyInfo(discriminator="type")]
+Price: TypeAlias = Union[OneTimePrice, RecurringPrice]

dodopayments/types/price_param.py

@@ -13,6 +13,7 @@ __all__ = ["PriceParam", "OneTimePrice", "RecurringPrice"]
 
 class OneTimePrice(TypedDict, total=False):
     currency: Required[Currency]
+    """The currency in which the payment is made."""
 
     discount: Required[float]
     """Discount applied to the price, represented as a percentage (0 to 100)."""
@@ -53,6 +54,7 @@ class OneTimePrice(TypedDict, total=False):
 
 class RecurringPrice(TypedDict, total=False):
     currency: Required[Currency]
+    """The currency in which the payment is made."""
 
     discount: Required[float]
     """Discount applied to the price, represented as a percentage (0 to 100)."""
@@ -64,6 +66,7 @@ class RecurringPrice(TypedDict, total=False):
     """
 
     payment_frequency_interval: Required[TimeInterval]
+    """The time interval for the payment frequency (e.g., day, month, year)."""
 
     price: Required[int]
     """The payment amount.
@@ -85,6 +88,7 @@ class RecurringPrice(TypedDict, total=False):
     """
 
     subscription_period_interval: Required[TimeInterval]
+    """The time interval for the subscription period (e.g., day, month, year)."""
 
     type: Required[Literal["recurring_price"]]
 

dodopayments/types/product.py

@@ -46,15 +46,13 @@ class Product(BaseModel):
     """Indicates whether the product requires a license key."""
 
     price: Price
+    """Pricing information for the product."""
 
     product_id: str
     """Unique identifier for the product."""
 
     tax_category: TaxCategory
-    """
-    Represents the different categories of taxation applicable to various products
-    and services.
-    """
+    """Tax category associated with the product."""
 
     updated_at: datetime
     """Timestamp when the product was last updated."""
@@ -77,6 +75,7 @@ class Product(BaseModel):
     """Limit on the number of activations for the license key, if enabled."""
 
     license_key_duration: Optional[LicenseKeyDuration] = None
+    """Duration of the license key validity, if enabled."""
 
     name: Optional[str] = None
     """Name of the product, optional."""

dodopayments/types/product_create_params.py

@@ -14,12 +14,10 @@ __all__ = ["ProductCreateParams", "DigitalProductDelivery"]
 
 class ProductCreateParams(TypedDict, total=False):
     price: Required[PriceParam]
+    """Price configuration for the product"""
 
     tax_category: Required[TaxCategory]
-    """
-    Represents the different categories of taxation applicable to various products
-    and services.
-    """
+    """Tax category applied to this product"""
 
     addons: Optional[List[str]]
     """Addons available for subscription product"""
@@ -31,6 +29,7 @@ class ProductCreateParams(TypedDict, total=False):
     """Optional description of the product"""
 
     digital_product_delivery: Optional[DigitalProductDelivery]
+    """Choose how you would like you digital product delivered"""
 
     license_key_activation_message: Optional[str]
     """Optional message displayed during license key activation"""
@@ -39,6 +38,11 @@ class ProductCreateParams(TypedDict, total=False):
     """The number of times the license key can be activated. Must be 0 or greater"""
 
     license_key_duration: Optional[LicenseKeyDurationParam]
+    """
+    Duration configuration for the license key. Set to null if you don't want the
+    license key to expire. For subscriptions, the lifetime of the license key is
+    tied to the subscription period
+    """
 
     license_key_enabled: Optional[bool]
     """

dodopayments/types/product_list_params.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from typing import Optional
 from typing_extensions import TypedDict
 
 __all__ = ["ProductListParams"]
@@ -12,16 +11,16 @@ class ProductListParams(TypedDict, total=False):
     archived: bool
     """List archived products"""
 
-    brand_id: Optional[str]
+    brand_id: str
     """filter by Brand id"""
 
-    page_number: Optional[int]
+    page_number: int
     """Page number default is 0"""
 
-    page_size: Optional[int]
+    page_size: int
     """Page size default is 10 max is 100"""
 
-    recurring: Optional[bool]
+    recurring: bool
     """Filter products by pricing type:
 
     - `true`: Show only recurring pricing products (e.g. subscriptions)

dodopayments/types/product_list_response.py

@@ -25,15 +25,13 @@ class ProductListResponse(BaseModel):
     """Unique identifier for the product."""
 
     tax_category: TaxCategory
-    """
-    Represents the different categories of taxation applicable to various products
-    and services.
-    """
+    """Tax category associated with the product."""
 
     updated_at: datetime
     """Timestamp when the product was last updated."""
 
     currency: Optional[Currency] = None
+    """Currency of the price"""
 
     description: Optional[str] = None
     """Description of the product, optional."""
@@ -58,6 +56,7 @@ class ProductListResponse(BaseModel):
     """
 
     price_detail: Optional[Price] = None
+    """Details of the price"""
 
     tax_inclusive: Optional[bool] = None
     """Indicates if the price is tax inclusive"""

dodopayments/types/product_update_params.py

@@ -22,6 +22,7 @@ class ProductUpdateParams(TypedDict, total=False):
     """Description of the product, optional and must be at most 1000 characters."""
 
     digital_product_delivery: Optional[DigitalProductDelivery]
+    """Choose how you would like you digital product delivered"""
 
     image_id: Optional[str]
     """Product image id after its uploaded to S3"""
@@ -41,6 +42,11 @@ class ProductUpdateParams(TypedDict, total=False):
     """
 
     license_key_duration: Optional[LicenseKeyDurationParam]
+    """Duration of the license key if enabled.
+
+    Only applicable if `license_key_enabled` is `true`. Represents the duration in
+    days for which the license key is valid.
+    """
 
     license_key_enabled: Optional[bool]
     """Whether the product requires a license key.
@@ -53,12 +59,10 @@ class ProductUpdateParams(TypedDict, total=False):
     """Name of the product, optional and must be at most 100 characters."""
 
     price: Optional[PriceParam]
+    """Price details of the product."""
 
     tax_category: Optional[TaxCategory]
-    """
-    Represents the different categories of taxation applicable to various products
-    and services.
-    """
+    """Tax category of the product."""
 
 
 class DigitalProductDelivery(TypedDict, total=False):

dodopayments/types/products/image_update_params.py

@@ -2,11 +2,10 @@
 
 from __future__ import annotations
 
-from typing import Optional
 from typing_extensions import TypedDict
 
 __all__ = ["ImageUpdateParams"]
 
 
 class ImageUpdateParams(TypedDict, total=False):
-    force_update: Optional[bool]
+    force_update: bool

dodopayments/types/refund.py

@@ -27,11 +27,13 @@ class Refund(BaseModel):
     """The unique identifier of the refund."""
 
     status: RefundStatus
+    """The current status of the refund."""
 
     amount: Optional[int] = None
     """The refunded amount."""
 
     currency: Optional[Currency] = None
+    """The currency of the refund, represented as an ISO 4217 currency code."""
 
     reason: Optional[str] = None
     """The reason provided for the refund, if any. Optional."""

dodopayments/types/refund_list_params.py

@@ -2,31 +2,30 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import Union
 from datetime import datetime
-from typing_extensions import Annotated, TypedDict
+from typing_extensions import Literal, Annotated, TypedDict
 
 from .._utils import PropertyInfo
-from .refund_status import RefundStatus
 
 __all__ = ["RefundListParams"]
 
 
 class RefundListParams(TypedDict, total=False):
-    created_at_gte: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    created_at_gte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
     """Get events after this created time"""
 
-    created_at_lte: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    created_at_lte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
     """Get events created before this time"""
 
-    customer_id: Optional[str]
+    customer_id: str
     """Filter by customer_id"""
 
-    page_number: Optional[int]
+    page_number: int
     """Page number default is 0"""
 
-    page_size: Optional[int]
+    page_size: int
     """Page size default is 10 max is 100"""
 
-    status: Optional[RefundStatus]
+    status: Literal["succeeded", "failed", "pending", "review"]
     """Filter by status"""