dodopayments 1.51.1__py3-none-any.whl → 1.56.5__py3-none-any.whl

dodopayments/__init__.py

@@ -3,7 +3,7 @@
 import typing as _t
 
 from . import types
-from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes
+from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes, omit, not_given
 from ._utils import file_from_path
 from ._client import (
     ENVIRONMENTS,
@@ -35,6 +35,7 @@ from ._exceptions import (
     InternalServerError,
     PermissionDeniedError,
     UnprocessableEntityError,
+    APIWebhookValidationError,
     APIResponseValidationError,
 )
 from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
@@ -49,13 +50,16 @@ __all__ = [
     "ProxiesTypes",
     "NotGiven",
     "NOT_GIVEN",
+    "not_given",
     "Omit",
+    "omit",
     "DodoPaymentsError",
     "APIError",
     "APIStatusError",
     "APITimeoutError",
     "APIConnectionError",
     "APIResponseValidationError",
+    "APIWebhookValidationError",
     "BadRequestError",
     "AuthenticationError",
     "PermissionDeniedError",

dodopayments/_base_client.py

@@ -42,7 +42,6 @@ from . import _exceptions
 from ._qs import Querystring
 from ._files import to_httpx_files, async_to_httpx_files
 from ._types import (
-    NOT_GIVEN,
     Body,
     Omit,
     Query,
@@ -57,9 +56,10 @@ from ._types import (
     RequestOptions,
     HttpxRequestFiles,
     ModelBuilderProtocol,
+    not_given,
 )
 from ._utils import is_dict, is_list, asyncify, is_given, lru_cache, is_mapping
-from ._compat import PYDANTIC_V2, model_copy, model_dump
+from ._compat import PYDANTIC_V1, model_copy, model_dump
 from ._models import GenericModel, FinalRequestOptions, validate_type, construct_type
 from ._response import (
     APIResponse,
@@ -145,9 +145,9 @@ class PageInfo:
     def __init__(
         self,
         *,
-        url: URL | NotGiven = NOT_GIVEN,
-        json: Body | NotGiven = NOT_GIVEN,
-        params: Query | NotGiven = NOT_GIVEN,
+        url: URL | NotGiven = not_given,
+        json: Body | NotGiven = not_given,
+        params: Query | NotGiven = not_given,
     ) -> None:
         self.url = url
         self.json = json
@@ -232,7 +232,7 @@ class BaseSyncPage(BasePage[_T], Generic[_T]):
         model: Type[_T],
         options: FinalRequestOptions,
     ) -> None:
-        if PYDANTIC_V2 and getattr(self, "__pydantic_private__", None) is None:
+        if (not PYDANTIC_V1) and getattr(self, "__pydantic_private__", None) is None:
             self.__pydantic_private__ = {}
 
         self._model = model
@@ -320,7 +320,7 @@ class BaseAsyncPage(BasePage[_T], Generic[_T]):
         client: AsyncAPIClient,
         options: FinalRequestOptions,
     ) -> None:
-        if PYDANTIC_V2 and getattr(self, "__pydantic_private__", None) is None:
+        if (not PYDANTIC_V1) and getattr(self, "__pydantic_private__", None) is None:
             self.__pydantic_private__ = {}
 
         self._model = model
@@ -595,7 +595,7 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
         # we internally support defining a temporary header to override the
         # default `cast_to` type for use with `.with_raw_response` and `.with_streaming_response`
         # see _response.py for implementation details
-        override_cast_to = headers.pop(OVERRIDE_CAST_TO_HEADER, NOT_GIVEN)
+        override_cast_to = headers.pop(OVERRIDE_CAST_TO_HEADER, not_given)
         if is_given(override_cast_to):
             options.headers = headers
             return cast(Type[ResponseT], override_cast_to)
@@ -825,7 +825,7 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
         version: str,
         base_url: str | URL,
         max_retries: int = DEFAULT_MAX_RETRIES,
-        timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.Client | None = None,
         custom_headers: Mapping[str, str] | None = None,
         custom_query: Mapping[str, object] | None = None,
@@ -1356,7 +1356,7 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
         base_url: str | URL,
         _strict_response_validation: bool,
         max_retries: int = DEFAULT_MAX_RETRIES,
-        timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.AsyncClient | None = None,
         custom_headers: Mapping[str, str] | None = None,
         custom_query: Mapping[str, object] | None = None,
@@ -1818,8 +1818,8 @@ def make_request_options(
     extra_query: Query | None = None,
     extra_body: Body | None = None,
     idempotency_key: str | None = None,
-    timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    post_parser: PostParser | NotGiven = NOT_GIVEN,
+    timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    post_parser: PostParser | NotGiven = not_given,
 ) -> RequestOptions:
     """Create a dict of type RequestOptions without keys of NotGiven values."""
     options: RequestOptions = {}

dodopayments/_client.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import os
-from typing import Any, Dict, Union, Mapping, cast
+from typing import Any, Dict, Mapping, cast
 from typing_extensions import Self, Literal, override
 
 import httpx
@@ -11,13 +11,13 @@ import httpx
 from . import _exceptions
 from ._qs import Querystring
 from ._types import (
-    NOT_GIVEN,
     Omit,
     Timeout,
     NotGiven,
     Transport,
     ProxiesTypes,
     RequestOptions,
+    not_given,
 )
 from ._utils import is_given, get_async_library
 from ._version import __version__
@@ -25,6 +25,7 @@ from .resources import (
     misc,
     addons,
     brands,
+    meters,
     payouts,
     refunds,
     disputes,
@@ -32,6 +33,7 @@ from .resources import (
     payments,
     discounts,
     license_keys,
+    usage_events,
     subscriptions,
     checkout_sessions,
     license_key_instances,
@@ -84,11 +86,14 @@ class DodoPayments(SyncAPIClient):
     addons: addons.AddonsResource
     brands: brands.BrandsResource
     webhooks: webhooks.WebhooksResource
+    usage_events: usage_events.UsageEventsResource
+    meters: meters.MetersResource
     with_raw_response: DodoPaymentsWithRawResponse
     with_streaming_response: DodoPaymentsWithStreamedResponse
 
     # client options
     bearer_token: str
+    webhook_key: str | None
 
     _environment: Literal["live_mode", "test_mode"] | NotGiven
 
@@ -96,9 +101,10 @@ class DodoPayments(SyncAPIClient):
         self,
         *,
         bearer_token: str | None = None,
-        environment: Literal["live_mode", "test_mode"] | NotGiven = NOT_GIVEN,
-        base_url: str | httpx.URL | None | NotGiven = NOT_GIVEN,
-        timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
+        webhook_key: str | None = None,
+        environment: Literal["live_mode", "test_mode"] | NotGiven = not_given,
+        base_url: str | httpx.URL | None | NotGiven = not_given,
+        timeout: float | Timeout | None | NotGiven = not_given,
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
@@ -118,7 +124,9 @@ class DodoPayments(SyncAPIClient):
     ) -> None:
         """Construct a new synchronous DodoPayments client instance.
 
-        This automatically infers the `bearer_token` argument from the `DODO_PAYMENTS_API_KEY` environment variable if it is not provided.
+        This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+        - `bearer_token` from `DODO_PAYMENTS_API_KEY`
+        - `webhook_key` from `DODO_PAYMENTS_WEBHOOK_KEY`
         """
         if bearer_token is None:
             bearer_token = os.environ.get("DODO_PAYMENTS_API_KEY")
@@ -128,6 +136,10 @@ class DodoPayments(SyncAPIClient):
             )
         self.bearer_token = bearer_token
 
+        if webhook_key is None:
+            webhook_key = os.environ.get("DODO_PAYMENTS_WEBHOOK_KEY")
+        self.webhook_key = webhook_key
+
         self._environment = environment
 
         base_url_env = os.environ.get("DODO_PAYMENTS_BASE_URL")
@@ -182,6 +194,8 @@ class DodoPayments(SyncAPIClient):
         self.addons = addons.AddonsResource(self)
         self.brands = brands.BrandsResource(self)
         self.webhooks = webhooks.WebhooksResource(self)
+        self.usage_events = usage_events.UsageEventsResource(self)
+        self.meters = meters.MetersResource(self)
         self.with_raw_response = DodoPaymentsWithRawResponse(self)
         self.with_streaming_response = DodoPaymentsWithStreamedResponse(self)
 
@@ -209,11 +223,12 @@ class DodoPayments(SyncAPIClient):
         self,
         *,
         bearer_token: str | None = None,
+        webhook_key: str | None = None,
         environment: Literal["live_mode", "test_mode"] | None = None,
         base_url: str | httpx.URL | None = None,
-        timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.Client | None = None,
-        max_retries: int | NotGiven = NOT_GIVEN,
+        max_retries: int | NotGiven = not_given,
         default_headers: Mapping[str, str] | None = None,
         set_default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
@@ -244,6 +259,7 @@ class DodoPayments(SyncAPIClient):
         http_client = http_client or self._client
         return self.__class__(
             bearer_token=bearer_token or self.bearer_token,
+            webhook_key=webhook_key or self.webhook_key,
             base_url=base_url or self.base_url,
             environment=environment or self._environment,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
@@ -310,11 +326,14 @@ class AsyncDodoPayments(AsyncAPIClient):
     addons: addons.AsyncAddonsResource
     brands: brands.AsyncBrandsResource
     webhooks: webhooks.AsyncWebhooksResource
+    usage_events: usage_events.AsyncUsageEventsResource
+    meters: meters.AsyncMetersResource
     with_raw_response: AsyncDodoPaymentsWithRawResponse
     with_streaming_response: AsyncDodoPaymentsWithStreamedResponse
 
     # client options
     bearer_token: str
+    webhook_key: str | None
 
     _environment: Literal["live_mode", "test_mode"] | NotGiven
 
@@ -322,9 +341,10 @@ class AsyncDodoPayments(AsyncAPIClient):
         self,
         *,
         bearer_token: str | None = None,
-        environment: Literal["live_mode", "test_mode"] | NotGiven = NOT_GIVEN,
-        base_url: str | httpx.URL | None | NotGiven = NOT_GIVEN,
-        timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
+        webhook_key: str | None = None,
+        environment: Literal["live_mode", "test_mode"] | NotGiven = not_given,
+        base_url: str | httpx.URL | None | NotGiven = not_given,
+        timeout: float | Timeout | None | NotGiven = not_given,
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
@@ -344,7 +364,9 @@ class AsyncDodoPayments(AsyncAPIClient):
     ) -> None:
         """Construct a new async AsyncDodoPayments client instance.
 
-        This automatically infers the `bearer_token` argument from the `DODO_PAYMENTS_API_KEY` environment variable if it is not provided.
+        This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+        - `bearer_token` from `DODO_PAYMENTS_API_KEY`
+        - `webhook_key` from `DODO_PAYMENTS_WEBHOOK_KEY`
         """
         if bearer_token is None:
             bearer_token = os.environ.get("DODO_PAYMENTS_API_KEY")
@@ -354,6 +376,10 @@ class AsyncDodoPayments(AsyncAPIClient):
             )
         self.bearer_token = bearer_token
 
+        if webhook_key is None:
+            webhook_key = os.environ.get("DODO_PAYMENTS_WEBHOOK_KEY")
+        self.webhook_key = webhook_key
+
         self._environment = environment
 
         base_url_env = os.environ.get("DODO_PAYMENTS_BASE_URL")
@@ -408,6 +434,8 @@ class AsyncDodoPayments(AsyncAPIClient):
         self.addons = addons.AsyncAddonsResource(self)
         self.brands = brands.AsyncBrandsResource(self)
         self.webhooks = webhooks.AsyncWebhooksResource(self)
+        self.usage_events = usage_events.AsyncUsageEventsResource(self)
+        self.meters = meters.AsyncMetersResource(self)
         self.with_raw_response = AsyncDodoPaymentsWithRawResponse(self)
         self.with_streaming_response = AsyncDodoPaymentsWithStreamedResponse(self)
 
@@ -435,11 +463,12 @@ class AsyncDodoPayments(AsyncAPIClient):
         self,
         *,
         bearer_token: str | None = None,
+        webhook_key: str | None = None,
         environment: Literal["live_mode", "test_mode"] | None = None,
         base_url: str | httpx.URL | None = None,
-        timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.AsyncClient | None = None,
-        max_retries: int | NotGiven = NOT_GIVEN,
+        max_retries: int | NotGiven = not_given,
         default_headers: Mapping[str, str] | None = None,
         set_default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
@@ -470,6 +499,7 @@ class AsyncDodoPayments(AsyncAPIClient):
         http_client = http_client or self._client
         return self.__class__(
             bearer_token=bearer_token or self.bearer_token,
+            webhook_key=webhook_key or self.webhook_key,
             base_url=base_url or self.base_url,
             environment=environment or self._environment,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
@@ -539,6 +569,8 @@ class DodoPaymentsWithRawResponse:
         self.addons = addons.AddonsResourceWithRawResponse(client.addons)
         self.brands = brands.BrandsResourceWithRawResponse(client.brands)
         self.webhooks = webhooks.WebhooksResourceWithRawResponse(client.webhooks)
+        self.usage_events = usage_events.UsageEventsResourceWithRawResponse(client.usage_events)
+        self.meters = meters.MetersResourceWithRawResponse(client.meters)
 
 
 class AsyncDodoPaymentsWithRawResponse:
@@ -564,6 +596,8 @@ class AsyncDodoPaymentsWithRawResponse:
         self.addons = addons.AsyncAddonsResourceWithRawResponse(client.addons)
         self.brands = brands.AsyncBrandsResourceWithRawResponse(client.brands)
         self.webhooks = webhooks.AsyncWebhooksResourceWithRawResponse(client.webhooks)
+        self.usage_events = usage_events.AsyncUsageEventsResourceWithRawResponse(client.usage_events)
+        self.meters = meters.AsyncMetersResourceWithRawResponse(client.meters)
 
 
 class DodoPaymentsWithStreamedResponse:
@@ -589,6 +623,8 @@ class DodoPaymentsWithStreamedResponse:
         self.addons = addons.AddonsResourceWithStreamingResponse(client.addons)
         self.brands = brands.BrandsResourceWithStreamingResponse(client.brands)
         self.webhooks = webhooks.WebhooksResourceWithStreamingResponse(client.webhooks)
+        self.usage_events = usage_events.UsageEventsResourceWithStreamingResponse(client.usage_events)
+        self.meters = meters.MetersResourceWithStreamingResponse(client.meters)
 
 
 class AsyncDodoPaymentsWithStreamedResponse:
@@ -614,6 +650,8 @@ class AsyncDodoPaymentsWithStreamedResponse:
         self.addons = addons.AsyncAddonsResourceWithStreamingResponse(client.addons)
         self.brands = brands.AsyncBrandsResourceWithStreamingResponse(client.brands)
         self.webhooks = webhooks.AsyncWebhooksResourceWithStreamingResponse(client.webhooks)
+        self.usage_events = usage_events.AsyncUsageEventsResourceWithStreamingResponse(client.usage_events)
+        self.meters = meters.AsyncMetersResourceWithStreamingResponse(client.meters)
 
 
 Client = DodoPayments

dodopayments/_compat.py

@@ -12,14 +12,13 @@ from ._types import IncEx, StrBytesIntFloat
 _T = TypeVar("_T")
 _ModelT = TypeVar("_ModelT", bound=pydantic.BaseModel)
 
-# --------------- Pydantic v2 compatibility ---------------
+# --------------- Pydantic v2, v3 compatibility ---------------
 
 # Pyright incorrectly reports some of our functions as overriding a method when they don't
 # pyright: reportIncompatibleMethodOverride=false
 
-PYDANTIC_V2 = pydantic.VERSION.startswith("2.")
+PYDANTIC_V1 = pydantic.VERSION.startswith("1.")
 
-# v1 re-exports
 if TYPE_CHECKING:
 
     def parse_date(value: date | StrBytesIntFloat) -> date:  # noqa: ARG001
@@ -44,90 +43,92 @@ if TYPE_CHECKING:
         ...
 
 else:
-    if PYDANTIC_V2:
-        from pydantic.v1.typing import (
+    # v1 re-exports
+    if PYDANTIC_V1:
+        from pydantic.typing import (
             get_args as get_args,
             is_union as is_union,
             get_origin as get_origin,
             is_typeddict as is_typeddict,
             is_literal_type as is_literal_type,
         )
-        from pydantic.v1.datetime_parse import parse_date as parse_date, parse_datetime as parse_datetime
+        from pydantic.datetime_parse import parse_date as parse_date, parse_datetime as parse_datetime
     else:
-        from pydantic.typing import (
+        from ._utils import (
             get_args as get_args,
             is_union as is_union,
             get_origin as get_origin,
+            parse_date as parse_date,
             is_typeddict as is_typeddict,
+            parse_datetime as parse_datetime,
             is_literal_type as is_literal_type,
         )
-        from pydantic.datetime_parse import parse_date as parse_date, parse_datetime as parse_datetime
 
 
 # refactored config
 if TYPE_CHECKING:
     from pydantic import ConfigDict as ConfigDict
 else:
-    if PYDANTIC_V2:
-        from pydantic import ConfigDict
-    else:
+    if PYDANTIC_V1:
         # TODO: provide an error message here?
         ConfigDict = None
+    else:
+        from pydantic import ConfigDict as ConfigDict
 
 
 # renamed methods / properties
 def parse_obj(model: type[_ModelT], value: object) -> _ModelT:
-    if PYDANTIC_V2:
-        return model.model_validate(value)
-    else:
+    if PYDANTIC_V1:
         return cast(_ModelT, model.parse_obj(value))  # pyright: ignore[reportDeprecated, reportUnnecessaryCast]
+    else:
+        return model.model_validate(value)
 
 
 def field_is_required(field: FieldInfo) -> bool:
-    if PYDANTIC_V2:
-        return field.is_required()
-    return field.required  # type: ignore
+    if PYDANTIC_V1:
+        return field.required  # type: ignore
+    return field.is_required()
 
 
 def field_get_default(field: FieldInfo) -> Any:
     value = field.get_default()
-    if PYDANTIC_V2:
-        from pydantic_core import PydanticUndefined
-
-        if value == PydanticUndefined:
-            return None
+    if PYDANTIC_V1:
         return value
+    from pydantic_core import PydanticUndefined
+
+    if value == PydanticUndefined:
+        return None
     return value
 
 
 def field_outer_type(field: FieldInfo) -> Any:
-    if PYDANTIC_V2:
-        return field.annotation
-    return field.outer_type_  # type: ignore
+    if PYDANTIC_V1:
+        return field.outer_type_  # type: ignore
+    return field.annotation
 
 
 def get_model_config(model: type[pydantic.BaseModel]) -> Any:
-    if PYDANTIC_V2:
-        return model.model_config
-    return model.__config__  # type: ignore
+    if PYDANTIC_V1:
+        return model.__config__  # type: ignore
+    return model.model_config
 
 
 def get_model_fields(model: type[pydantic.BaseModel]) -> dict[str, FieldInfo]:
-    if PYDANTIC_V2:
-        return model.model_fields
-    return model.__fields__  # type: ignore
+    if PYDANTIC_V1:
+        return model.__fields__  # type: ignore
+    return model.model_fields
 
 
 def model_copy(model: _ModelT, *, deep: bool = False) -> _ModelT:
-    if PYDANTIC_V2:
-        return model.model_copy(deep=deep)
-    return model.copy(deep=deep)  # type: ignore
+    if PYDANTIC_V1:
+        return model.copy(deep=deep)  # type: ignore
+    return model.model_copy(deep=deep)
 
 
 def model_json(model: pydantic.BaseModel, *, indent: int | None = None) -> str:
-    if PYDANTIC_V2:
-        return model.model_dump_json(indent=indent)
-    return model.json(indent=indent)  # type: ignore
+    if PYDANTIC_V1:
+        return model.json(indent=indent)  # type: ignore
+    return model.model_dump_json(indent=indent)
 
 
 def model_dump(
@@ -139,14 +140,14 @@ def model_dump(
     warnings: bool = True,
     mode: Literal["json", "python"] = "python",
 ) -> dict[str, Any]:
-    if PYDANTIC_V2 or hasattr(model, "model_dump"):
+    if (not PYDANTIC_V1) or hasattr(model, "model_dump"):
         return model.model_dump(
             mode=mode,
             exclude=exclude,
             exclude_unset=exclude_unset,
             exclude_defaults=exclude_defaults,
             # warnings are not supported in Pydantic v1
-            warnings=warnings if PYDANTIC_V2 else True,
+            warnings=True if PYDANTIC_V1 else warnings,
         )
     return cast(
         "dict[str, Any]",
@@ -159,9 +160,9 @@ def model_dump(
 
 
 def model_parse(model: type[_ModelT], data: Any) -> _ModelT:
-    if PYDANTIC_V2:
-        return model.model_validate(data)
-    return model.parse_obj(data)  # pyright: ignore[reportDeprecated]
+    if PYDANTIC_V1:
+        return model.parse_obj(data)  # pyright: ignore[reportDeprecated]
+    return model.model_validate(data)
 
 
 # generic models
@@ -170,17 +171,16 @@ if TYPE_CHECKING:
     class GenericModel(pydantic.BaseModel): ...
 
 else:
-    if PYDANTIC_V2:
+    if PYDANTIC_V1:
+        import pydantic.generics
+
+        class GenericModel(pydantic.generics.GenericModel, pydantic.BaseModel): ...
+    else:
         # there no longer needs to be a distinction in v2 but
         # we still have to create our own subclass to avoid
         # inconsistent MRO ordering errors
         class GenericModel(pydantic.BaseModel): ...
 
-    else:
-        import pydantic.generics
-
-        class GenericModel(pydantic.generics.GenericModel, pydantic.BaseModel): ...
-
 
 # cached properties
 if TYPE_CHECKING:

dodopayments/_exceptions.py

@@ -54,6 +54,10 @@ class APIResponseValidationError(APIError):
         self.status_code = response.status_code
 
 
+class APIWebhookValidationError(APIError):
+    pass
+
+
 class APIStatusError(APIError):
     """Raised when an API response has a status code of 4xx or 5xx."""