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

mollie/models/entity_method_get.py

@@ -0,0 +1,329 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .method_status import MethodStatus
+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 import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EntityMethodGetID(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The unique identifier of the payment method. When used during [payment creation](create-payment), the payment
+    method selection screen will be skipped.
+    """
+
+    ALMA = "alma"
+    APPLEPAY = "applepay"
+    BACS = "bacs"
+    BANCOMATPAY = "bancomatpay"
+    BANCONTACT = "bancontact"
+    BANKTRANSFER = "banktransfer"
+    BELFIUS = "belfius"
+    BILLIE = "billie"
+    BIZUM = "bizum"
+    BLIK = "blik"
+    CREDITCARD = "creditcard"
+    DIRECTDEBIT = "directdebit"
+    EPS = "eps"
+    GIFTCARD = "giftcard"
+    IDEAL = "ideal"
+    IN3 = "in3"
+    KBC = "kbc"
+    KLARNA = "klarna"
+    MBWAY = "mbway"
+    MOBILEPAY = "mobilepay"
+    MULTIBANCO = "multibanco"
+    MYBANK = "mybank"
+    PAYBYBANK = "paybybank"
+    PAYPAL = "paypal"
+    PAYSAFECARD = "paysafecard"
+    POINTOFSALE = "pointofsale"
+    PRZELEWY24 = "przelewy24"
+    RIVERTY = "riverty"
+    SATISPAY = "satispay"
+    SWISH = "swish"
+    TRUSTLY = "trustly"
+    TWINT = "twint"
+    VIPPS = "vipps"
+    VOUCHER = "voucher"
+    # Deprecated, use 'klarna' instead
+    KLARNAPAYLATER = "klarnapaylater"
+    # Deprecated, use 'klarna' instead
+    KLARNAPAYNOW = "klarnapaynow"
+    # Deprecated, use 'klarna' instead
+    KLARNASLICEIT = "klarnasliceit"
+    # No longer available
+    PAYCONIQ = "payconiq"
+
+
+class EntityMethodGetMinimumAmountTypedDict(TypedDict):
+    r"""The minimum payment amount required to use this payment method."""
+
+    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 EntityMethodGetMinimumAmount(BaseModel):
+    r"""The minimum payment amount required to use this payment method."""
+
+    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 EntityMethodGetMaximumAmountTypedDict(TypedDict):
+    r"""The maximum payment amount allowed when using this payment method. If there is no method-specific maximum, `null`
+    is returned instead.
+    """
+
+    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 EntityMethodGetMaximumAmount(BaseModel):
+    r"""The maximum payment amount allowed when using this payment method. If there is no method-specific maximum, `null`
+    is returned instead.
+    """
+
+    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 EntityMethodGetImageTypedDict(TypedDict):
+    r"""URLs of images representing the payment method."""
+
+    size1x: str
+    r"""The URL pointing to an icon of 32 by 24 pixels."""
+    size2x: str
+    r"""The URL pointing to an icon of 64 by 48 pixels."""
+    svg: str
+    r"""The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
+    scale to any desired size without compromising visual quality.
+    """
+
+
+class EntityMethodGetImage(BaseModel):
+    r"""URLs of images representing the payment method."""
+
+    size1x: str
+    r"""The URL pointing to an icon of 32 by 24 pixels."""
+
+    size2x: str
+    r"""The URL pointing to an icon of 64 by 48 pixels."""
+
+    svg: str
+    r"""The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
+    scale to any desired size without compromising visual quality.
+    """
+
+
+class EntityMethodGetIssuerImageTypedDict(TypedDict):
+    r"""URLs of images representing the issuer.
+    required:
+    - size1x
+    - size2x
+    - svg
+    """
+
+    size1x: NotRequired[str]
+    r"""The URL pointing to an icon of 32 by 24 pixels."""
+    size2x: NotRequired[str]
+    r"""The URL pointing to an icon of 64 by 48 pixels."""
+    svg: NotRequired[str]
+    r"""The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
+    scale to any desired size without compromising visual quality.
+    """
+
+
+class EntityMethodGetIssuerImage(BaseModel):
+    r"""URLs of images representing the issuer.
+    required:
+    - size1x
+    - size2x
+    - svg
+    """
+
+    size1x: Optional[str] = None
+    r"""The URL pointing to an icon of 32 by 24 pixels."""
+
+    size2x: Optional[str] = None
+    r"""The URL pointing to an icon of 64 by 48 pixels."""
+
+    svg: Optional[str] = None
+    r"""The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
+    scale to any desired size without compromising visual quality.
+    """
+
+
+class EntityMethodGetIssuerTypedDict(TypedDict):
+    resource: str
+    id: str
+    name: str
+    r"""The full name of the issuer."""
+    image: EntityMethodGetIssuerImageTypedDict
+    r"""URLs of images representing the issuer.
+    required:
+    - size1x
+    - size2x
+    - svg
+    """
+
+
+class EntityMethodGetIssuer(BaseModel):
+    resource: str
+
+    id: str
+
+    name: str
+    r"""The full name of the issuer."""
+
+    image: EntityMethodGetIssuerImage
+    r"""URLs of images representing the issuer.
+    required:
+    - size1x
+    - size2x
+    - svg
+    """
+
+
+class EntityMethodGetLinksTypedDict(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: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityMethodGetLinks(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: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityMethodGetTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a payment method object. Will always contain the string `method` for this
+    endpoint.
+    """
+    id: Nullable[EntityMethodGetID]
+    r"""The unique identifier of the payment method. When used during [payment creation](create-payment), the payment
+    method selection screen will be skipped.
+    """
+    description: str
+    r"""The full name of the payment method.
+
+    If a `locale` parameter is provided, the name is translated to the given locale if possible.
+    """
+    minimum_amount: EntityMethodGetMinimumAmountTypedDict
+    r"""The minimum payment amount required to use this payment method."""
+    maximum_amount: Nullable[EntityMethodGetMaximumAmountTypedDict]
+    r"""The maximum payment amount allowed when using this payment method. If there is no method-specific maximum, `null`
+    is returned instead.
+    """
+    image: EntityMethodGetImageTypedDict
+    r"""URLs of images representing the payment method."""
+    status: Nullable[MethodStatus]
+    r"""The payment method's activation status for this profile."""
+    links: EntityMethodGetLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    issuers: NotRequired[List[EntityMethodGetIssuerTypedDict]]
+    r"""**Optional include.** Array of objects for each 'issuer' that is available for this payment method. Only relevant
+    for iDEAL, KBC/CBC, gift cards, and vouchers.
+    """
+
+
+class EntityMethodGet(BaseModel):
+    resource: str
+    r"""Indicates the response contains a payment method object. Will always contain the string `method` for this
+    endpoint.
+    """
+
+    id: Annotated[
+        Nullable[EntityMethodGetID], PlainValidator(validate_open_enum(False))
+    ]
+    r"""The unique identifier of the payment method. When used during [payment creation](create-payment), the payment
+    method selection screen will be skipped.
+    """
+
+    description: str
+    r"""The full name of the payment method.
+
+    If a `locale` parameter is provided, the name is translated to the given locale if possible.
+    """
+
+    minimum_amount: Annotated[
+        EntityMethodGetMinimumAmount, pydantic.Field(alias="minimumAmount")
+    ]
+    r"""The minimum payment amount required to use this payment method."""
+
+    maximum_amount: Annotated[
+        Nullable[EntityMethodGetMaximumAmount], pydantic.Field(alias="maximumAmount")
+    ]
+    r"""The maximum payment amount allowed when using this payment method. If there is no method-specific maximum, `null`
+    is returned instead.
+    """
+
+    image: EntityMethodGetImage
+    r"""URLs of images representing the payment method."""
+
+    status: Annotated[Nullable[MethodStatus], PlainValidator(validate_open_enum(False))]
+    r"""The payment method's activation status for this profile."""
+
+    links: Annotated[EntityMethodGetLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    issuers: Optional[List[EntityMethodGetIssuer]] = None
+    r"""**Optional include.** Array of objects for each 'issuer' that is available for this payment method. Only relevant
+    for iDEAL, KBC/CBC, gift cards, and vouchers.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["issuers"]
+        nullable_fields = ["id", "maximumAmount", "status"]
+        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_onboarding_status.py

@@ -0,0 +1,95 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .url import URL, URLTypedDict
+from enum import Enum
+from mollie import utils
+from mollie.types import BaseModel
+from mollie.utils import validate_open_enum
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EntityOnboardingStatusStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The current status of the organization's onboarding process."""
+
+    NEEDS_DATA = "needs-data"
+    IN_REVIEW = "in-review"
+    COMPLETED = "completed"
+
+
+class EntityOnboardingStatusLinksTypedDict(TypedDict):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    dashboard: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    organization: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    documentation: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityOnboardingStatusLinks(BaseModel):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: Annotated[Optional[URL], pydantic.Field(alias="self")] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    dashboard: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    organization: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    documentation: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityOnboardingStatusTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains an onboarding status object. Will always contain the string `onboarding` for this
+    resource type.
+    """
+    name: str
+    r"""The name of the organization."""
+    status: EntityOnboardingStatusStatus
+    can_receive_payments: bool
+    r"""Whether the organization can receive payments."""
+    can_receive_settlements: bool
+    r"""Whether the organization can receive settlements to their external bank account."""
+    signed_up_at: str
+    r"""The sign up date time of the organization in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    links: EntityOnboardingStatusLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class EntityOnboardingStatus(BaseModel):
+    resource: str
+    r"""Indicates the response contains an onboarding status object. Will always contain the string `onboarding` for this
+    resource type.
+    """
+
+    name: str
+    r"""The name of the organization."""
+
+    status: Annotated[
+        EntityOnboardingStatusStatus, PlainValidator(validate_open_enum(False))
+    ]
+
+    can_receive_payments: Annotated[bool, pydantic.Field(alias="canReceivePayments")]
+    r"""Whether the organization can receive payments."""
+
+    can_receive_settlements: Annotated[
+        bool, pydantic.Field(alias="canReceiveSettlements")
+    ]
+    r"""Whether the organization can receive settlements to their external bank account."""
+
+    signed_up_at: Annotated[str, pydantic.Field(alias="signedUpAt")]
+    r"""The sign up date time of the organization in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+
+    links: Annotated[EntityOnboardingStatusLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""

mollie/models/entity_organization.py

@@ -0,0 +1,178 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .address import Address, AddressTypedDict
+from .organization_vat_regulation import OrganizationVatRegulation
+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
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EntityOrganizationLocale(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The preferred locale of the merchant, as set in their Mollie dashboard."""
+
+    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"
+
+
+class EntityOrganizationLinksTypedDict(TypedDict):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    dashboard: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    documentation: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityOrganizationLinks(BaseModel):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: Annotated[Optional[URL], pydantic.Field(alias="self")] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    dashboard: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    documentation: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityOrganizationTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains an organization object. Will always contain the string `organization` for this
+    resource type.
+    """
+    id: str
+    name: str
+    r"""The name of the organization."""
+    email: str
+    r"""The email address associated with the organization."""
+    locale: Nullable[EntityOrganizationLocale]
+    r"""The preferred locale of the merchant, as set in their Mollie dashboard."""
+    address: AddressTypedDict
+    registration_number: str
+    r"""The registration number of the organization at their local chamber of commerce."""
+    links: EntityOrganizationLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    vat_number: NotRequired[Nullable[str]]
+    r"""The VAT number of the organization, if based in the European Union or in The United Kingdom. VAT numbers are
+    verified against the international registry *VIES*.
+
+    The field is not present for merchants residing in other countries.
+    """
+    vat_regulation: NotRequired[Nullable[OrganizationVatRegulation]]
+    r"""Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United
+    Kingdom, and shifted VAT for merchants in the European Union.
+
+    The field is not present for merchants residing in other countries.
+    """
+
+
+class EntityOrganization(BaseModel):
+    resource: str
+    r"""Indicates the response contains an organization object. Will always contain the string `organization` for this
+    resource type.
+    """
+
+    id: str
+
+    name: str
+    r"""The name of the organization."""
+
+    email: str
+    r"""The email address associated with the organization."""
+
+    locale: Annotated[
+        Nullable[EntityOrganizationLocale], PlainValidator(validate_open_enum(False))
+    ]
+    r"""The preferred locale of the merchant, as set in their Mollie dashboard."""
+
+    address: Address
+
+    registration_number: Annotated[str, pydantic.Field(alias="registrationNumber")]
+    r"""The registration number of the organization at their local chamber of commerce."""
+
+    links: Annotated[EntityOrganizationLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    vat_number: Annotated[OptionalNullable[str], pydantic.Field(alias="vatNumber")] = (
+        UNSET
+    )
+    r"""The VAT number of the organization, if based in the European Union or in The United Kingdom. VAT numbers are
+    verified against the international registry *VIES*.
+
+    The field is not present for merchants residing in other countries.
+    """
+
+    vat_regulation: Annotated[
+        Annotated[
+            OptionalNullable[OrganizationVatRegulation],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="vatRegulation"),
+    ] = UNSET
+    r"""Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United
+    Kingdom, and shifted VAT for merchants in the European Union.
+
+    The field is not present for merchants residing in other countries.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["vatNumber", "vatRegulation"]
+        nullable_fields = ["locale", "vatNumber", "vatRegulation"]
+        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