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

mollie/models/entity_balance_transfer.py

@@ -0,0 +1,62 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .balance_transfer_category import BalanceTransferCategory
+from .entity_balance_transfer_party import (
+    EntityBalanceTransferParty,
+    EntityBalanceTransferPartyTypedDict,
+)
+from mollie.types import BaseModel
+from typing import Any, Dict, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class EntityBalanceTransferTypedDict(TypedDict):
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    source: EntityBalanceTransferPartyTypedDict
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+    destination: EntityBalanceTransferPartyTypedDict
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+    description: str
+    r"""The transfer description for initiating party."""
+    category: NotRequired[BalanceTransferCategory]
+    r"""The type of the transfer. Different fees may apply to different types of transfers."""
+    metadata: NotRequired[Dict[str, Any]]
+    r"""A JSON object that you can attach to a balance transfer.
+    This can be useful for storing additional information about the transfer in a structured format. Maximum size is approximately 1KB.
+    """
+    testmode: NotRequired[bool]
+    r"""Whether to create the entity in test mode or live mode.
+
+    You can enable test mode by setting `testmode` to `true`.
+    """
+
+
+class EntityBalanceTransfer(BaseModel):
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    source: EntityBalanceTransferParty
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    destination: EntityBalanceTransferParty
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    description: str
+    r"""The transfer description for initiating party."""
+
+    category: Optional[BalanceTransferCategory] = None
+    r"""The type of the transfer. Different fees may apply to different types of transfers."""
+
+    metadata: Optional[Dict[str, Any]] = None
+    r"""A JSON object that you can attach to a balance transfer.
+    This can be useful for storing additional information about the transfer in a structured format. Maximum size is approximately 1KB.
+    """
+
+    testmode: Optional[bool] = None
+    r"""Whether to create the entity in test mode or live mode.
+
+    You can enable test mode by setting `testmode` to `true`.
+    """

mollie/models/entity_balance_transfer_party.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .balance_transfer_party_type import BalanceTransferPartyType
+from mollie.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class EntityBalanceTransferPartyTypedDict(TypedDict):
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    type: BalanceTransferPartyType
+    r"""Defines the type of the party. At the moment, only `organization` is supported."""
+    id: str
+    description: str
+    r"""The transfer description for the transfer party. This is the description that will appear in the financial reports of the party."""
+
+
+class EntityBalanceTransferParty(BaseModel):
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    type: BalanceTransferPartyType
+    r"""Defines the type of the party. At the moment, only `organization` is supported."""
+
+    id: str
+
+    description: str
+    r"""The transfer description for the transfer party. This is the description that will appear in the financial reports of the party."""

mollie/models/entity_balance_transfer_party_response.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .balance_transfer_party_type_response import BalanceTransferPartyTypeResponse
+from mollie.types import BaseModel
+from mollie.utils import validate_open_enum
+from pydantic.functional_validators import PlainValidator
+from typing_extensions import Annotated, TypedDict
+
+
+class EntityBalanceTransferPartyResponseTypedDict(TypedDict):
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    type: BalanceTransferPartyTypeResponse
+    r"""Defines the type of the party. At the moment, only `organization` is supported."""
+    id: str
+    description: str
+    r"""The transfer description for the transfer party. This is the description that will appear in the financial reports of the party."""
+
+
+class EntityBalanceTransferPartyResponse(BaseModel):
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    type: Annotated[
+        BalanceTransferPartyTypeResponse, PlainValidator(validate_open_enum(False))
+    ]
+    r"""Defines the type of the party. At the moment, only `organization` is supported."""
+
+    id: str
+
+    description: str
+    r"""The transfer description for the transfer party. This is the description that will appear in the financial reports of the party."""

mollie/models/entity_balance_transfer_response.py

@@ -0,0 +1,159 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .balance_transfer_category_response import BalanceTransferCategoryResponse
+from .balance_transfer_status import BalanceTransferStatus
+from .balance_transfer_status_reason_response import BalanceTransferStatusReasonResponse
+from .entity_balance_transfer_party_response import (
+    EntityBalanceTransferPartyResponse,
+    EntityBalanceTransferPartyResponseTypedDict,
+)
+from .mode import Mode
+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 Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EntityBalanceTransferResponseStatusReasonTypedDict(TypedDict):
+    r"""The reason for the current status of the transfer, if applicable."""
+
+    code: BalanceTransferStatusReasonResponse
+    r"""A machine-readable code that indicates the reason for the transfer's status."""
+    message: str
+    r"""A description of the status reason, localized according to the transfer."""
+
+
+class EntityBalanceTransferResponseStatusReason(BaseModel):
+    r"""The reason for the current status of the transfer, if applicable."""
+
+    code: Annotated[
+        BalanceTransferStatusReasonResponse, PlainValidator(validate_open_enum(False))
+    ]
+    r"""A machine-readable code that indicates the reason for the transfer's status."""
+
+    message: str
+    r"""A description of the status reason, localized according to the transfer."""
+
+
+class EntityBalanceTransferResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a balance transfer object. Will always contain the string `connect-balance-transfer` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this balance transfer. Mollie assigns this identifier at balance transfer creation time. Mollie
+    will always refer to the balance transfer by this ID. Example: `cbtr_j8NvRAM2WNZtsykpLEX8J`.
+    """
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    source: EntityBalanceTransferPartyResponseTypedDict
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+    destination: EntityBalanceTransferPartyResponseTypedDict
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+    description: str
+    r"""The transfer description for initiating party."""
+    status: BalanceTransferStatus
+    r"""The status of the transfer."""
+    status_reason: EntityBalanceTransferResponseStatusReasonTypedDict
+    r"""The reason for the current status of the transfer, if applicable."""
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    category: NotRequired[BalanceTransferCategoryResponse]
+    r"""The type of the transfer. Different fees may apply to different types of transfers."""
+    metadata: NotRequired[Dict[str, Any]]
+    r"""A JSON object that you can attach to a balance transfer.
+    This can be useful for storing additional information about the transfer in a structured format. Maximum size is approximately 1KB.
+    """
+    executed_at: NotRequired[Nullable[str]]
+    r"""The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is
+    not executed (yet).
+    """
+
+
+class EntityBalanceTransferResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a balance transfer object. Will always contain the string `connect-balance-transfer` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this balance transfer. Mollie assigns this identifier at balance transfer creation time. Mollie
+    will always refer to the balance transfer by this ID. Example: `cbtr_j8NvRAM2WNZtsykpLEX8J`.
+    """
+
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    source: EntityBalanceTransferPartyResponse
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    destination: EntityBalanceTransferPartyResponse
+    r"""A party involved in the balance transfer, either the sender or the receiver."""
+
+    description: str
+    r"""The transfer description for initiating party."""
+
+    status: Annotated[BalanceTransferStatus, PlainValidator(validate_open_enum(False))]
+    r"""The status of the transfer."""
+
+    status_reason: Annotated[
+        EntityBalanceTransferResponseStatusReason, pydantic.Field(alias="statusReason")
+    ]
+    r"""The reason for the current status of the transfer, if applicable."""
+
+    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."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    category: Annotated[
+        Optional[BalanceTransferCategoryResponse],
+        PlainValidator(validate_open_enum(False)),
+    ] = None
+    r"""The type of the transfer. Different fees may apply to different types of transfers."""
+
+    metadata: Optional[Dict[str, Any]] = None
+    r"""A JSON object that you can attach to a balance transfer.
+    This can be useful for storing additional information about the transfer in a structured format. Maximum size is approximately 1KB.
+    """
+
+    executed_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="executedAt")
+    ] = UNSET
+    r"""The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is
+    not executed (yet).
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["category", "metadata", "executedAt"]
+        nullable_fields = ["executedAt"]
+        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_capability.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .capability_status import CapabilityStatus
+from .capability_status_reason import CapabilityStatusReason
+from .entity_capability_requirement import (
+    EntityCapabilityRequirement,
+    EntityCapabilityRequirementTypedDict,
+)
+from mollie.types import BaseModel, Nullable, UNSET_SENTINEL
+from mollie.utils import validate_open_enum
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class EntityCapabilityTypedDict(TypedDict):
+    resource: str
+    r"""Always the word `capability` for this resource type."""
+    name: str
+    r"""A unique name for this capability like `payments` / `settlements`."""
+    status: CapabilityStatus
+    status_reason: Nullable[CapabilityStatusReason]
+    requirements: List[EntityCapabilityRequirementTypedDict]
+
+
+class EntityCapability(BaseModel):
+    resource: str
+    r"""Always the word `capability` for this resource type."""
+
+    name: str
+    r"""A unique name for this capability like `payments` / `settlements`."""
+
+    status: Annotated[CapabilityStatus, PlainValidator(validate_open_enum(False))]
+
+    status_reason: Annotated[
+        Annotated[
+            Nullable[CapabilityStatusReason], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="statusReason"),
+    ]
+
+    requirements: List[EntityCapabilityRequirement]
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["statusReason"]
+        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_capability_requirement.py

@@ -0,0 +1,87 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .capability_requirement_status import CapabilityRequirementStatus
+from .url import URL, URLTypedDict
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EntityCapabilityRequirementLinksTypedDict(TypedDict):
+    dashboard: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityCapabilityRequirementLinks(BaseModel):
+    dashboard: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class EntityCapabilityRequirementTypedDict(TypedDict):
+    id: str
+    r"""The name of this requirement, referring to the task to be fulfilled by the organization
+    to enable or re-enable the capability. The name is unique among other requirements
+    of the same capability.
+    """
+    status: CapabilityRequirementStatus
+    r"""The status of the requirement depends on its due date.
+    If no due date is given, the status will be `requested`.
+    """
+    due_date: Nullable[str]
+    r"""Due date until the requirement must be fulfilled, if any. The date is shown in ISO-8601 format."""
+    links: EntityCapabilityRequirementLinksTypedDict
+
+
+class EntityCapabilityRequirement(BaseModel):
+    id: str
+    r"""The name of this requirement, referring to the task to be fulfilled by the organization
+    to enable or re-enable the capability. The name is unique among other requirements
+    of the same capability.
+    """
+
+    status: Annotated[
+        CapabilityRequirementStatus, PlainValidator(validate_open_enum(False))
+    ]
+    r"""The status of the requirement depends on its due date.
+    If no due date is given, the status will be `requested`.
+    """
+
+    due_date: Annotated[Nullable[str], pydantic.Field(alias="dueDate")]
+    r"""Due date until the requirement must be fulfilled, if any. The date is shown in ISO-8601 format."""
+
+    links: Annotated[EntityCapabilityRequirementLinks, pydantic.Field(alias="_links")]
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["dueDate"]
+        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_capture.py

@@ -0,0 +1,63 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount_nullable import AmountNullable, AmountNullableTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class EntityCaptureTypedDict(TypedDict):
+    description: NotRequired[str]
+    r"""The description of the capture."""
+    amount: NotRequired[Nullable[AmountNullableTypedDict]]
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    metadata: NotRequired[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.
+    """
+
+
+class EntityCapture(BaseModel):
+    description: Optional[str] = None
+    r"""The description of the capture."""
+
+    amount: OptionalNullable[AmountNullable] = UNSET
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    metadata: OptionalNullable[Metadata] = UNSET
+    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.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description", "amount", "metadata"]
+        nullable_fields = ["amount", "metadata"]
+        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