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

mollie/models/list_refundsop.py

@@ -0,0 +1,189 @@
+"""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 ListRefundsGlobalsTypedDict(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 ListRefundsGlobals(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 ListRefundsRequestTypedDict(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 ListRefundsRequest(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 ListRefundsEmbeddedTypedDict(TypedDict):
+    refunds: List[ListEntityRefundTypedDict]
+    r"""An array of refund objects."""
+
+
+class ListRefundsEmbedded(BaseModel):
+    refunds: List[ListEntityRefund]
+    r"""An array of refund objects."""
+
+
+class ListRefundsResponseTypedDict(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: ListRefundsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListRefundsResponse(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[ListRefundsEmbedded, 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_route_get_response.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .route_destination_type_response import RouteDestinationTypeResponse
+from .url import URL, URLTypedDict
+from mollie.types import BaseModel
+from mollie.utils import validate_open_enum
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing_extensions import Annotated, TypedDict
+
+
+class ListRouteGetResponseDestinationTypedDict(TypedDict):
+    r"""The destination of the route."""
+
+    type: RouteDestinationTypeResponse
+    r"""The type of destination. Currently only the destination type `organization` is supported."""
+    organization_id: str
+
+
+class ListRouteGetResponseDestination(BaseModel):
+    r"""The destination of the route."""
+
+    type: Annotated[
+        RouteDestinationTypeResponse, PlainValidator(validate_open_enum(False))
+    ]
+    r"""The type of destination. Currently only the destination type `organization` is supported."""
+
+    organization_id: Annotated[str, pydantic.Field(alias="organizationId")]
+
+
+class ListRouteGetResponseLinksTypedDict(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."""
+
+
+class ListRouteGetResponseLinks(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."""
+
+
+class ListRouteGetResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a route object. Will always contain the string `route` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this route. Mollie assigns this identifier at route creation time. Mollie
+    will always refer to the route by this ID. Example: `crt_dyARQ3JzCgtPDhU2Pbq3J`.
+    """
+    payment_id: str
+    r"""The unique identifier of the payment. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+    The full payment object can be retrieved via the payment URL in the `_links` object.
+    """
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    description: str
+    r"""The description of the route. This description is shown in the reports."""
+    destination: ListRouteGetResponseDestinationTypedDict
+    r"""The destination of the route."""
+    links: ListRouteGetResponseLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+
+
+class ListRouteGetResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a route object. Will always contain the string `route` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this route. Mollie assigns this identifier at route creation time. Mollie
+    will always refer to the route by this ID. Example: `crt_dyARQ3JzCgtPDhU2Pbq3J`.
+    """
+
+    payment_id: Annotated[str, pydantic.Field(alias="paymentId")]
+    r"""The unique identifier of the payment. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+    The full payment object can be retrieved via the payment URL in the `_links` object.
+    """
+
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    description: str
+    r"""The description of the route. This description is shown in the reports."""
+
+    destination: ListRouteGetResponseDestination
+    r"""The destination of the route."""
+
+    links: Annotated[ListRouteGetResponseLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    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."""