mollie-api-py 1.0.0__py3-none-any.whl

mollie/models/list_entity_settlement.py

@@ -0,0 +1,457 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .amount_nullable import AmountNullable, AmountNullableTypedDict
+from .payment_method import PaymentMethod
+from .url import URL, URLTypedDict
+from .url_nullable import URLNullable, URLNullableTypedDict
+from enum import Enum
+from mollie import utils
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import validate_open_enum
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListEntitySettlementStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the settlement."""
+
+    OPEN = "open"
+    PENDING = "pending"
+    PAIDOUT = "paidout"
+    FAILED = "failed"
+
+
+class ListEntitySettlementAmountTypedDict(TypedDict):
+    r"""The total amount of the settlement."""
+
+    currency: str
+    r"""A three-character ISO 4217 currency code."""
+    value: str
+    r"""A string containing an exact monetary amount in the given currency."""
+
+
+class ListEntitySettlementAmount(BaseModel):
+    r"""The total amount of the settlement."""
+
+    currency: str
+    r"""A three-character ISO 4217 currency code."""
+
+    value: str
+    r"""A string containing an exact monetary amount in the given currency."""
+
+
+class ListEntitySettlementRateTypedDict(TypedDict):
+    r"""The service rates, further divided into `fixed` and `percentage` costs."""
+
+    fixed: NotRequired[AmountTypedDict]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    percentage: NotRequired[str]
+
+
+class ListEntitySettlementRate(BaseModel):
+    r"""The service rates, further divided into `fixed` and `percentage` costs."""
+
+    fixed: Optional[Amount] = None
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    percentage: Optional[str] = None
+
+
+class ListEntitySettlementCostTypedDict(TypedDict):
+    description: str
+    r"""A description of the cost subtotal"""
+    method: Nullable[PaymentMethod]
+    r"""The payment method, if applicable"""
+    count: int
+    r"""The number of fees"""
+    rate: ListEntitySettlementRateTypedDict
+    r"""The service rates, further divided into `fixed` and `percentage` costs."""
+    amount_net: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    amount_vat: Nullable[AmountNullableTypedDict]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    amount_gross: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+
+class ListEntitySettlementCost(BaseModel):
+    description: str
+    r"""A description of the cost subtotal"""
+
+    method: Annotated[
+        Nullable[PaymentMethod], PlainValidator(validate_open_enum(False))
+    ]
+    r"""The payment method, if applicable"""
+
+    count: int
+    r"""The number of fees"""
+
+    rate: ListEntitySettlementRate
+    r"""The service rates, further divided into `fixed` and `percentage` costs."""
+
+    amount_net: Annotated[Amount, pydantic.Field(alias="amountNet")]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    amount_vat: Annotated[Nullable[AmountNullable], pydantic.Field(alias="amountVat")]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    amount_gross: Annotated[Amount, pydantic.Field(alias="amountGross")]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["method", "amountVat"]
+        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
+
+
+class ListEntitySettlementRevenueTypedDict(TypedDict):
+    description: str
+    r"""A description of the revenue subtotal"""
+    method: Nullable[PaymentMethod]
+    r"""The payment method, if applicable"""
+    count: int
+    r"""The number of payments"""
+    amount_net: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    amount_vat: Nullable[AmountNullableTypedDict]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    amount_gross: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+
+class ListEntitySettlementRevenue(BaseModel):
+    description: str
+    r"""A description of the revenue subtotal"""
+
+    method: Annotated[
+        Nullable[PaymentMethod], PlainValidator(validate_open_enum(False))
+    ]
+    r"""The payment method, if applicable"""
+
+    count: int
+    r"""The number of payments"""
+
+    amount_net: Annotated[Amount, pydantic.Field(alias="amountNet")]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    amount_vat: Annotated[Nullable[AmountNullable], pydantic.Field(alias="amountVat")]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    amount_gross: Annotated[Amount, pydantic.Field(alias="amountGross")]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["method", "amountVat"]
+        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
+
+
+class ListEntitySettlementPeriodsTypedDict(TypedDict):
+    costs: NotRequired[List[ListEntitySettlementCostTypedDict]]
+    r"""An array of cost objects, describing the fees withheld for each payment method during this period."""
+    revenue: NotRequired[List[ListEntitySettlementRevenueTypedDict]]
+    r"""An array of revenue objects containing the total revenue for each payment method during this period."""
+    invoice_id: NotRequired[str]
+    invoice_reference: NotRequired[Nullable[str]]
+    r"""The invoice reference, if the invoice has been created already."""
+
+
+class ListEntitySettlementPeriods(BaseModel):
+    costs: Optional[List[ListEntitySettlementCost]] = None
+    r"""An array of cost objects, describing the fees withheld for each payment method during this period."""
+
+    revenue: Optional[List[ListEntitySettlementRevenue]] = None
+    r"""An array of revenue objects containing the total revenue for each payment method during this period."""
+
+    invoice_id: Annotated[Optional[str], pydantic.Field(alias="invoiceId")] = None
+
+    invoice_reference: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="invoiceReference")
+    ] = UNSET
+    r"""The invoice reference, if the invoice has been created already."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["costs", "revenue", "invoiceId", "invoiceReference"]
+        nullable_fields = ["invoiceReference"]
+        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
+
+
+class ListEntitySettlementLinksTypedDict(TypedDict):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    payments: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    captures: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    refunds: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    chargebacks: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    invoice: NotRequired[Nullable[URLNullableTypedDict]]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListEntitySettlementLinks(BaseModel):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: Annotated[URL, pydantic.Field(alias="self")]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    payments: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    captures: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    refunds: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    chargebacks: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    invoice: OptionalNullable[URLNullable] = UNSET
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["payments", "captures", "refunds", "chargebacks", "invoice"]
+        nullable_fields = ["invoice"]
+        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
+
+
+class ListEntitySettlementTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a settlement object. Will always contain the string `settlement` for this
+    endpoint.
+    """
+    id: str
+    r"""The identifier uniquely referring to this settlement."""
+    status: ListEntitySettlementStatus
+    amount: ListEntitySettlementAmountTypedDict
+    r"""The total amount of the settlement."""
+    balance_id: str
+    r"""The balance token that the settlement was settled to."""
+    links: ListEntitySettlementLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    created_at: NotRequired[str]
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    reference: NotRequired[Nullable[str]]
+    r"""The settlement's bank reference, as found in your Mollie account and on your bank statement."""
+    settled_at: NotRequired[Nullable[str]]
+    r"""The date on which the settlement was settled, in ISO 8601 format.
+
+    For an [open settlement](get-open-settlement) or for the [next settlement](get-next-settlement), no settlement
+    date is available.
+    """
+    invoice_id: NotRequired[Nullable[str]]
+    r"""The ID of the oldest invoice created for all the periods, if the invoice has been created yet."""
+    periods: NotRequired[Dict[str, Dict[str, ListEntitySettlementPeriodsTypedDict]]]
+    r"""For bookkeeping purposes, the settlement includes an overview of transactions included in the settlement. These
+    transactions are grouped into 'period' objects — one for each calendar month.
+
+    For example, if a settlement includes funds from 15 April until 4 May, it will include two period objects. One for
+    all transactions processed between 15 April and 30 April, and one for all transactions between 1 May and 4 May.
+
+    Period objects are grouped by year, and then by month. So in the above example, the full `periods` collection will
+    look as follows: `{\"2024\": {\"04\": {...}, \"05\": {...}}}`. The year and month in this documentation are referred as `<year>` and `<month>`.
+
+    The example response should give a good idea of what this looks like in practise.
+    """
+
+
+class ListEntitySettlement(BaseModel):
+    resource: str
+    r"""Indicates the response contains a settlement object. Will always contain the string `settlement` for this
+    endpoint.
+    """
+
+    id: str
+    r"""The identifier uniquely referring to this settlement."""
+
+    status: Annotated[
+        ListEntitySettlementStatus, PlainValidator(validate_open_enum(False))
+    ]
+
+    amount: ListEntitySettlementAmount
+    r"""The total amount of the settlement."""
+
+    balance_id: Annotated[str, pydantic.Field(alias="balanceId")]
+    r"""The balance token that the settlement was settled to."""
+
+    links: Annotated[ListEntitySettlementLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    created_at: Annotated[Optional[str], pydantic.Field(alias="createdAt")] = None
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+
+    reference: OptionalNullable[str] = UNSET
+    r"""The settlement's bank reference, as found in your Mollie account and on your bank statement."""
+
+    settled_at: Annotated[OptionalNullable[str], pydantic.Field(alias="settledAt")] = (
+        UNSET
+    )
+    r"""The date on which the settlement was settled, in ISO 8601 format.
+
+    For an [open settlement](get-open-settlement) or for the [next settlement](get-next-settlement), no settlement
+    date is available.
+    """
+
+    invoice_id: Annotated[OptionalNullable[str], pydantic.Field(alias="invoiceId")] = (
+        UNSET
+    )
+    r"""The ID of the oldest invoice created for all the periods, if the invoice has been created yet."""
+
+    periods: Optional[Dict[str, Dict[str, ListEntitySettlementPeriods]]] = None
+    r"""For bookkeeping purposes, the settlement includes an overview of transactions included in the settlement. These
+    transactions are grouped into 'period' objects — one for each calendar month.
+
+    For example, if a settlement includes funds from 15 April until 4 May, it will include two period objects. One for
+    all transactions processed between 15 April and 30 April, and one for all transactions between 1 May and 4 May.
+
+    Period objects are grouped by year, and then by month. So in the above example, the full `periods` collection will
+    look as follows: `{\"2024\": {\"04\": {...}, \"05\": {...}}}`. The year and month in this documentation are referred as `<year>` and `<month>`.
+
+    The example response should give a good idea of what this looks like in practise.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "createdAt",
+            "reference",
+            "settledAt",
+            "invoiceId",
+            "periods",
+        ]
+        nullable_fields = ["reference", "settledAt", "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

mollie/models/list_entity_terminal.py

@@ -0,0 +1,157 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mode import Mode
+from .terminal_brand import TerminalBrand
+from .terminal_model import TerminalModel
+from .url import URL, URLTypedDict
+from enum import Enum
+from mollie import utils
+from mollie.types import BaseModel, Nullable, UNSET_SENTINEL
+from mollie.utils import validate_open_enum
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
+from typing_extensions import Annotated, TypedDict
+
+
+class ListEntityTerminalStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the terminal."""
+
+    PENDING = "pending"
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+
+
+class ListEntityTerminalLinksTypedDict(TypedDict):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListEntityTerminalLinks(BaseModel):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: Annotated[URL, pydantic.Field(alias="self")]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListEntityTerminalTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a terminal object. Will always contain the string `terminal` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this terminal. Example: `term_7MgL4wea46qkRcoTZjWEH`."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    description: str
+    r"""A short description of the terminal. The description can be used as an identifier for the terminal. Currently, the
+    description is set when the terminal is initially configured. It will be visible in the Mollie Dashboard, and it
+    may be visible on the device itself depending on the device.
+    """
+    status: ListEntityTerminalStatus
+    brand: Nullable[TerminalBrand]
+    r"""The brand of the terminal."""
+    model: Nullable[TerminalModel]
+    r"""The model of the terminal. For example for a PAX A920, this field's value will be `A920`."""
+    serial_number: Nullable[str]
+    r"""The serial number of the terminal. The serial number is provided at terminal creation time."""
+    currency: str
+    r"""The currency configured on the terminal, in ISO 4217 format. Currently most of our terminals are bound to a
+    specific currency, chosen during setup.
+    """
+    profile_id: str
+    r"""The identifier referring to the [profile](get-profile) this entity belongs to.
+
+    Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
+    request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
+    required.
+    """
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    updated_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    links: ListEntityTerminalLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListEntityTerminal(BaseModel):
+    resource: str
+    r"""Indicates the response contains a terminal object. Will always contain the string `terminal` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this terminal. Example: `term_7MgL4wea46qkRcoTZjWEH`."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    description: str
+    r"""A short description of the terminal. The description can be used as an identifier for the terminal. Currently, the
+    description is set when the terminal is initially configured. It will be visible in the Mollie Dashboard, and it
+    may be visible on the device itself depending on the device.
+    """
+
+    status: Annotated[
+        ListEntityTerminalStatus, PlainValidator(validate_open_enum(False))
+    ]
+
+    brand: Annotated[Nullable[TerminalBrand], PlainValidator(validate_open_enum(False))]
+    r"""The brand of the terminal."""
+
+    model: Annotated[Nullable[TerminalModel], PlainValidator(validate_open_enum(False))]
+    r"""The model of the terminal. For example for a PAX A920, this field's value will be `A920`."""
+
+    serial_number: Annotated[Nullable[str], pydantic.Field(alias="serialNumber")]
+    r"""The serial number of the terminal. The serial number is provided at terminal creation time."""
+
+    currency: str
+    r"""The currency configured on the terminal, in ISO 4217 format. Currently most of our terminals are bound to a
+    specific currency, chosen during setup.
+    """
+
+    profile_id: Annotated[str, pydantic.Field(alias="profileId")]
+    r"""The identifier referring to the [profile](get-profile) this entity belongs to.
+
+    Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
+    request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
+    required.
+    """
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+
+    updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+
+    links: Annotated[ListEntityTerminalLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["brand", "model", "serialNumber"]
+        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