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

mollie/models/list_capturesop.py

@@ -0,0 +1,185 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_capture_response import ListCaptureResponse, ListCaptureResponseTypedDict
+from .list_links import ListLinks, ListLinksTypedDict
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListCapturesGlobalsTypedDict(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 ListCapturesGlobals(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 ListCapturesRequestTypedDict(TypedDict):
+    payment_id: str
+    r"""Provide the ID of the related payment."""
+    from_: NotRequired[str]
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+    limit: NotRequired[Nullable[int]]
+    r"""The maximum number of items to return. Defaults to 50 items."""
+    embed: NotRequired[Nullable[str]]
+    r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
+    parameter.
+    """
+    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 ListCapturesRequest(BaseModel):
+    payment_id: Annotated[
+        str,
+        pydantic.Field(alias="paymentId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related payment."""
+
+    from_: Annotated[
+        Optional[str],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+
+    limit: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The maximum number of items to return. Defaults to 50 items."""
+
+    embed: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
+    parameter.
+    """
+
+    testmode: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+    parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+    setting the `testmode` query parameter to `true`.
+
+    Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+    """
+
+    idempotency_key: Annotated[
+        Optional[str],
+        pydantic.Field(alias="idempotency-key"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["from", "limit", "embed", "testmode", "idempotency-key"]
+        nullable_fields = ["limit", "embed"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
+
+class ListCapturesEmbeddedTypedDict(TypedDict):
+    captures: List[ListCaptureResponseTypedDict]
+    r"""An array of capture objects."""
+
+
+class ListCapturesEmbedded(BaseModel):
+    captures: List[ListCaptureResponse]
+    r"""An array of capture objects."""
+
+
+class ListCapturesResponseTypedDict(TypedDict):
+    r"""A list of capture 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: ListCapturesEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListCapturesResponse(BaseModel):
+    r"""A list of capture 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[ListCapturesEmbedded, pydantic.Field(alias="_embedded")]
+
+    links: Annotated[ListLinks, pydantic.Field(alias="_links")]
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""

mollie/models/list_chargebacksop.py

@@ -0,0 +1,185 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_entity_chargeback import ListEntityChargeback, ListEntityChargebackTypedDict
+from .list_links import ListLinks, ListLinksTypedDict
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListChargebacksGlobalsTypedDict(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 ListChargebacksGlobals(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 ListChargebacksRequestTypedDict(TypedDict):
+    payment_id: str
+    r"""Provide the ID of the related payment."""
+    from_: NotRequired[str]
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+    limit: NotRequired[Nullable[int]]
+    r"""The maximum number of items to return. Defaults to 50 items."""
+    embed: NotRequired[Nullable[str]]
+    r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
+    parameter.
+    """
+    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 ListChargebacksRequest(BaseModel):
+    payment_id: Annotated[
+        str,
+        pydantic.Field(alias="paymentId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related payment."""
+
+    from_: Annotated[
+        Optional[str],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+
+    limit: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The maximum number of items to return. Defaults to 50 items."""
+
+    embed: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
+    parameter.
+    """
+
+    testmode: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+    parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+    setting the `testmode` query parameter to `true`.
+
+    Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+    """
+
+    idempotency_key: Annotated[
+        Optional[str],
+        pydantic.Field(alias="idempotency-key"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["from", "limit", "embed", "testmode", "idempotency-key"]
+        nullable_fields = ["limit", "embed"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
+
+class ListChargebacksEmbeddedTypedDict(TypedDict):
+    chargebacks: List[ListEntityChargebackTypedDict]
+    r"""A list of chargeback objects."""
+
+
+class ListChargebacksEmbedded(BaseModel):
+    chargebacks: List[ListEntityChargeback]
+    r"""A list of chargeback objects."""
+
+
+class ListChargebacksResponseTypedDict(TypedDict):
+    r"""A list of chargeback 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: ListChargebacksEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListChargebacksResponse(BaseModel):
+    r"""A list of chargeback 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[ListChargebacksEmbedded, pydantic.Field(alias="_embedded")]
+
+    links: Annotated[ListLinks, pydantic.Field(alias="_links")]
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""

mollie/models/list_clientsop.py

@@ -0,0 +1,269 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .entity_capability import EntityCapability, EntityCapabilityTypedDict
+from .entity_onboarding_status import (
+    EntityOnboardingStatus,
+    EntityOnboardingStatusTypedDict,
+)
+from .entity_organization import EntityOrganization, EntityOrganizationTypedDict
+from .list_links import ListLinks, ListLinksTypedDict
+from .url import URL, URLTypedDict
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import FieldMetadata, HeaderMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListClientsRequestTypedDict(TypedDict):
+    embed: NotRequired[Nullable[str]]
+    r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
+    parameter.
+    """
+    from_: NotRequired[Nullable[str]]
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+    limit: NotRequired[Nullable[int]]
+    r"""The maximum number of items to return. Defaults to 50 items."""
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+
+class ListClientsRequest(BaseModel):
+    embed: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
+    parameter.
+    """
+
+    from_: Annotated[
+        OptionalNullable[str],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+    result set.
+    """
+
+    limit: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The maximum number of items to return. Defaults to 50 items."""
+
+    idempotency_key: Annotated[
+        Optional[str],
+        pydantic.Field(alias="idempotency-key"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["embed", "from", "limit", "idempotency-key"]
+        nullable_fields = ["embed", "from", "limit"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
+
+class ListClientsCommissionTypedDict(TypedDict):
+    r"""The commission object."""
+
+    count: NotRequired[int]
+    r"""The commission count."""
+
+
+class ListClientsCommission(BaseModel):
+    r"""The commission object."""
+
+    count: Optional[int] = None
+    r"""The commission count."""
+
+
+class ListClientsLinksTypedDict(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."""
+    organization: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    onboarding: NotRequired[URLTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListClientsLinks(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."""
+
+    organization: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    onboarding: Optional[URL] = None
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ClientEmbeddedTypedDict(TypedDict):
+    organization: NotRequired[EntityOrganizationTypedDict]
+    onboarding: NotRequired[EntityOnboardingStatusTypedDict]
+    capabilities: NotRequired[EntityCapabilityTypedDict]
+
+
+class ClientEmbedded(BaseModel):
+    organization: Optional[EntityOrganization] = None
+
+    onboarding: Optional[EntityOnboardingStatus] = None
+
+    capabilities: Optional[EntityCapability] = None
+
+
+class ListClientsClientTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a client object. Will always contain the string `client` for this resource type."""
+    id: str
+    r"""The identifier uniquely referring to this client. Example: `org_12345678`."""
+    links: ListClientsLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    commission: NotRequired[Nullable[ListClientsCommissionTypedDict]]
+    r"""The commission object."""
+    organization_created_at: NotRequired[str]
+    r"""The date and time the client organization was created, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+    format.
+    """
+    embedded: NotRequired[ClientEmbeddedTypedDict]
+
+
+class ListClientsClient(BaseModel):
+    resource: str
+    r"""Indicates the response contains a client object. Will always contain the string `client` for this resource type."""
+
+    id: str
+    r"""The identifier uniquely referring to this client. Example: `org_12345678`."""
+
+    links: Annotated[ListClientsLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    commission: OptionalNullable[ListClientsCommission] = UNSET
+    r"""The commission object."""
+
+    organization_created_at: Annotated[
+        Optional[str], pydantic.Field(alias="organizationCreatedAt")
+    ] = None
+    r"""The date and time the client organization was created, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+    format.
+    """
+
+    embedded: Annotated[Optional[ClientEmbedded], pydantic.Field(alias="_embedded")] = (
+        None
+    )
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["commission", "organizationCreatedAt", "_embedded"]
+        nullable_fields = ["commission"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
+
+class ListClientsEmbeddedTypedDict(TypedDict):
+    clients: NotRequired[List[ListClientsClientTypedDict]]
+    r"""An array of client objects. For a complete reference of the client object, refer to the
+    [Get client endpoint](get-client) documentation.
+    """
+
+
+class ListClientsEmbedded(BaseModel):
+    clients: Optional[List[ListClientsClient]] = None
+    r"""An array of client objects. For a complete reference of the client object, refer to the
+    [Get client endpoint](get-client) documentation.
+    """
+
+
+class ListClientsResponseTypedDict(TypedDict):
+    r"""A list of client objects. For a complete reference of the client object, refer to the
+    [Get client endpoint](get-client) documentation.
+    """
+
+    count: NotRequired[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: NotRequired[ListClientsEmbeddedTypedDict]
+    links: NotRequired[ListLinksTypedDict]
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListClientsResponse(BaseModel):
+    r"""A list of client objects. For a complete reference of the client object, refer to the
+    [Get client endpoint](get-client) documentation.
+    """
+
+    count: Optional[int] = None
+    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[
+        Optional[ListClientsEmbedded], pydantic.Field(alias="_embedded")
+    ] = None
+
+    links: Annotated[Optional[ListLinks], pydantic.Field(alias="_links")] = None
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""