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

mollie/models/get_organizationop.py

@@ -0,0 +1,71 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOrganizationGlobalsTypedDict(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 GetOrganizationGlobals(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 GetOrganizationRequestTypedDict(TypedDict):
+    id: str
+    r"""Provide the ID of the item you want to perform this operation on."""
+    testmode: NotRequired[bool]
+    r"""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 GetOrganizationRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Provide the ID of the item you want to perform this operation on."""
+
+    testmode: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""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."""

mollie/models/get_partner_statusop.py

@@ -0,0 +1,231 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .url import URL, URLTypedDict
+from enum import Enum
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import FieldMetadata, HeaderMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetPartnerStatusRequestTypedDict(TypedDict):
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+
+class GetPartnerStatusRequest(BaseModel):
+    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."""
+
+
+class PartnerType(str, Enum):
+    r"""Indicates the type of partner. Will be `null` if the currently authenticated organization is not
+    enrolled as a partner.
+    """
+
+    OAUTH = "oauth"
+    SIGNUPLINK = "signuplink"
+    USERAGENT = "useragent"
+
+
+class UserAgentTokenTypedDict(TypedDict):
+    token: NotRequired[str]
+    r"""The unique User-Agent token."""
+    starts_at: NotRequired[str]
+    r"""The date from which the token is active, in ISO 8601 format."""
+    ends_at: NotRequired[Nullable[str]]
+    r"""The date until when the token will be active, in ISO 8601 format. Will be `null` if the token
+    does not have an end date (yet).
+    """
+
+
+class UserAgentToken(BaseModel):
+    token: Optional[str] = None
+    r"""The unique User-Agent token."""
+
+    starts_at: Annotated[Optional[str], pydantic.Field(alias="startsAt")] = None
+    r"""The date from which the token is active, in ISO 8601 format."""
+
+    ends_at: Annotated[OptionalNullable[str], pydantic.Field(alias="endsAt")] = UNSET
+    r"""The date until when the token will be active, in ISO 8601 format. Will be `null` if the token
+    does not have an end date (yet).
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["token", "startsAt", "endsAt"]
+        nullable_fields = ["endsAt"]
+        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 GetPartnerStatusLinksTypedDict(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."""
+    signuplink: 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 GetPartnerStatusLinks(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."""
+
+    signuplink: Optional[URL] = 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 GetPartnerStatusResponseTypedDict(TypedDict):
+    r"""The partner status object."""
+
+    resource: str
+    r"""Indicates the response contains a partner status object. Will always contain the string `partner` for
+    this endpoint.
+    """
+    partner_type: Nullable[PartnerType]
+    r"""Indicates the type of partner. Will be `null` if the currently authenticated organization is not
+    enrolled as a partner.
+    """
+    is_commission_partner: NotRequired[bool]
+    r"""Whether the current organization is receiving commissions."""
+    user_agent_tokens: NotRequired[List[UserAgentTokenTypedDict]]
+    r"""Array of User-Agent token objects. Present if the organization is a partner of type `useragent`, or if
+    they were in the past.
+    """
+    partner_contract_signed_at: NotRequired[Nullable[str]]
+    r"""The date the partner contract was signed, in ISO 8601 format. Omitted if no contract has been signed
+    (yet).
+    """
+    partner_contract_update_available: NotRequired[bool]
+    r"""Whether an update to the partner contract is available and requiring the organization's agreement."""
+    partner_contract_expires_at: NotRequired[str]
+    r"""The expiration date of the signed partner contract, in ISO 8601 format. Omitted if contract has no
+    expiration date (yet).
+    """
+    links: NotRequired[GetPartnerStatusLinksTypedDict]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class GetPartnerStatusResponse(BaseModel):
+    r"""The partner status object."""
+
+    resource: str
+    r"""Indicates the response contains a partner status object. Will always contain the string `partner` for
+    this endpoint.
+    """
+
+    partner_type: Annotated[Nullable[PartnerType], pydantic.Field(alias="partnerType")]
+    r"""Indicates the type of partner. Will be `null` if the currently authenticated organization is not
+    enrolled as a partner.
+    """
+
+    is_commission_partner: Annotated[
+        Optional[bool], pydantic.Field(alias="isCommissionPartner")
+    ] = None
+    r"""Whether the current organization is receiving commissions."""
+
+    user_agent_tokens: Annotated[
+        Optional[List[UserAgentToken]], pydantic.Field(alias="userAgentTokens")
+    ] = None
+    r"""Array of User-Agent token objects. Present if the organization is a partner of type `useragent`, or if
+    they were in the past.
+    """
+
+    partner_contract_signed_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="partnerContractSignedAt")
+    ] = UNSET
+    r"""The date the partner contract was signed, in ISO 8601 format. Omitted if no contract has been signed
+    (yet).
+    """
+
+    partner_contract_update_available: Annotated[
+        Optional[bool], pydantic.Field(alias="partnerContractUpdateAvailable")
+    ] = None
+    r"""Whether an update to the partner contract is available and requiring the organization's agreement."""
+
+    partner_contract_expires_at: Annotated[
+        Optional[str], pydantic.Field(alias="partnerContractExpiresAt")
+    ] = None
+    r"""The expiration date of the signed partner contract, in ISO 8601 format. Omitted if contract has no
+    expiration date (yet).
+    """
+
+    links: Annotated[
+        Optional[GetPartnerStatusLinks], pydantic.Field(alias="_links")
+    ] = None
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "isCommissionPartner",
+            "userAgentTokens",
+            "partnerContractSignedAt",
+            "partnerContractUpdateAvailable",
+            "partnerContractExpiresAt",
+            "_links",
+        ]
+        nullable_fields = ["partnerType", "partnerContractSignedAt"]
+        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/get_payment_link_paymentsop.py

@@ -0,0 +1,188 @@
+"""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 GetPaymentLinkPaymentsGlobalsTypedDict(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 GetPaymentLinkPaymentsGlobals(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 GetPaymentLinkPaymentsRequestTypedDict(TypedDict):
+    payment_link_id: str
+    r"""Provide the ID of the related payment link."""
+    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.
+    """
+    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 GetPaymentLinkPaymentsRequest(BaseModel):
+    payment_link_id: Annotated[
+        str,
+        pydantic.Field(alias="paymentLinkId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related payment link."""
+
+    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.
+    """
+
+    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", "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 GetPaymentLinkPaymentsEmbeddedTypedDict(TypedDict):
+    payments: NotRequired[List[ListPaymentResponseTypedDict]]
+    r"""An array of payment objects."""
+
+
+class GetPaymentLinkPaymentsEmbedded(BaseModel):
+    payments: Optional[List[ListPaymentResponse]] = None
+    r"""An array of payment objects."""
+
+
+class GetPaymentLinkPaymentsResponseTypedDict(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: GetPaymentLinkPaymentsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class GetPaymentLinkPaymentsResponse(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[
+        GetPaymentLinkPaymentsEmbedded, 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/get_payment_linkop.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetPaymentLinkGlobalsTypedDict(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 GetPaymentLinkGlobals(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 GetPaymentLinkRequestTypedDict(TypedDict):
+    payment_link_id: str
+    r"""Provide the ID of the related payment link."""
+    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 GetPaymentLinkRequest(BaseModel):
+    payment_link_id: Annotated[
+        str,
+        pydantic.Field(alias="paymentLinkId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related payment link."""
+
+    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."""