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

mollie/models/payment_link_response.py

@@ -0,0 +1,348 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .amount_nullable import AmountNullable, AmountNullableTypedDict
+from .mode import Mode
+from .payment_address import PaymentAddress, PaymentAddressTypedDict
+from .payment_line_item_response import (
+    PaymentLineItemResponse,
+    PaymentLineItemResponseTypedDict,
+)
+from .payment_link_method_response import PaymentLinkMethodResponse
+from .payment_link_sequence_type_response import PaymentLinkSequenceTypeResponse
+from .url import URL, URLTypedDict
+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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PaymentLinkResponseApplicationFeeTypedDict(TypedDict):
+    r"""With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie
+    merchants.
+
+    If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this
+    `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent
+    to your own account balance.
+    """
+
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    description: str
+    r"""The description of the application fee. This will appear on settlement reports towards both you and the
+    connected merchant.
+    """
+
+
+class PaymentLinkResponseApplicationFee(BaseModel):
+    r"""With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie
+    merchants.
+
+    If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this
+    `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent
+    to your own account balance.
+    """
+
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    description: str
+    r"""The description of the application fee. This will appear on settlement reports towards both you and the
+    connected merchant.
+    """
+
+
+class PaymentLinkResponseLinksTypedDict(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."""
+    payment_link: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class PaymentLinkResponseLinks(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."""
+
+    payment_link: Annotated[URL, pydantic.Field(alias="paymentLink")]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class PaymentLinkResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a payment link object. Will always contain the string `payment-link` for this
+    endpoint.
+    """
+    id: str
+    r"""The identifier uniquely referring to this payment link. Example: `pl_4Y0eZitmBnQ6IDoMqZQKh`."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    description: str
+    r"""A short description of the payment link. The description is visible in the Dashboard and will be shown on the
+    customer's bank or card statement when possible.
+    """
+    amount: Nullable[AmountNullableTypedDict]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    archived: bool
+    r"""Whether the payment link is archived. Customers will not be able to complete payments on archived payment links."""
+    redirect_url: Nullable[str]
+    r"""The URL your customer will be redirected to after completing the payment process. If no redirect URL is provided,
+    the customer will be shown a generic message after completing the payment.
+    """
+    webhook_url: Nullable[str]
+    r"""The webhook URL where we will send payment status updates to.
+
+    The webhookUrl is optional, but without a webhook you will miss out on important status changes to any payments
+    resulting from the payment link.
+
+    The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
+    webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
+    local machine.
+    """
+    profile_id: Nullable[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.
+    """
+    reusable: Nullable[bool]
+    r"""Indicates whether the payment link is reusable. If this field is set to `true`, customers can make multiple
+    payments using the same link.
+
+    If no value is specified, the field defaults to `false`, allowing only a single payment per link.
+    """
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    paid_at: Nullable[str]
+    r"""The date and time the payment link became paid, in ISO 8601 format."""
+    expires_at: Nullable[str]
+    r"""The date and time the payment link is set to expire, in ISO 8601 format. If no expiry date was provided up front,
+    the payment link will not expire automatically.
+    """
+    allowed_methods: Nullable[List[PaymentLinkMethodResponse]]
+    r"""An array of payment methods that are allowed to be used for this payment link. When this parameter is
+    not provided or is an empty array, all enabled payment methods will be available.
+    """
+    links: PaymentLinkResponseLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    minimum_amount: NotRequired[Nullable[AmountNullableTypedDict]]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    lines: NotRequired[Nullable[List[PaymentLineItemResponseTypedDict]]]
+    r"""Optionally provide the order lines for the payment. Each line contains details such as a description of the item
+    ordered and its price.
+
+    All lines must have the same currency as the payment.
+
+    Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
+    """
+    billing_address: NotRequired[PaymentAddressTypedDict]
+    shipping_address: NotRequired[PaymentAddressTypedDict]
+    application_fee: NotRequired[PaymentLinkResponseApplicationFeeTypedDict]
+    r"""With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie
+    merchants.
+
+    If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this
+    `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent
+    to your own account balance.
+    """
+    sequence_type: NotRequired[PaymentLinkSequenceTypeResponse]
+    customer_id: NotRequired[Nullable[str]]
+    r"""**Only relevant when `sequenceType` is set to `first`**
+
+    The ID of the [customer](get-customer) the payment link is being created for. If a value is not provided,
+    the customer will be required to input relevant information which will be used to establish a mandate after
+    the payment is made.
+    """
+
+
+class PaymentLinkResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a payment link object. Will always contain the string `payment-link` for this
+    endpoint.
+    """
+
+    id: str
+    r"""The identifier uniquely referring to this payment link. Example: `pl_4Y0eZitmBnQ6IDoMqZQKh`."""
+
+    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 payment link. The description is visible in the Dashboard and will be shown on the
+    customer's bank or card statement when possible.
+    """
+
+    amount: Nullable[AmountNullable]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    archived: bool
+    r"""Whether the payment link is archived. Customers will not be able to complete payments on archived payment links."""
+
+    redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")]
+    r"""The URL your customer will be redirected to after completing the payment process. If no redirect URL is provided,
+    the customer will be shown a generic message after completing the payment.
+    """
+
+    webhook_url: Annotated[Nullable[str], pydantic.Field(alias="webhookUrl")]
+    r"""The webhook URL where we will send payment status updates to.
+
+    The webhookUrl is optional, but without a webhook you will miss out on important status changes to any payments
+    resulting from the payment link.
+
+    The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
+    webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
+    local machine.
+    """
+
+    profile_id: Annotated[Nullable[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.
+    """
+
+    reusable: Nullable[bool]
+    r"""Indicates whether the payment link is reusable. If this field is set to `true`, customers can make multiple
+    payments using the same link.
+
+    If no value is specified, the field defaults to `false`, allowing only a single payment per link.
+    """
+
+    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."""
+
+    paid_at: Annotated[Nullable[str], pydantic.Field(alias="paidAt")]
+    r"""The date and time the payment link became paid, in ISO 8601 format."""
+
+    expires_at: Annotated[Nullable[str], pydantic.Field(alias="expiresAt")]
+    r"""The date and time the payment link is set to expire, in ISO 8601 format. If no expiry date was provided up front,
+    the payment link will not expire automatically.
+    """
+
+    allowed_methods: Annotated[
+        Nullable[
+            List[
+                Annotated[
+                    PaymentLinkMethodResponse, PlainValidator(validate_open_enum(False))
+                ]
+            ]
+        ],
+        pydantic.Field(alias="allowedMethods"),
+    ]
+    r"""An array of payment methods that are allowed to be used for this payment link. When this parameter is
+    not provided or is an empty array, all enabled payment methods will be available.
+    """
+
+    links: Annotated[PaymentLinkResponseLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    minimum_amount: Annotated[
+        OptionalNullable[AmountNullable], pydantic.Field(alias="minimumAmount")
+    ] = UNSET
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    lines: OptionalNullable[List[PaymentLineItemResponse]] = UNSET
+    r"""Optionally provide the order lines for the payment. Each line contains details such as a description of the item
+    ordered and its price.
+
+    All lines must have the same currency as the payment.
+
+    Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
+    """
+
+    billing_address: Annotated[
+        Optional[PaymentAddress], pydantic.Field(alias="billingAddress")
+    ] = None
+
+    shipping_address: Annotated[
+        Optional[PaymentAddress], pydantic.Field(alias="shippingAddress")
+    ] = None
+
+    application_fee: Annotated[
+        Optional[PaymentLinkResponseApplicationFee],
+        pydantic.Field(alias="applicationFee"),
+    ] = None
+    r"""With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie
+    merchants.
+
+    If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this
+    `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent
+    to your own account balance.
+    """
+
+    sequence_type: Annotated[
+        Annotated[
+            Optional[PaymentLinkSequenceTypeResponse],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="sequenceType"),
+    ] = None
+
+    customer_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="customerId")
+    ] = UNSET
+    r"""**Only relevant when `sequenceType` is set to `first`**
+
+    The ID of the [customer](get-customer) the payment link is being created for. If a value is not provided,
+    the customer will be required to input relevant information which will be used to establish a mandate after
+    the payment is made.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "minimumAmount",
+            "lines",
+            "billingAddress",
+            "shippingAddress",
+            "applicationFee",
+            "sequenceType",
+            "customerId",
+        ]
+        nullable_fields = [
+            "amount",
+            "minimumAmount",
+            "redirectUrl",
+            "webhookUrl",
+            "lines",
+            "profileId",
+            "reusable",
+            "paidAt",
+            "expiresAt",
+            "allowedMethods",
+            "customerId",
+        ]
+        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/payment_link_sequence_type.py

@@ -0,0 +1,9 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class PaymentLinkSequenceType(str, Enum):
+    ONEOFF = "oneoff"
+    FIRST = "first"

mollie/models/payment_link_sequence_type_response.py

@@ -0,0 +1,10 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class PaymentLinkSequenceTypeResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    ONEOFF = "oneoff"
+    FIRST = "first"

mollie/models/payment_list_routesop.py

@@ -0,0 +1,140 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_route_get_response import ListRouteGetResponse, ListRouteGetResponseTypedDict
+from .url import URL, URLTypedDict
+from mollie.types import BaseModel
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PaymentListRoutesGlobalsTypedDict(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 PaymentListRoutesGlobals(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 PaymentListRoutesRequestTypedDict(TypedDict):
+    payment_id: str
+    r"""Provide the ID of the related payment."""
+    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 PaymentListRoutesRequest(BaseModel):
+    payment_id: Annotated[
+        str,
+        pydantic.Field(alias="paymentId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related payment."""
+
+    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."""
+
+
+class PaymentListRoutesEmbeddedTypedDict(TypedDict):
+    routes: List[ListRouteGetResponseTypedDict]
+    r"""An array of route objects."""
+
+
+class PaymentListRoutesEmbedded(BaseModel):
+    routes: List[ListRouteGetResponse]
+    r"""An array of route objects."""
+
+
+class PaymentListRoutesLinksTypedDict(TypedDict):
+    r"""Links to help navigate through the lists of items. 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."""
+    documentation: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class PaymentListRoutesLinks(BaseModel):
+    r"""Links to help navigate through the lists of items. 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."""
+
+    documentation: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class PaymentListRoutesResponseTypedDict(TypedDict):
+    r"""A list of route 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: PaymentListRoutesEmbeddedTypedDict
+    links: PaymentListRoutesLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class PaymentListRoutesResponse(BaseModel):
+    r"""A list of route 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[PaymentListRoutesEmbedded, pydantic.Field(alias="_embedded")]
+
+    links: Annotated[PaymentListRoutesLinks, 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/payment_method.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class PaymentMethod(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The payment method, if applicable"""
+
+    ALMA = "alma"
+    BACS = "bacs"
+    APPLEPAY = "applepay"
+    BANCOMATPAY = "bancomatpay"
+    BANCONTACT = "bancontact"
+    BANKTRANSFER = "banktransfer"
+    BELFIUS = "belfius"
+    BILLIE = "billie"
+    BIZUM = "bizum"
+    BITCOIN = "bitcoin"
+    BLIK = "blik"
+    CREDITCARD = "creditcard"
+    DIRECTDEBIT = "directdebit"
+    EPS = "eps"
+    GIFTCARD = "giftcard"
+    GIROPAY = "giropay"
+    GOOGLEPAY = "googlepay"
+    IDEAL = "ideal"
+    IN3 = "in3"
+    INGHOMEPAY = "inghomepay"
+    KBC = "kbc"
+    KLARNAPAYLATER = "klarnapaylater"
+    KLARNAPAYNOW = "klarnapaynow"
+    KLARNASLICEIT = "klarnasliceit"
+    KLARNA = "klarna"
+    MBWAY = "mbway"
+    MOBILEPAY = "mobilepay"
+    MULTIBANCO = "multibanco"
+    MYBANK = "mybank"
+    PAYBYBANK = "paybybank"
+    PAYPAL = "paypal"
+    PAYSAFECARD = "paysafecard"
+    PRZELEWY24 = "przelewy24"
+    RIVERTY = "riverty"
+    SATISPAY = "satispay"
+    PODIUMCADEAUKAART = "podiumcadeaukaart"
+    POINTOFSALE = "pointofsale"
+    SOFORT = "sofort"
+    SWISH = "swish"
+    TRUSTLY = "trustly"
+    TWINT = "twint"
+    VIPPS = "vipps"
+    VOUCHER = "voucher"