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

mollie/models/list_settlement_refundsop.py

@@ -0,0 +1,191 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_entity_refund import ListEntityRefund, ListEntityRefundTypedDict
+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 ListSettlementRefundsGlobalsTypedDict(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 ListSettlementRefundsGlobals(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 ListSettlementRefundsRequestTypedDict(TypedDict):
+    settlement_id: str
+    r"""Provide the ID of the related settlement."""
+    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 ListSettlementRefundsRequest(BaseModel):
+    settlement_id: Annotated[
+        str,
+        pydantic.Field(alias="settlementId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related settlement."""
+
+    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 ListSettlementRefundsEmbeddedTypedDict(TypedDict):
+    refunds: List[ListEntityRefundTypedDict]
+    r"""An array of refund objects."""
+
+
+class ListSettlementRefundsEmbedded(BaseModel):
+    refunds: List[ListEntityRefund]
+    r"""An array of refund objects."""
+
+
+class ListSettlementRefundsResponseTypedDict(TypedDict):
+    r"""A list of refund objects. For a complete reference of the refund object, refer to the
+    [Get refund endpoint](get-refund) documentation.
+    """
+
+    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: ListSettlementRefundsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListSettlementRefundsResponse(BaseModel):
+    r"""A list of refund objects. For a complete reference of the refund object, refer to the
+    [Get refund endpoint](get-refund) documentation.
+    """
+
+    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[
+        ListSettlementRefundsEmbedded, 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_settlementsop.py

@@ -0,0 +1,178 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .currencies import Currencies
+from .list_entity_settlement import ListEntitySettlement, ListEntitySettlementTypedDict
+from .list_links import ListLinks, ListLinksTypedDict
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    QueryParamMetadata,
+    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 ListSettlementsRequestTypedDict(TypedDict):
+    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."""
+    balance_id: NotRequired[str]
+    r"""Provide the token of the balance to filter the settlements by. This is
+    the balance token that the settlement was settled to.
+    """
+    year: NotRequired[Nullable[str]]
+    r"""Provide the year to query the settlements. Must be used combined with `month` parameter"""
+    month: NotRequired[Nullable[str]]
+    r"""Provide the month to query the settlements. Must be used combined with `year` parameter"""
+    currencies: NotRequired[Currencies]
+    r"""Provides the currencies to retrieve the settlements. It accepts multiple currencies in a comma-separated format."""
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+
+class ListSettlementsRequest(BaseModel):
+    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."""
+
+    balance_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="balanceId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Provide the token of the balance to filter the settlements by. This is
+    the balance token that the settlement was settled to.
+    """
+
+    year: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Provide the year to query the settlements. Must be used combined with `month` parameter"""
+
+    month: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Provide the month to query the settlements. Must be used combined with `year` parameter"""
+
+    currencies: Annotated[
+        Annotated[Optional[Currencies], PlainValidator(validate_open_enum(False))],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Provides the currencies to retrieve the settlements. It accepts multiple currencies in a comma-separated format."""
+
+    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",
+            "balanceId",
+            "year",
+            "month",
+            "currencies",
+            "idempotency-key",
+        ]
+        nullable_fields = ["from", "limit", "year", "month"]
+        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 ListSettlementsEmbeddedTypedDict(TypedDict):
+    settlements: List[ListEntitySettlementTypedDict]
+    r"""An array of settlement objects. For a complete reference
+    of the settlement object, refer to the [Get settlement endpoint](get-settlement) documentation.
+    """
+
+
+class ListSettlementsEmbedded(BaseModel):
+    settlements: List[ListEntitySettlement]
+    r"""An array of settlement objects. For a complete reference
+    of the settlement object, refer to the [Get settlement endpoint](get-settlement) documentation.
+    """
+
+
+class ListSettlementsResponseTypedDict(TypedDict):
+    r"""A list of settlement objects. For a complete reference of the settlement
+    object, refer to the [Get settlement endpoint](get-settlement) documentation.
+    """
+
+    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: ListSettlementsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListSettlementsResponse(BaseModel):
+    r"""A list of settlement objects. For a complete reference of the settlement
+    object, refer to the [Get settlement endpoint](get-settlement) documentation.
+    """
+
+    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[ListSettlementsEmbedded, 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_subscription_paymentsop.py

@@ -0,0 +1,242 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_links import ListLinks, ListLinksTypedDict
+from .list_payment_response import ListPaymentResponse, ListPaymentResponseTypedDict
+from .sorting import Sorting
+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 ListSubscriptionPaymentsGlobalsTypedDict(TypedDict):
+    profile_id: NotRequired[str]
+    r"""The identifier referring to the [profile](get-profile) you wish to
+    retrieve the resources for.
+
+    Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
+    organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
+    """
+    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 ListSubscriptionPaymentsGlobals(BaseModel):
+    profile_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="profileId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The identifier referring to the [profile](get-profile) you wish to
+    retrieve the resources for.
+
+    Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
+    organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
+    """
+
+    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 ListSubscriptionPaymentsRequestTypedDict(TypedDict):
+    customer_id: str
+    r"""Provide the ID of the related customer."""
+    subscription_id: str
+    r"""Provide the ID of the related subscription."""
+    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."""
+    sort: NotRequired[Sorting]
+    r"""Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
+    newest to oldest.
+    """
+    profile_id: NotRequired[str]
+    r"""The identifier referring to the [profile](get-profile) you wish to
+    retrieve the resources for.
+
+    Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
+    organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
+    """
+    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 ListSubscriptionPaymentsRequest(BaseModel):
+    customer_id: Annotated[
+        str,
+        pydantic.Field(alias="customerId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related customer."""
+
+    subscription_id: Annotated[
+        str,
+        pydantic.Field(alias="subscriptionId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related subscription."""
+
+    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."""
+
+    sort: Annotated[
+        Optional[Sorting],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
+    newest to oldest.
+    """
+
+    profile_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="profileId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The identifier referring to the [profile](get-profile) you wish to
+    retrieve the resources for.
+
+    Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
+    organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
+    """
+
+    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",
+            "sort",
+            "profileId",
+            "testmode",
+            "idempotency-key",
+        ]
+        nullable_fields = ["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 ListSubscriptionPaymentsEmbeddedTypedDict(TypedDict):
+    payments: NotRequired[List[ListPaymentResponseTypedDict]]
+    r"""An array of payment objects."""
+
+
+class ListSubscriptionPaymentsEmbedded(BaseModel):
+    payments: Optional[List[ListPaymentResponse]] = None
+    r"""An array of payment objects."""
+
+
+class ListSubscriptionPaymentsResponseTypedDict(TypedDict):
+    r"""A list of payment 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: ListSubscriptionPaymentsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListSubscriptionPaymentsResponse(BaseModel):
+    r"""A list of payment 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[
+        ListSubscriptionPaymentsEmbedded, 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."""