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

mollie/models/list_entity_webhook.py

@@ -0,0 +1,117 @@
+"""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 ListEntityWebhookLinksTypedDict(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 ListEntityWebhookLinks(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 ListEntityWebhookTypedDict(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: ListEntityWebhookLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListEntityWebhook(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[ListEntityWebhookLinks, 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/list_invoicesop.py

@@ -0,0 +1,175 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_entity_invoice import ListEntityInvoice, ListEntityInvoiceTypedDict
+from .list_links import ListLinks, ListLinksTypedDict
+from .sorting import Sorting
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import FieldMetadata, HeaderMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListInvoicesRequestTypedDict(TypedDict):
+    reference: NotRequired[Nullable[str]]
+    r"""Filter for an invoice with a specific invoice reference, for example
+    `2024.10000`.
+    """
+    year: NotRequired[Nullable[str]]
+    r"""Filter for invoices of a specific year, for example `2024`."""
+    month: NotRequired[Nullable[str]]
+    r"""Filter for invoices of a specific month, for example `01`."""
+    from_: NotRequired[Nullable[str]]
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+    limit: NotRequired[Nullable[int]]
+    r"""The maximum number of items to return. Defaults to 50 items."""
+    sort: NotRequired[Sorting]
+    r"""Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
+    newest to oldest.
+    """
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+
+class ListInvoicesRequest(BaseModel):
+    reference: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Filter for an invoice with a specific invoice reference, for example
+    `2024.10000`.
+    """
+
+    year: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Filter for invoices of a specific year, for example `2024`."""
+
+    month: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Filter for invoices of a specific month, for example `01`."""
+
+    from_: Annotated[
+        OptionalNullable[str],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+
+    limit: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The maximum number of items to return. Defaults to 50 items."""
+
+    sort: Annotated[
+        Optional[Sorting],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
+    newest to oldest.
+    """
+
+    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."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "reference",
+            "year",
+            "month",
+            "from",
+            "limit",
+            "sort",
+            "idempotency-key",
+        ]
+        nullable_fields = ["reference", "year", "month", "from", "limit"]
+        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 ListInvoicesEmbeddedTypedDict(TypedDict):
+    invoices: List[ListEntityInvoiceTypedDict]
+    r"""An array of invoice objects. For a complete reference of
+    the invoice object, refer to the [Get invoice endpoint](get-invoice) documentation.
+    """
+
+
+class ListInvoicesEmbedded(BaseModel):
+    invoices: List[ListEntityInvoice]
+    r"""An array of invoice objects. For a complete reference of
+    the invoice object, refer to the [Get invoice endpoint](get-invoice) documentation.
+    """
+
+
+class ListInvoicesResponseTypedDict(TypedDict):
+    r"""A list of invoice objects. For a complete reference of the invoice
+    object, refer to the [Get invoice endpoint](get-invoice) documentation.
+    """
+
+    count: int
+    r"""The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
+    as well.
+
+    The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
+    limit is 50 items.
+    """
+    embedded: ListInvoicesEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListInvoicesResponse(BaseModel):
+    r"""A list of invoice objects. For a complete reference of the invoice
+    object, refer to the [Get invoice endpoint](get-invoice) documentation.
+    """
+
+    count: int
+    r"""The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
+    as well.
+
+    The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
+    limit is 50 items.
+    """
+
+    embedded: Annotated[ListInvoicesEmbedded, pydantic.Field(alias="_embedded")]
+
+    links: Annotated[ListLinks, pydantic.Field(alias="_links")]
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""

mollie/models/list_links.py

@@ -0,0 +1,68 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .url import URL, URLTypedDict
+from .url_nullable import URLNullable, URLNullableTypedDict
+from mollie.types import BaseModel, Nullable, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, TypedDict
+
+
+class ListLinksTypedDict(TypedDict):
+    r"""Links to help navigate through the lists of items. 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."""
+    previous: Nullable[URLNullableTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    next: Nullable[URLNullableTypedDict]
+    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 ListLinks(BaseModel):
+    r"""Links to help navigate through the lists of items. 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."""
+
+    previous: Nullable[URLNullable]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    next: Nullable[URLNullable]
+    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."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["previous", "next"]
+        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_mandate_response.py

@@ -0,0 +1,261 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mandate_details_card_label_response import MandateDetailsCardLabelResponse
+from .mandate_method_response import MandateMethodResponse
+from .mode import Mode
+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_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListMandateResponseDetailsTypedDict(TypedDict):
+    consumer_name: NotRequired[Nullable[str]]
+    r"""The customer's name. Available for SEPA Direct Debit and PayPal mandates."""
+    consumer_account: NotRequired[Nullable[str]]
+    r"""The customer's IBAN or email address. Available for SEPA Direct Debit and PayPal mandates."""
+    consumer_bic: NotRequired[Nullable[str]]
+    r"""The BIC of the customer's bank. Available for SEPA Direct Debit mandates."""
+    card_holder: NotRequired[Nullable[str]]
+    r"""The card holder's name. Available for card mandates."""
+    card_number: NotRequired[Nullable[str]]
+    r"""The last four digits of the card number. Available for card mandates."""
+    card_expiry_date: NotRequired[Nullable[str]]
+    r"""The card's expiry date in `YYYY-MM-DD` format. Available for card mandates."""
+    card_label: NotRequired[Nullable[MandateDetailsCardLabelResponse]]
+    r"""The card's label. Available for card mandates, if the card label could be detected."""
+    card_fingerprint: NotRequired[Nullable[str]]
+    r"""Unique alphanumeric representation of this specific card. Available for card mandates. Can be used to identify
+    returning customers.
+    """
+
+
+class ListMandateResponseDetails(BaseModel):
+    consumer_name: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerName")
+    ] = UNSET
+    r"""The customer's name. Available for SEPA Direct Debit and PayPal mandates."""
+
+    consumer_account: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerAccount")
+    ] = UNSET
+    r"""The customer's IBAN or email address. Available for SEPA Direct Debit and PayPal mandates."""
+
+    consumer_bic: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerBic")
+    ] = UNSET
+    r"""The BIC of the customer's bank. Available for SEPA Direct Debit mandates."""
+
+    card_holder: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardHolder")
+    ] = UNSET
+    r"""The card holder's name. Available for card mandates."""
+
+    card_number: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardNumber")
+    ] = UNSET
+    r"""The last four digits of the card number. Available for card mandates."""
+
+    card_expiry_date: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardExpiryDate")
+    ] = UNSET
+    r"""The card's expiry date in `YYYY-MM-DD` format. Available for card mandates."""
+
+    card_label: Annotated[
+        Annotated[
+            OptionalNullable[MandateDetailsCardLabelResponse],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="cardLabel"),
+    ] = UNSET
+    r"""The card's label. Available for card mandates, if the card label could be detected."""
+
+    card_fingerprint: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardFingerprint")
+    ] = UNSET
+    r"""Unique alphanumeric representation of this specific card. Available for card mandates. Can be used to identify
+    returning customers.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "consumerName",
+            "consumerAccount",
+            "consumerBic",
+            "cardHolder",
+            "cardNumber",
+            "cardExpiryDate",
+            "cardLabel",
+            "cardFingerprint",
+        ]
+        nullable_fields = [
+            "consumerName",
+            "consumerAccount",
+            "consumerBic",
+            "cardHolder",
+            "cardNumber",
+            "cardExpiryDate",
+            "cardLabel",
+            "cardFingerprint",
+        ]
+        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 ListMandateResponseStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
+    when we did not received the IBAN yet from the first payment.
+    """
+
+    VALID = "valid"
+    PENDING = "pending"
+    INVALID = "invalid"
+
+
+class ListMandateResponseLinksTypedDict(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."""
+    customer: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListMandateResponseLinks(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."""
+
+    customer: URL
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListMandateResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a mandate object. Will always contain the string `mandate` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    method: MandateMethodResponse
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+    details: ListMandateResponseDetailsTypedDict
+    signature_date: Nullable[str]
+    r"""The date when the mandate was signed in `YYYY-MM-DD` format."""
+    mandate_reference: Nullable[str]
+    r"""A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will
+    decline Direct Debit payments if the mandate reference is not unique.
+    """
+    status: ListMandateResponseStatus
+    customer_id: str
+    r"""The identifier referring to the [customer](get-customer) this mandate was linked to."""
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    links: ListMandateResponseLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListMandateResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a mandate object. Will always contain the string `mandate` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    method: Annotated[MandateMethodResponse, PlainValidator(validate_open_enum(False))]
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+
+    details: ListMandateResponseDetails
+
+    signature_date: Annotated[Nullable[str], pydantic.Field(alias="signatureDate")]
+    r"""The date when the mandate was signed in `YYYY-MM-DD` format."""
+
+    mandate_reference: Annotated[
+        Nullable[str], pydantic.Field(alias="mandateReference")
+    ]
+    r"""A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will
+    decline Direct Debit payments if the mandate reference is not unique.
+    """
+
+    status: Annotated[
+        ListMandateResponseStatus, PlainValidator(validate_open_enum(False))
+    ]
+
+    customer_id: Annotated[str, pydantic.Field(alias="customerId")]
+    r"""The identifier referring to the [customer](get-customer) this mandate was linked to."""
+
+    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."""
+
+    links: Annotated[ListMandateResponseLinks, 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 = ["signatureDate", "mandateReference"]
+        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