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

mollie/models/profile_request.py

@@ -0,0 +1,67 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ProfileRequestTypedDict(TypedDict):
+    name: str
+    r"""The profile's name, this will usually reflect the trade name or brand name of the profile's website or
+    application.
+    """
+    website: str
+    r"""The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
+    allowed.
+    """
+    email: str
+    r"""The email address associated with the profile's trade name or brand."""
+    phone: str
+    r"""The phone number associated with the profile's trade name or brand."""
+    description: NotRequired[str]
+    r"""The products or services offered by the profile's website or application."""
+    countries_of_activity: NotRequired[List[str]]
+    r"""A list of countries where you expect that the majority of the profile's customers reside,
+    in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+    """
+    business_category: NotRequired[str]
+    r"""The industry associated with the profile's trade name or brand. Please refer to the
+    [business category list](common-data-types#business-category) for all possible options.
+    """
+
+
+class ProfileRequest(BaseModel):
+    name: str
+    r"""The profile's name, this will usually reflect the trade name or brand name of the profile's website or
+    application.
+    """
+
+    website: str
+    r"""The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
+    allowed.
+    """
+
+    email: str
+    r"""The email address associated with the profile's trade name or brand."""
+
+    phone: str
+    r"""The phone number associated with the profile's trade name or brand."""
+
+    description: Optional[str] = None
+    r"""The products or services offered by the profile's website or application."""
+
+    countries_of_activity: Annotated[
+        Optional[List[str]], pydantic.Field(alias="countriesOfActivity")
+    ] = None
+    r"""A list of countries where you expect that the majority of the profile's customers reside,
+    in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+    """
+
+    business_category: Annotated[
+        Optional[str], pydantic.Field(alias="businessCategory")
+    ] = None
+    r"""The industry associated with the profile's trade name or brand. Please refer to the
+    [business category list](common-data-types#business-category) for all possible options.
+    """

mollie/models/profile_response.py

@@ -0,0 +1,197 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mode import Mode
+from .profile_review_status_response import ProfileReviewStatusResponse
+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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ProfileResponseStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The profile status determines whether the profile is able to receive live payments.
+
+    * `unverified`: The profile has not been verified yet and can only be used to create test payments.
+    * `verified`: The profile has been verified and can be used to create live payments and test payments.
+    * `blocked`: The profile is blocked and can no longer be used or changed.
+    """
+
+    UNVERIFIED = "unverified"
+    VERIFIED = "verified"
+    BLOCKED = "blocked"
+
+
+class ProfileResponseReviewTypedDict(TypedDict):
+    r"""Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
+    automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
+    `null` in test mode.
+    """
+
+    status: NotRequired[ProfileReviewStatusResponse]
+    r"""The status of the requested changes."""
+
+
+class ProfileResponseReview(BaseModel):
+    r"""Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
+    automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
+    `null` in test mode.
+    """
+
+    status: Annotated[
+        Optional[ProfileReviewStatusResponse], PlainValidator(validate_open_enum(False))
+    ] = None
+    r"""The status of the requested changes."""
+
+
+class ProfileResponseLinksTypedDict(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."""
+    chargebacks: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    methods: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    payments: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    refunds: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    checkout_preview_url: 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 ProfileResponseLinks(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."""
+
+    chargebacks: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    methods: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    payments: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    refunds: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    checkout_preview_url: Annotated[
+        Optional[URL], pydantic.Field(alias="checkoutPreviewUrl")
+    ] = 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 ProfileResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a profile object. Will always contain the string `profile` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this profile. Example: `pfl_v9hTwCvYqw`."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    name: str
+    r"""The profile's name, this will usually reflect the trade name or brand name of the profile's website or
+    application.
+    """
+    website: str
+    r"""The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
+    allowed.
+    """
+    email: str
+    r"""The email address associated with the profile's trade name or brand."""
+    phone: str
+    r"""The phone number associated with the profile's trade name or brand."""
+    business_category: str
+    r"""The industry associated with the profile's trade name or brand. Please refer to the
+    [business category list](common-data-types#business-category) for all possible options.
+    """
+    status: ProfileResponseStatus
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    links: ProfileResponseLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    description: NotRequired[str]
+    r"""The products or services offered by the profile's website or application."""
+    countries_of_activity: NotRequired[List[str]]
+    r"""A list of countries where you expect that the majority of the profile's customers reside,
+    in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+    """
+    review: NotRequired[ProfileResponseReviewTypedDict]
+    r"""Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
+    automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
+    `null` in test mode.
+    """
+
+
+class ProfileResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a profile object. Will always contain the string `profile` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this profile. Example: `pfl_v9hTwCvYqw`."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    name: str
+    r"""The profile's name, this will usually reflect the trade name or brand name of the profile's website or
+    application.
+    """
+
+    website: str
+    r"""The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
+    allowed.
+    """
+
+    email: str
+    r"""The email address associated with the profile's trade name or brand."""
+
+    phone: str
+    r"""The phone number associated with the profile's trade name or brand."""
+
+    business_category: Annotated[str, pydantic.Field(alias="businessCategory")]
+    r"""The industry associated with the profile's trade name or brand. Please refer to the
+    [business category list](common-data-types#business-category) for all possible options.
+    """
+
+    status: Annotated[ProfileResponseStatus, PlainValidator(validate_open_enum(False))]
+
+    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[ProfileResponseLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    description: Optional[str] = None
+    r"""The products or services offered by the profile's website or application."""
+
+    countries_of_activity: Annotated[
+        Optional[List[str]], pydantic.Field(alias="countriesOfActivity")
+    ] = None
+    r"""A list of countries where you expect that the majority of the profile's customers reside,
+    in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+    """
+
+    review: Optional[ProfileResponseReview] = None
+    r"""Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
+    automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
+    `null` in test mode.
+    """

mollie/models/profile_review_status_response.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class ProfileReviewStatusResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the requested changes."""
+
+    PENDING = "pending"
+    REJECTED = "rejected"

mollie/models/recurring_line_item.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+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 RecurringLineItemTypedDict(TypedDict):
+    interval: str
+    r"""Cadence unit of the recurring item. For example: `12 months`, `52 weeks` or `365 days`.
+
+    Possible values: `... days`, `... weeks`, `... months`.
+    """
+    description: NotRequired[str]
+    r"""A description of the recurring item. If not present, the main description of the item will be used."""
+    amount: NotRequired[AmountTypedDict]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    times: NotRequired[int]
+    r"""Total number of charges for the subscription to complete. Leave empty for ongoing subscription."""
+    start_date: NotRequired[Nullable[str]]
+    r"""The start date of the subscription if it does not start right away (format `YYYY-MM-DD`)"""
+
+
+class RecurringLineItem(BaseModel):
+    interval: str
+    r"""Cadence unit of the recurring item. For example: `12 months`, `52 weeks` or `365 days`.
+
+    Possible values: `... days`, `... weeks`, `... months`.
+    """
+
+    description: Optional[str] = None
+    r"""A description of the recurring item. If not present, the main description of the item will be used."""
+
+    amount: Optional[Amount] = None
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    times: Optional[int] = None
+    r"""Total number of charges for the subscription to complete. Leave empty for ongoing subscription."""
+
+    start_date: Annotated[OptionalNullable[str], pydantic.Field(alias="startDate")] = (
+        UNSET
+    )
+    r"""The start date of the subscription if it does not start right away (format `YYYY-MM-DD`)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description", "amount", "times", "startDate"]
+        nullable_fields = ["startDate"]
+        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/refund_external_reference_type.py

@@ -0,0 +1,10 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class RefundExternalReferenceType(str, Enum):
+    r"""Specifies the reference type"""
+
+    ACQUIRER_REFERENCE = "acquirer-reference"

mollie/models/refund_external_reference_type_response.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class RefundExternalReferenceTypeResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Specifies the reference type"""
+
+    ACQUIRER_REFERENCE = "acquirer-reference"

mollie/models/refund_request.py

@@ -0,0 +1,200 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from .refund_external_reference_type import RefundExternalReferenceType
+from enum import Enum
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class RefundRequestExternalReferenceTypedDict(TypedDict):
+    type: NotRequired[RefundExternalReferenceType]
+    r"""Specifies the reference type"""
+    id: NotRequired[str]
+    r"""Unique reference from the payment provider"""
+
+
+class RefundRequestExternalReference(BaseModel):
+    type: Optional[RefundExternalReferenceType] = None
+    r"""Specifies the reference type"""
+
+    id: Optional[str] = None
+    r"""Unique reference from the payment provider"""
+
+
+class Type(str, Enum):
+    r"""The type of source. Currently only the source type `organization` is supported."""
+
+    ORGANIZATION = "organization"
+
+
+class RefundRequestSourceTypedDict(TypedDict):
+    r"""Where the funds will be pulled back from."""
+
+    type: NotRequired[Type]
+    organization_id: NotRequired[str]
+
+
+class RefundRequestSource(BaseModel):
+    r"""Where the funds will be pulled back from."""
+
+    type: Optional[Type] = None
+
+    organization_id: Annotated[
+        Optional[str], pydantic.Field(alias="organizationId")
+    ] = None
+
+
+class RefundRequestRoutingReversalTypedDict(TypedDict):
+    amount: NotRequired[AmountTypedDict]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    source: NotRequired[RefundRequestSourceTypedDict]
+    r"""Where the funds will be pulled back from."""
+
+
+class RefundRequestRoutingReversal(BaseModel):
+    amount: Optional[Amount] = None
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    source: Optional[RefundRequestSource] = None
+    r"""Where the funds will be pulled back from."""
+
+
+class RefundRequestTypedDict(TypedDict):
+    description: str
+    r"""The description of the refund that may be shown to your customer, depending on the payment method used."""
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    metadata: Nullable[MetadataTypedDict]
+    r"""Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+    you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+    """
+    external_reference: NotRequired[RefundRequestExternalReferenceTypedDict]
+    reverse_routing: NotRequired[Nullable[bool]]
+    r"""*This feature is only available to marketplace operators.*
+
+    With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+    merchants, by providing the `routing` object during [payment creation](create-payment).
+
+    When creating refunds for these *routed* payments, by default the full amount is deducted from your balance.
+
+    If you want to pull back the funds that were routed to the connected merchant(s), you can set this parameter to
+    `true` when issuing a full refund.
+
+    For more fine-grained control and for partial refunds, use the `routingReversals` parameter instead.
+    """
+    routing_reversals: NotRequired[
+        Nullable[List[RefundRequestRoutingReversalTypedDict]]
+    ]
+    r"""*This feature is only available to marketplace operators.*
+
+    When creating refunds for *routed* payments, by default the full amount is deducted from your balance.
+
+    If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount
+    needs to be reversed from which merchant(s).
+
+    If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
+    """
+    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 RefundRequest(BaseModel):
+    description: str
+    r"""The description of the refund that may be shown to your customer, depending on the payment method used."""
+
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    metadata: Nullable[Metadata]
+    r"""Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+    you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+    """
+
+    external_reference: Annotated[
+        Optional[RefundRequestExternalReference],
+        pydantic.Field(alias="externalReference"),
+    ] = None
+
+    reverse_routing: Annotated[
+        OptionalNullable[bool], pydantic.Field(alias="reverseRouting")
+    ] = UNSET
+    r"""*This feature is only available to marketplace operators.*
+
+    With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+    merchants, by providing the `routing` object during [payment creation](create-payment).
+
+    When creating refunds for these *routed* payments, by default the full amount is deducted from your balance.
+
+    If you want to pull back the funds that were routed to the connected merchant(s), you can set this parameter to
+    `true` when issuing a full refund.
+
+    For more fine-grained control and for partial refunds, use the `routingReversals` parameter instead.
+    """
+
+    routing_reversals: Annotated[
+        OptionalNullable[List[RefundRequestRoutingReversal]],
+        pydantic.Field(alias="routingReversals"),
+    ] = UNSET
+    r"""*This feature is only available to marketplace operators.*
+
+    When creating refunds for *routed* payments, by default the full amount is deducted from your balance.
+
+    If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount
+    needs to be reversed from which merchant(s).
+
+    If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
+    """
+
+    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 = [
+            "externalReference",
+            "reverseRouting",
+            "routingReversals",
+            "testmode",
+        ]
+        nullable_fields = ["metadata", "reverseRouting", "routingReversals", "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