dub 0.23.1__py3-none-any.whl → 0.24.1__py3-none-any.whl

dub/models/operations/listcommissions.py

@@ -0,0 +1,252 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dub.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from dub.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class Type(str, Enum):
+    CLICK = "click"
+    LEAD = "lead"
+    SALE = "sale"
+
+
+class QueryParamStatus(str, Enum):
+    r"""Filter the list of commissions by their corresponding status."""
+
+    PENDING = "pending"
+    PROCESSED = "processed"
+    PAID = "paid"
+    REFUNDED = "refunded"
+    DUPLICATE = "duplicate"
+    FRAUD = "fraud"
+    CANCELED = "canceled"
+
+
+class ListCommissionsQueryParamSortBy(str, Enum):
+    r"""The field to sort the list of commissions by."""
+
+    CREATED_AT = "createdAt"
+    AMOUNT = "amount"
+
+
+class ListCommissionsQueryParamSortOrder(str, Enum):
+    r"""The sort order for the list of commissions."""
+
+    ASC = "asc"
+    DESC = "desc"
+
+
+class ListCommissionsQueryParamInterval(str, Enum):
+    r"""The interval to retrieve commissions for."""
+
+    TWENTY_FOURH = "24h"
+    SEVEND = "7d"
+    THIRTYD = "30d"
+    NINETYD = "90d"
+    ONEY = "1y"
+    MTD = "mtd"
+    QTD = "qtd"
+    YTD = "ytd"
+    ALL = "all"
+
+
+class ListCommissionsRequestTypedDict(TypedDict):
+    type: NotRequired[Type]
+    customer_id: NotRequired[str]
+    r"""Filter the list of commissions by the associated customer."""
+    payout_id: NotRequired[str]
+    r"""Filter the list of commissions by the associated payout."""
+    partner_id: NotRequired[str]
+    r"""Filter the list of commissions by the associated partner."""
+    invoice_id: NotRequired[str]
+    r"""Filter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice."""
+    status: NotRequired[QueryParamStatus]
+    r"""Filter the list of commissions by their corresponding status."""
+    sort_by: NotRequired[ListCommissionsQueryParamSortBy]
+    r"""The field to sort the list of commissions by."""
+    sort_order: NotRequired[ListCommissionsQueryParamSortOrder]
+    r"""The sort order for the list of commissions."""
+    interval: NotRequired[ListCommissionsQueryParamInterval]
+    r"""The interval to retrieve commissions for."""
+    start: NotRequired[str]
+    r"""The start date of the date range to filter the commissions by."""
+    end: NotRequired[str]
+    r"""The end date of the date range to filter the commissions by."""
+    page: NotRequired[float]
+    r"""The page number for pagination."""
+    page_size: NotRequired[float]
+    r"""The number of items per page."""
+
+
+class ListCommissionsRequest(BaseModel):
+    type: Annotated[
+        Optional[Type],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+
+    customer_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="customerId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter the list of commissions by the associated customer."""
+
+    payout_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="payoutId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter the list of commissions by the associated payout."""
+
+    partner_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="partnerId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter the list of commissions by the associated partner."""
+
+    invoice_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="invoiceId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice."""
+
+    status: Annotated[
+        Optional[QueryParamStatus],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter the list of commissions by their corresponding status."""
+
+    sort_by: Annotated[
+        Optional[ListCommissionsQueryParamSortBy],
+        pydantic.Field(alias="sortBy"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = ListCommissionsQueryParamSortBy.CREATED_AT
+    r"""The field to sort the list of commissions by."""
+
+    sort_order: Annotated[
+        Optional[ListCommissionsQueryParamSortOrder],
+        pydantic.Field(alias="sortOrder"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = ListCommissionsQueryParamSortOrder.DESC
+    r"""The sort order for the list of commissions."""
+
+    interval: Annotated[
+        Optional[ListCommissionsQueryParamInterval],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = ListCommissionsQueryParamInterval.ALL
+    r"""The interval to retrieve commissions for."""
+
+    start: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The start date of the date range to filter the commissions by."""
+
+    end: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The end date of the date range to filter the commissions by."""
+
+    page: Annotated[
+        Optional[float],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 1
+    r"""The page number for pagination."""
+
+    page_size: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pageSize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 100
+    r"""The number of items per page."""
+
+
+class ListCommissionsType(str, Enum):
+    CLICK = "click"
+    LEAD = "lead"
+    SALE = "sale"
+
+
+class ListCommissionsStatus(str, Enum):
+    PENDING = "pending"
+    PROCESSED = "processed"
+    PAID = "paid"
+    REFUNDED = "refunded"
+    DUPLICATE = "duplicate"
+    FRAUD = "fraud"
+    CANCELED = "canceled"
+
+
+class ListCommissionsResponseBodyTypedDict(TypedDict):
+    id: str
+    r"""The commission's unique ID on Dub."""
+    amount: float
+    earnings: float
+    currency: str
+    status: ListCommissionsStatus
+    created_at: str
+    updated_at: str
+    type: NotRequired[ListCommissionsType]
+    invoice_id: NotRequired[Nullable[str]]
+
+
+class ListCommissionsResponseBody(BaseModel):
+    id: str
+    r"""The commission's unique ID on Dub."""
+
+    amount: float
+
+    earnings: float
+
+    currency: str
+
+    status: ListCommissionsStatus
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+
+    updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
+
+    type: Optional[ListCommissionsType] = None
+
+    invoice_id: Annotated[OptionalNullable[str], pydantic.Field(alias="invoiceId")] = (
+        UNSET
+    )
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "invoiceId"]
+        nullable_fields = ["invoiceId"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

dub/models/operations/updatecommission.py

@@ -0,0 +1,150 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dub.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from dub.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+from enum import Enum
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class Status(str, Enum):
+    r"""Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated."""
+
+    REFUNDED = "refunded"
+    DUPLICATE = "duplicate"
+    CANCELED = "canceled"
+    FRAUD = "fraud"
+
+
+class UpdateCommissionRequestBodyTypedDict(TypedDict):
+    amount: NotRequired[float]
+    r"""The new absolute amount for the sale. Paid commissions cannot be updated."""
+    modify_amount: NotRequired[float]
+    r"""Modify the current sale amount: use positive values to increase the amount, negative values to decrease it. Takes precedence over `amount`. Paid commissions cannot be updated."""
+    currency: NotRequired[str]
+    r"""The currency of the sale amount to update. Accepts ISO 4217 currency codes."""
+    status: NotRequired[Status]
+    r"""Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated."""
+
+
+class UpdateCommissionRequestBody(BaseModel):
+    amount: Optional[float] = None
+    r"""The new absolute amount for the sale. Paid commissions cannot be updated."""
+
+    modify_amount: Annotated[Optional[float], pydantic.Field(alias="modifyAmount")] = (
+        None
+    )
+    r"""Modify the current sale amount: use positive values to increase the amount, negative values to decrease it. Takes precedence over `amount`. Paid commissions cannot be updated."""
+
+    currency: Optional[str] = "usd"
+    r"""The currency of the sale amount to update. Accepts ISO 4217 currency codes."""
+
+    status: Optional[Status] = None
+    r"""Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated."""
+
+
+class UpdateCommissionRequestTypedDict(TypedDict):
+    id: str
+    r"""The commission's unique ID on Dub."""
+    request_body: NotRequired[UpdateCommissionRequestBodyTypedDict]
+
+
+class UpdateCommissionRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""The commission's unique ID on Dub."""
+
+    request_body: Annotated[
+        Optional[UpdateCommissionRequestBody],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None
+
+
+class UpdateCommissionType(str, Enum):
+    CLICK = "click"
+    LEAD = "lead"
+    SALE = "sale"
+
+
+class UpdateCommissionStatus(str, Enum):
+    PENDING = "pending"
+    PROCESSED = "processed"
+    PAID = "paid"
+    REFUNDED = "refunded"
+    DUPLICATE = "duplicate"
+    FRAUD = "fraud"
+    CANCELED = "canceled"
+
+
+class UpdateCommissionResponseBodyTypedDict(TypedDict):
+    r"""The updated commission."""
+
+    id: str
+    r"""The commission's unique ID on Dub."""
+    amount: float
+    earnings: float
+    currency: str
+    status: UpdateCommissionStatus
+    created_at: str
+    updated_at: str
+    type: NotRequired[UpdateCommissionType]
+    invoice_id: NotRequired[Nullable[str]]
+
+
+class UpdateCommissionResponseBody(BaseModel):
+    r"""The updated commission."""
+
+    id: str
+    r"""The commission's unique ID on Dub."""
+
+    amount: float
+
+    earnings: float
+
+    currency: str
+
+    status: UpdateCommissionStatus
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+
+    updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
+
+    type: Optional[UpdateCommissionType] = None
+
+    invoice_id: Annotated[OptionalNullable[str], pydantic.Field(alias="invoiceId")] = (
+        UNSET
+    )
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "invoiceId"]
+        nullable_fields = ["invoiceId"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

dub/models/operations/updatecustomer.py

@@ -164,19 +164,27 @@ class UpdateCustomerLink(BaseModel):
 
 class UpdateCustomerPartnerTypedDict(TypedDict):
     id: str
+    r"""The partner's unique ID on Dub."""
     name: str
+    r"""The partner's full legal name."""
     email: Nullable[str]
+    r"""The partner's email address. Should be a unique value across Dub."""
     image: Nullable[str]
+    r"""The partner's avatar image."""
 
 
 class UpdateCustomerPartner(BaseModel):
     id: str
+    r"""The partner's unique ID on Dub."""
 
     name: str
+    r"""The partner's full legal name."""
 
     email: Nullable[str]
+    r"""The partner's email address. Should be a unique value across Dub."""
 
     image: Nullable[str]
+    r"""The partner's avatar image."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):