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

mollie/models/entity_terminal.py

@@ -0,0 +1,160 @@
+"""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 EntityTerminalStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the terminal."""
+
+    PENDING = "pending"
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+
+
+class EntityTerminalLinksTypedDict(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."""
+    documentation: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityTerminalLinks(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."""
+
+    documentation: URL
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityTerminalTypedDict(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: EntityTerminalStatus
+    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: EntityTerminalLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class EntityTerminal(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[EntityTerminalStatus, 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[EntityTerminalLinks, 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

mollie/models/entity_webhook.py

@@ -0,0 +1,122 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mode import Mode
+from .url import URL, URLTypedDict
+from .webhook_event_types import WebhookEventTypes
+from .webhook_status import WebhookStatus
+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 import List
+from typing_extensions import Annotated, TypedDict
+
+
+class EntityWebhookLinksTypedDict(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."""
+    documentation: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityWebhookLinks(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."""
+
+    documentation: URL
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityWebhookTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a webhook subscription object.
+    Will always contain the string `webhook` for this endpoint.
+    """
+    id: str
+    r"""The identifier uniquely referring to this subscription."""
+    url: str
+    r"""The subscription's events destination."""
+    profile_id: Nullable[str]
+    r"""The identifier uniquely referring to the profile that created the subscription."""
+    created_at: str
+    r"""The subscription's date time of creation."""
+    name: str
+    r"""The subscription's name."""
+    event_types: List[WebhookEventTypes]
+    r"""The events types that are subscribed."""
+    status: WebhookStatus
+    r"""The subscription's current status."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    links: EntityWebhookLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class EntityWebhook(BaseModel):
+    resource: str
+    r"""Indicates the response contains a webhook subscription object.
+    Will always contain the string `webhook` for this endpoint.
+    """
+
+    id: str
+    r"""The identifier uniquely referring to this subscription."""
+
+    url: str
+    r"""The subscription's events destination."""
+
+    profile_id: Annotated[Nullable[str], pydantic.Field(alias="profileId")]
+    r"""The identifier uniquely referring to the profile that created the subscription."""
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+    r"""The subscription's date time of creation."""
+
+    name: str
+    r"""The subscription's name."""
+
+    event_types: Annotated[List[WebhookEventTypes], pydantic.Field(alias="eventTypes")]
+    r"""The events types that are subscribed."""
+
+    status: Annotated[WebhookStatus, PlainValidator(validate_open_enum(False))]
+    r"""The subscription's current status."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    links: Annotated[EntityWebhookLinks, 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 = ["profileId"]
+        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/entity_webhook_event.py

@@ -0,0 +1,149 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .payment_link_response import PaymentLinkResponse, PaymentLinkResponseTypedDict
+from .profile_response import ProfileResponse, ProfileResponseTypedDict
+from .url import URL, URLTypedDict
+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 Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+class EntityWebhookEventWebhookEventTypes(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The list of events to enable for this webhook. You may specify `'*'` to add all events, except those
+    that require explicit selection.
+    """
+
+    PAYMENT_LINK_PAID = "payment-link.paid"
+    BALANCE_TRANSACTION_CREATED = "balance-transaction.created"
+    SALES_INVOICE_CREATED = "sales-invoice.created"
+    SALES_INVOICE_ISSUED = "sales-invoice.issued"
+    SALES_INVOICE_CANCELED = "sales-invoice.canceled"
+    SALES_INVOICE_PAID = "sales-invoice.paid"
+    WILDCARD_ = "*"
+
+
+EntityTypedDict = TypeAliasType(
+    "EntityTypedDict", Union[ProfileResponseTypedDict, PaymentLinkResponseTypedDict]
+)
+
+
+Entity = TypeAliasType("Entity", Union[ProfileResponse, PaymentLinkResponse])
+
+
+class EmbeddedTypedDict(TypedDict):
+    r"""Full payload of the event."""
+
+    entity: NotRequired[EntityTypedDict]
+
+
+class Embedded(BaseModel):
+    r"""Full payload of the event."""
+
+    entity: Optional[Entity] = None
+
+
+class EntityWebhookEventLinksTypedDict(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."""
+    documentation: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    entity: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityWebhookEventLinks(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."""
+
+    documentation: URL
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    entity: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityWebhookEventTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a webhook event object. Will always contain the string `event` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this event."""
+    webhook_event_types: EntityWebhookEventWebhookEventTypes
+    entity_id: str
+    r"""The entity token that triggered the event"""
+    created_at: str
+    r"""The event's date time of creation."""
+    links: EntityWebhookEventLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    embedded: NotRequired[Nullable[EmbeddedTypedDict]]
+    r"""Full payload of the event."""
+
+
+class EntityWebhookEvent(BaseModel):
+    resource: str
+    r"""Indicates the response contains a webhook event object. Will always contain the string `event` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this event."""
+
+    webhook_event_types: Annotated[
+        Annotated[
+            EntityWebhookEventWebhookEventTypes,
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="type"),
+    ]
+
+    entity_id: Annotated[str, pydantic.Field(alias="entityId")]
+    r"""The entity token that triggered the event"""
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+    r"""The event's date time of creation."""
+
+    links: Annotated[EntityWebhookEventLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    embedded: Annotated[
+        OptionalNullable[Embedded], pydantic.Field(alias="_embedded")
+    ] = UNSET
+    r"""Full payload of the event."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["_embedded"]
+        nullable_fields = ["_embedded"]
+        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/error_response.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dataclasses import dataclass, field
+import httpx
+from mollie.models import ClientError
+from mollie.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, TypedDict
+
+
+class DocumentationTypedDict(TypedDict):
+    r"""The URL to the generic Mollie API error handling guide."""
+
+    href: str
+    type: str
+
+
+class Documentation(BaseModel):
+    r"""The URL to the generic Mollie API error handling guide."""
+
+    href: str
+
+    type: str
+
+
+class ErrorsLinksTypedDict(TypedDict):
+    documentation: DocumentationTypedDict
+    r"""The URL to the generic Mollie API error handling guide."""
+
+
+class ErrorsLinks(BaseModel):
+    documentation: Documentation
+    r"""The URL to the generic Mollie API error handling guide."""
+
+
+class ErrorResponseData(BaseModel):
+    status: int
+    r"""The status code of the error message. This is always the same code as the status code of the HTTP message itself."""
+
+    title: str
+    r"""The HTTP reason phrase of the error. For example, for a `404` error, the `title` will be `Not Found`."""
+
+    detail: str
+    r"""A detailed human-readable description of the error that occurred."""
+
+    links: Annotated[ErrorsLinks, pydantic.Field(alias="_links")]
+
+    field: Optional[str] = None
+    r"""If the error was caused by a value provided by you in a specific field, the `field` property will contain the name
+    of the field that caused the issue.
+    """
+
+
+@dataclass(unsafe_hash=True)
+class ErrorResponse(ClientError):
+    r"""An error response object."""
+
+    data: ErrorResponseData = field(hash=False)
+
+    def __init__(
+        self,
+        data: ErrorResponseData,
+        raw_response: httpx.Response,
+        body: Optional[str] = None,
+    ):
+        message = body or raw_response.text
+        super().__init__(message, raw_response, body)
+        object.__setattr__(self, "data", data)

mollie/models/get_balance_reportop.py

@@ -0,0 +1,126 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .balance_report_grouping import BalanceReportGrouping
+from mollie.types import BaseModel
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+    validate_open_enum,
+)
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetBalanceReportGlobalsTypedDict(TypedDict):
+    testmode: NotRequired[bool]
+    r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+    parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+    setting the `testmode` query parameter to `true`.
+
+    Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+    """
+
+
+class GetBalanceReportGlobals(BaseModel):
+    testmode: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+    parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+    setting the `testmode` query parameter to `true`.
+
+    Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+    """
+
+
+class GetBalanceReportRequestTypedDict(TypedDict):
+    balance_id: str
+    r"""Provide the ID of the related balance."""
+    from_: str
+    r"""The start date of the report, in `YYYY-MM-DD` format. The from date is
+    'inclusive', and in Central European Time. This means a report with for example `from=2024-01-01` will
+    include transactions from 2024-01-01 0:00:00 CET and onwards.
+    """
+    until: str
+    r"""The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time.
+    This means a report with for example `until=2024-02-01` will include transactions up until
+    2024-01-31 23:59:59 CET.
+    """
+    grouping: NotRequired[BalanceReportGrouping]
+    r"""You can retrieve reports in two different formats. With the `status-balances` format, transactions are grouped
+    by status (e.g. `pending`, `available`), then by transaction type, and then by other sub-groupings where
+    available (e.g. payment method).
+
+    With the `transaction-categories` format, transactions are grouped by
+    transaction type, then by status, and then again by other sub-groupings where available.
+    """
+    testmode: NotRequired[bool]
+    r"""You can enable test mode by setting the `testmode` query parameter to `true`.
+
+    Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+    """
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+
+class GetBalanceReportRequest(BaseModel):
+    balance_id: Annotated[
+        str,
+        pydantic.Field(alias="balanceId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related balance."""
+
+    from_: Annotated[
+        str,
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The start date of the report, in `YYYY-MM-DD` format. The from date is
+    'inclusive', and in Central European Time. This means a report with for example `from=2024-01-01` will
+    include transactions from 2024-01-01 0:00:00 CET and onwards.
+    """
+
+    until: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time.
+    This means a report with for example `until=2024-02-01` will include transactions up until
+    2024-01-31 23:59:59 CET.
+    """
+
+    grouping: Annotated[
+        Annotated[
+            Optional[BalanceReportGrouping], PlainValidator(validate_open_enum(False))
+        ],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""You can retrieve reports in two different formats. With the `status-balances` format, transactions are grouped
+    by status (e.g. `pending`, `available`), then by transaction type, and then by other sub-groupings where
+    available (e.g. payment method).
+
+    With the `transaction-categories` format, transactions are grouped by
+    transaction type, then by status, and then again by other sub-groupings where available.
+    """
+
+    testmode: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""You can enable test mode by setting the `testmode` query parameter to `true`.
+
+    Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+    """
+
+    idempotency_key: Annotated[
+        Optional[str],
+        pydantic.Field(alias="idempotency-key"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""