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

mollie/models/list_subscription_response.py

@@ -0,0 +1,344 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from .mode import Mode
+from .subscription_method_response import SubscriptionMethodResponse
+from .url import URL, URLTypedDict
+from .url_nullable import URLNullable, URLNullableTypedDict
+from enum import Enum
+from mollie import utils
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListSubscriptionResponseStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The subscription's current status is directly related to the status of the underlying customer or mandate that is
+    enabling the subscription.
+    """
+
+    PENDING = "pending"
+    ACTIVE = "active"
+    CANCELED = "canceled"
+    SUSPENDED = "suspended"
+    COMPLETED = "completed"
+
+
+class ListSubscriptionResponseApplicationFeeTypedDict(TypedDict):
+    r"""With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+    merchants.
+
+    Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
+
+    Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
+    information.
+    """
+
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    description: str
+
+
+class ListSubscriptionResponseApplicationFee(BaseModel):
+    r"""With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+    merchants.
+
+    Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
+
+    Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
+    information.
+    """
+
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    description: str
+
+
+class ListSubscriptionResponseLinksTypedDict(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."""
+    customer: Nullable[URLNullableTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    profile: Nullable[URLNullableTypedDict]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    mandate: NotRequired[Nullable[URLNullableTypedDict]]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    payments: NotRequired[Nullable[URLNullableTypedDict]]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class ListSubscriptionResponseLinks(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."""
+
+    customer: Nullable[URLNullable]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    profile: Nullable[URLNullable]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    mandate: OptionalNullable[URLNullable] = UNSET
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    payments: OptionalNullable[URLNullable] = UNSET
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["mandate", "payments"]
+        nullable_fields = ["customer", "mandate", "profile", "payments"]
+        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 ListSubscriptionResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a subscription object. Will always contain the string `subscription` for this
+    endpoint.
+    """
+    id: str
+    r"""The identifier uniquely referring to this subscription. Example: `sub_rVKGtNd6s3`."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    status: ListSubscriptionResponseStatus
+    amount: AmountTypedDict
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+    times: Nullable[int]
+    r"""Total number of payments for the subscription. Once this number of payments is reached, the subscription is
+    considered completed.
+
+    Test mode subscriptions will get canceled automatically after 10 payments.
+    """
+    times_remaining: Nullable[int]
+    r"""Number of payments left for the subscription."""
+    interval: str
+    r"""Interval to wait between payments, for example `1 month` or `14 days`.
+
+    The maximum interval is one year (`12 months`, `52 weeks`, or `365 days`).
+
+    Possible values: `... days`, `... weeks`, `... months`.
+    """
+    start_date: str
+    r"""The start date of the subscription in `YYYY-MM-DD` format."""
+    description: str
+    r"""The subscription's description will be used as the description of the resulting individual payments and so showing
+    up on the bank statement of the consumer.
+
+    **Please note:** the description needs to be unique for the Customer in case it has multiple active subscriptions.
+    """
+    method: Nullable[SubscriptionMethodResponse]
+    r"""The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used."""
+    metadata: 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.
+    """
+    webhook_url: Nullable[str]
+    r"""We will call this URL for any payment status changes of payments resulting from this subscription.
+
+    This webhook will receive **all** events for the subscription's payments. This may include payment failures as
+    well. Be sure to verify the payment's subscription ID and its status.
+    """
+    customer_id: str
+    r"""The customer this subscription belongs to."""
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    links: ListSubscriptionResponseLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+    next_payment_date: NotRequired[Nullable[str]]
+    r"""The date of the next scheduled payment in `YYYY-MM-DD` format. If the subscription has been completed or canceled,
+    this parameter will not be returned.
+    """
+    application_fee: NotRequired[ListSubscriptionResponseApplicationFeeTypedDict]
+    r"""With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+    merchants.
+
+    Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
+
+    Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
+    information.
+    """
+    mandate_id: NotRequired[str]
+    canceled_at: NotRequired[Nullable[str]]
+    r"""The subscription's date and time of cancellation, in ISO 8601 format. This parameter is omitted if the
+    subscription is not canceled (yet).
+    """
+
+
+class ListSubscriptionResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a subscription object. Will always contain the string `subscription` for this
+    endpoint.
+    """
+
+    id: str
+    r"""The identifier uniquely referring to this subscription. Example: `sub_rVKGtNd6s3`."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    status: Annotated[
+        ListSubscriptionResponseStatus, PlainValidator(validate_open_enum(False))
+    ]
+
+    amount: Amount
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    times: Nullable[int]
+    r"""Total number of payments for the subscription. Once this number of payments is reached, the subscription is
+    considered completed.
+
+    Test mode subscriptions will get canceled automatically after 10 payments.
+    """
+
+    times_remaining: Annotated[Nullable[int], pydantic.Field(alias="timesRemaining")]
+    r"""Number of payments left for the subscription."""
+
+    interval: str
+    r"""Interval to wait between payments, for example `1 month` or `14 days`.
+
+    The maximum interval is one year (`12 months`, `52 weeks`, or `365 days`).
+
+    Possible values: `... days`, `... weeks`, `... months`.
+    """
+
+    start_date: Annotated[str, pydantic.Field(alias="startDate")]
+    r"""The start date of the subscription in `YYYY-MM-DD` format."""
+
+    description: str
+    r"""The subscription's description will be used as the description of the resulting individual payments and so showing
+    up on the bank statement of the consumer.
+
+    **Please note:** the description needs to be unique for the Customer in case it has multiple active subscriptions.
+    """
+
+    method: Annotated[
+        Nullable[SubscriptionMethodResponse], PlainValidator(validate_open_enum(False))
+    ]
+    r"""The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used."""
+
+    metadata: Nullable[Metadata]
+    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.
+    """
+
+    webhook_url: Annotated[Nullable[str], pydantic.Field(alias="webhookUrl")]
+    r"""We will call this URL for any payment status changes of payments resulting from this subscription.
+
+    This webhook will receive **all** events for the subscription's payments. This may include payment failures as
+    well. Be sure to verify the payment's subscription ID and its status.
+    """
+
+    customer_id: Annotated[str, pydantic.Field(alias="customerId")]
+    r"""The customer this subscription belongs to."""
+
+    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."""
+
+    links: Annotated[ListSubscriptionResponseLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    next_payment_date: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="nextPaymentDate")
+    ] = UNSET
+    r"""The date of the next scheduled payment in `YYYY-MM-DD` format. If the subscription has been completed or canceled,
+    this parameter will not be returned.
+    """
+
+    application_fee: Annotated[
+        Optional[ListSubscriptionResponseApplicationFee],
+        pydantic.Field(alias="applicationFee"),
+    ] = None
+    r"""With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+    merchants.
+
+    Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
+
+    Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
+    information.
+    """
+
+    mandate_id: Annotated[Optional[str], pydantic.Field(alias="mandateId")] = None
+
+    canceled_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="canceledAt")
+    ] = UNSET
+    r"""The subscription's date and time of cancellation, in ISO 8601 format. This parameter is omitted if the
+    subscription is not canceled (yet).
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "nextPaymentDate",
+            "applicationFee",
+            "mandateId",
+            "canceledAt",
+        ]
+        nullable_fields = [
+            "times",
+            "timesRemaining",
+            "nextPaymentDate",
+            "method",
+            "metadata",
+            "webhookUrl",
+            "canceledAt",
+        ]
+        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/list_subscriptionsop.py

@@ -0,0 +1,189 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .list_links import ListLinks, ListLinksTypedDict
+from .list_subscription_response import (
+    ListSubscriptionResponse,
+    ListSubscriptionResponseTypedDict,
+)
+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 ListSubscriptionsGlobalsTypedDict(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 ListSubscriptionsGlobals(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 ListSubscriptionsRequestTypedDict(TypedDict):
+    customer_id: str
+    r"""Provide the ID of the related customer."""
+    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 ListSubscriptionsRequest(BaseModel):
+    customer_id: Annotated[
+        str,
+        pydantic.Field(alias="customerId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related customer."""
+
+    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 ListSubscriptionsEmbeddedTypedDict(TypedDict):
+    subscriptions: NotRequired[List[ListSubscriptionResponseTypedDict]]
+    r"""An array of subscription objects."""
+
+
+class ListSubscriptionsEmbedded(BaseModel):
+    subscriptions: Optional[List[ListSubscriptionResponse]] = None
+    r"""An array of subscription objects."""
+
+
+class ListSubscriptionsResponseTypedDict(TypedDict):
+    r"""A list of subscription 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: ListSubscriptionsEmbeddedTypedDict
+    links: ListLinksTypedDict
+    r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
+
+
+class ListSubscriptionsResponse(BaseModel):
+    r"""A list of subscription 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[ListSubscriptionsEmbedded, 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."""