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

mollie/models/list_terminalsop.py

@@ -0,0 +1,172 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_entity_terminal import ListEntityTerminal, ListEntityTerminalTypedDict
+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 ListTerminalsGlobalsTypedDict(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 ListTerminalsGlobals(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 ListTerminalsRequestTypedDict(TypedDict):
+    from_: NotRequired[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.
+    """
+    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.
+    """
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+
+class ListTerminalsRequest(BaseModel):
+    from_: Annotated[
+        Optional[str],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    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.
+    """
+
+    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.
+    """
+
+    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 = ["from", "limit", "sort", "testmode", "idempotency-key"]
+        nullable_fields = ["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 ListTerminalsEmbeddedTypedDict(TypedDict):
+    terminals: NotRequired[List[ListEntityTerminalTypedDict]]
+    r"""An array of terminal objects."""
+
+
+class ListTerminalsEmbedded(BaseModel):
+    terminals: Optional[List[ListEntityTerminal]] = None
+    r"""An array of terminal objects."""
+
+
+class ListTerminalsResponseTypedDict(TypedDict):
+    r"""A list of terminal objects."""
+
+    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: ListTerminalsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListTerminalsResponse(BaseModel):
+    r"""A list of terminal objects."""
+
+    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[ListTerminalsEmbedded, 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_webhooksop.py

@@ -0,0 +1,189 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_entity_webhook import ListEntityWebhook, ListEntityWebhookTypedDict
+from .list_links import ListLinks, ListLinksTypedDict
+from .sorting import Sorting
+from .webhook_event_types import WebhookEventTypes
+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 ListWebhooksGlobalsTypedDict(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 ListWebhooksGlobals(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 ListWebhooksRequestTypedDict(TypedDict):
+    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.
+    """
+    event_types: NotRequired[WebhookEventTypes]
+    r"""Used to filter out only the webhooks that are subscribed to certain types of events."""
+    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 ListWebhooksRequest(BaseModel):
+    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.
+    """
+
+    event_types: Annotated[
+        Optional[WebhookEventTypes],
+        pydantic.Field(alias="eventTypes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Used to filter out only the webhooks that are subscribed to certain types of events."""
+
+    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."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "from",
+            "limit",
+            "sort",
+            "eventTypes",
+            "testmode",
+            "idempotency-key",
+        ]
+        nullable_fields = ["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 ListWebhooksEmbeddedTypedDict(TypedDict):
+    webhooks: List[ListEntityWebhookTypedDict]
+    r"""A list of webhooks."""
+
+
+class ListWebhooksEmbedded(BaseModel):
+    webhooks: List[ListEntityWebhook]
+    r"""A list of webhooks."""
+
+
+class ListWebhooksResponseTypedDict(TypedDict):
+    r"""A list of webhooks. For a complete reference of the webhook
+    object, refer to the [Get hook endpoint](get-webhook) 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: ListWebhooksEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListWebhooksResponse(BaseModel):
+    r"""A list of webhooks. For a complete reference of the webhook
+    object, refer to the [Get hook endpoint](get-webhook) 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[ListWebhooksEmbedded, 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/locale.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class Locale(str, Enum):
+    r"""Allows you to preset the language to be used."""
+
+    EN_US = "en_US"
+    EN_GB = "en_GB"
+    NL_NL = "nl_NL"
+    NL_BE = "nl_BE"
+    DE_DE = "de_DE"
+    DE_AT = "de_AT"
+    DE_CH = "de_CH"
+    FR_FR = "fr_FR"
+    FR_BE = "fr_BE"
+    ES_ES = "es_ES"
+    CA_ES = "ca_ES"
+    PT_PT = "pt_PT"
+    IT_IT = "it_IT"
+    NB_NO = "nb_NO"
+    SV_SE = "sv_SE"
+    FI_FI = "fi_FI"
+    DA_DK = "da_DK"
+    IS_IS = "is_IS"
+    HU_HU = "hu_HU"
+    PL_PL = "pl_PL"
+    LV_LV = "lv_LV"
+    LT_LT = "lt_LT"
+    NULL = "null"

mollie/models/locale_response.py

@@ -0,0 +1,33 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class LocaleResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Allows you to preset the language to be used."""
+
+    EN_US = "en_US"
+    EN_GB = "en_GB"
+    NL_NL = "nl_NL"
+    NL_BE = "nl_BE"
+    DE_DE = "de_DE"
+    DE_AT = "de_AT"
+    DE_CH = "de_CH"
+    FR_FR = "fr_FR"
+    FR_BE = "fr_BE"
+    ES_ES = "es_ES"
+    CA_ES = "ca_ES"
+    PT_PT = "pt_PT"
+    IT_IT = "it_IT"
+    NB_NO = "nb_NO"
+    SV_SE = "sv_SE"
+    FI_FI = "fi_FI"
+    DA_DK = "da_DK"
+    IS_IS = "is_IS"
+    HU_HU = "hu_HU"
+    PL_PL = "pl_PL"
+    LV_LV = "lv_LV"
+    LT_LT = "lt_LT"
+    NULL = "null"

mollie/models/mandate_details_card_label_response.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class MandateDetailsCardLabelResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The card's label. Available for card mandates, if the card label could be detected."""
+
+    AMERICAN_EXPRESS = "American Express"
+    CARTA_SI = "Carta Si"
+    CARTE_BLEUE = "Carte Bleue"
+    DANKORT = "Dankort"
+    DINERS_CLUB = "Diners Club"
+    DISCOVER = "Discover"
+    JCB = "JCB"
+    LASER = "Laser"
+    MAESTRO = "Maestro"
+    MASTERCARD = "Mastercard"
+    UNIONPAY = "Unionpay"
+    VISA = "Visa"

mollie/models/mandate_method.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class MandateMethod(str, Enum):
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+
+    CREDITCARD = "creditcard"
+    DIRECTDEBIT = "directdebit"
+    PAYPAL = "paypal"

mollie/models/mandate_method_response.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class MandateMethodResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+
+    CREDITCARD = "creditcard"
+    DIRECTDEBIT = "directdebit"
+    PAYPAL = "paypal"

mollie/models/mandate_request.py

@@ -0,0 +1,160 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mandate_method import MandateMethod
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class MandateRequestTypedDict(TypedDict):
+    method: MandateMethod
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+    consumer_name: str
+    r"""The customer's name."""
+    id: NotRequired[str]
+    r"""The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`."""
+    consumer_account: NotRequired[Nullable[str]]
+    r"""The customer's IBAN. Required for SEPA Direct Debit mandates."""
+    consumer_bic: NotRequired[Nullable[str]]
+    r"""The BIC of the customer's bank."""
+    consumer_email: NotRequired[Nullable[str]]
+    r"""The customer's email address. Required for PayPal mandates."""
+    signature_date: NotRequired[Nullable[str]]
+    r"""The date when the mandate was signed in `YYYY-MM-DD` format."""
+    mandate_reference: NotRequired[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.
+    """
+    paypal_billing_agreement_id: NotRequired[Nullable[str]]
+    r"""The billing agreement ID given by PayPal. For example: `B-12A34567B8901234CD`. Required for PayPal mandates.
+    Must provide either this field or `payPalVaultId`, but not both.
+    """
+    pay_pal_vault_id: NotRequired[Nullable[str]]
+    r"""The Vault ID given by PayPal. For example: `8kk8451t`. Required for PayPal mandates.
+    Must provide either this field or `paypalBillingAgreementId`, but not both.
+    """
+    testmode: NotRequired[Nullable[bool]]
+    r"""Whether to create the entity in test mode or live mode.
+
+    Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
+    omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+    `testmode` to `true`.
+    """
+
+
+class MandateRequest(BaseModel):
+    method: MandateMethod
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+
+    consumer_name: Annotated[str, pydantic.Field(alias="consumerName")]
+    r"""The customer's name."""
+
+    id: Optional[str] = None
+    r"""The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`."""
+
+    consumer_account: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerAccount")
+    ] = UNSET
+    r"""The customer's IBAN. Required for SEPA Direct Debit mandates."""
+
+    consumer_bic: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerBic")
+    ] = UNSET
+    r"""The BIC of the customer's bank."""
+
+    consumer_email: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerEmail")
+    ] = UNSET
+    r"""The customer's email address. Required for PayPal mandates."""
+
+    signature_date: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="signatureDate")
+    ] = UNSET
+    r"""The date when the mandate was signed in `YYYY-MM-DD` format."""
+
+    mandate_reference: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="mandateReference")
+    ] = UNSET
+    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.
+    """
+
+    paypal_billing_agreement_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="paypalBillingAgreementId")
+    ] = UNSET
+    r"""The billing agreement ID given by PayPal. For example: `B-12A34567B8901234CD`. Required for PayPal mandates.
+    Must provide either this field or `payPalVaultId`, but not both.
+    """
+
+    pay_pal_vault_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="payPalVaultId")
+    ] = UNSET
+    r"""The Vault ID given by PayPal. For example: `8kk8451t`. Required for PayPal mandates.
+    Must provide either this field or `paypalBillingAgreementId`, but not both.
+    """
+
+    testmode: OptionalNullable[bool] = UNSET
+    r"""Whether to create the entity in test mode or live mode.
+
+    Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
+    omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+    `testmode` to `true`.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "id",
+            "consumerAccount",
+            "consumerBic",
+            "consumerEmail",
+            "signatureDate",
+            "mandateReference",
+            "paypalBillingAgreementId",
+            "payPalVaultId",
+            "testmode",
+        ]
+        nullable_fields = [
+            "consumerAccount",
+            "consumerBic",
+            "consumerEmail",
+            "signatureDate",
+            "mandateReference",
+            "paypalBillingAgreementId",
+            "payPalVaultId",
+            "testmode",
+        ]
+        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