mollie-api-py 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mollie/__init__.py +18 -0
- mollie/_hooks/__init__.py +5 -0
- mollie/_hooks/mollie_hooks.py +165 -0
- mollie/_hooks/registration.py +18 -0
- mollie/_hooks/sdkhooks.py +76 -0
- mollie/_hooks/types.py +113 -0
- mollie/_version.py +15 -0
- mollie/balance_transfers.py +651 -0
- mollie/balances.py +1105 -0
- mollie/basesdk.py +360 -0
- mollie/capabilities.py +209 -0
- mollie/captures.py +677 -0
- mollie/chargebacks_sdk.py +675 -0
- mollie/client_links.py +325 -0
- mollie/clients.py +409 -0
- mollie/customers.py +1563 -0
- mollie/delayed_routing.py +421 -0
- mollie/httpclient.py +125 -0
- mollie/invoices.py +429 -0
- mollie/mandates.py +895 -0
- mollie/methods.py +789 -0
- mollie/models/__init__.py +4002 -0
- mollie/models/address.py +29 -0
- mollie/models/amount.py +25 -0
- mollie/models/amount_nullable.py +24 -0
- mollie/models/apierror.py +40 -0
- mollie/models/balance_card_audience.py +10 -0
- mollie/models/balance_card_issuer.py +12 -0
- mollie/models/balance_card_region.py +12 -0
- mollie/models/balance_fee_type.py +43 -0
- mollie/models/balance_prepayment_part_type.py +13 -0
- mollie/models/balance_report_grouping.py +10 -0
- mollie/models/balance_transaction_type.py +47 -0
- mollie/models/balance_transfer_category.py +17 -0
- mollie/models/balance_transfer_category_response.py +18 -0
- mollie/models/balance_transfer_destination_type.py +14 -0
- mollie/models/balance_transfer_party_type.py +10 -0
- mollie/models/balance_transfer_party_type_response.py +11 -0
- mollie/models/balance_transfer_status.py +13 -0
- mollie/models/balance_transfer_status_reason_response.py +19 -0
- mollie/models/billingaddress.py +154 -0
- mollie/models/cancel_paymentop.py +93 -0
- mollie/models/cancel_refundop.py +86 -0
- mollie/models/cancel_subscriptionop.py +100 -0
- mollie/models/capability_requirement_status.py +15 -0
- mollie/models/capability_status.py +12 -0
- mollie/models/capability_status_reason.py +10 -0
- mollie/models/capture_mode.py +15 -0
- mollie/models/capture_mode_response.py +16 -0
- mollie/models/capture_response.py +265 -0
- mollie/models/client_link_request.py +210 -0
- mollie/models/client_link_response.py +56 -0
- mollie/models/clienterror.py +30 -0
- mollie/models/components_sub_totals.py +127 -0
- mollie/models/create_captureop.py +43 -0
- mollie/models/create_client_linkop.py +29 -0
- mollie/models/create_connect_balance_transferop.py +32 -0
- mollie/models/create_customer_paymentop.py +43 -0
- mollie/models/create_customerop.py +29 -0
- mollie/models/create_mandateop.py +43 -0
- mollie/models/create_payment_linkop.py +325 -0
- mollie/models/create_paymentop.py +73 -0
- mollie/models/create_profileop.py +29 -0
- mollie/models/create_refundop.py +43 -0
- mollie/models/create_sales_invoiceop.py +29 -0
- mollie/models/create_subscriptionop.py +43 -0
- mollie/models/create_webhook.py +123 -0
- mollie/models/create_webhookop.py +69 -0
- mollie/models/currencies.py +20 -0
- mollie/models/customer_response.py +169 -0
- mollie/models/delete_customerop.py +91 -0
- mollie/models/delete_payment_linkop.py +91 -0
- mollie/models/delete_profileop.py +29 -0
- mollie/models/delete_sales_invoiceop.py +44 -0
- mollie/models/delete_values_sales_invoice.py +54 -0
- mollie/models/delete_webhookop.py +56 -0
- mollie/models/entity_balance.py +325 -0
- mollie/models/entity_balance_report.py +541 -0
- mollie/models/entity_balance_transaction.py +1068 -0
- mollie/models/entity_balance_transfer.py +62 -0
- mollie/models/entity_balance_transfer_party.py +28 -0
- mollie/models/entity_balance_transfer_party_response.py +32 -0
- mollie/models/entity_balance_transfer_response.py +159 -0
- mollie/models/entity_capability.py +75 -0
- mollie/models/entity_capability_requirement.py +87 -0
- mollie/models/entity_capture.py +63 -0
- mollie/models/entity_chargeback.py +247 -0
- mollie/models/entity_customer.py +86 -0
- mollie/models/entity_event.py +46 -0
- mollie/models/entity_invoice.py +247 -0
- mollie/models/entity_method_get.py +329 -0
- mollie/models/entity_onboarding_status.py +95 -0
- mollie/models/entity_organization.py +178 -0
- mollie/models/entity_payment_route.py +111 -0
- mollie/models/entity_payment_route_response.py +140 -0
- mollie/models/entity_permission.py +61 -0
- mollie/models/entity_refund_response.py +361 -0
- mollie/models/entity_route.py +96 -0
- mollie/models/entity_settlement.py +467 -0
- mollie/models/entity_terminal.py +160 -0
- mollie/models/entity_webhook.py +122 -0
- mollie/models/entity_webhook_event.py +149 -0
- mollie/models/error_response.py +70 -0
- mollie/models/get_balance_reportop.py +126 -0
- mollie/models/get_balanceop.py +71 -0
- mollie/models/get_captureop.py +129 -0
- mollie/models/get_chargebackop.py +129 -0
- mollie/models/get_clientop.py +216 -0
- mollie/models/get_connect_balance_transferop.py +71 -0
- mollie/models/get_current_organizationop.py +22 -0
- mollie/models/get_current_profileop.py +22 -0
- mollie/models/get_customerop.py +286 -0
- mollie/models/get_invoiceop.py +29 -0
- mollie/models/get_mandateop.py +86 -0
- mollie/models/get_methodop.py +199 -0
- mollie/models/get_next_settlementop.py +22 -0
- mollie/models/get_onboarding_statusop.py +22 -0
- mollie/models/get_open_settlementop.py +22 -0
- mollie/models/get_organizationop.py +71 -0
- mollie/models/get_partner_statusop.py +231 -0
- mollie/models/get_payment_link_paymentsop.py +188 -0
- mollie/models/get_payment_linkop.py +77 -0
- mollie/models/get_paymentop.py +128 -0
- mollie/models/get_permissionop.py +73 -0
- mollie/models/get_primary_balanceop.py +22 -0
- mollie/models/get_profileop.py +71 -0
- mollie/models/get_refundop.py +129 -0
- mollie/models/get_sales_invoiceop.py +75 -0
- mollie/models/get_settlementop.py +29 -0
- mollie/models/get_subscriptionop.py +86 -0
- mollie/models/get_terminalop.py +77 -0
- mollie/models/get_webhook_eventop.py +71 -0
- mollie/models/get_webhookop.py +71 -0
- mollie/models/internal/__init__.py +54 -0
- mollie/models/internal/globals.py +59 -0
- mollie/models/line_categories.py +13 -0
- mollie/models/line_categories_response.py +14 -0
- mollie/models/list_all_chargebacksop.py +236 -0
- mollie/models/list_all_methodsop.py +249 -0
- mollie/models/list_all_refundsop.py +230 -0
- mollie/models/list_all_subscriptionsop.py +202 -0
- mollie/models/list_balance_transactionsop.py +174 -0
- mollie/models/list_balancesop.py +171 -0
- mollie/models/list_capabilitiesop.py +62 -0
- mollie/models/list_capture_response.py +264 -0
- mollie/models/list_capturesop.py +185 -0
- mollie/models/list_chargebacksop.py +185 -0
- mollie/models/list_clientsop.py +269 -0
- mollie/models/list_connect_balance_transfersop.py +177 -0
- mollie/models/list_customer_paymentsop.py +231 -0
- mollie/models/list_customer_response.py +164 -0
- mollie/models/list_customersop.py +172 -0
- mollie/models/list_entity_balance.py +322 -0
- mollie/models/list_entity_chargeback.py +244 -0
- mollie/models/list_entity_invoice.py +244 -0
- mollie/models/list_entity_method.py +315 -0
- mollie/models/list_entity_method_all.py +391 -0
- mollie/models/list_entity_permission.py +56 -0
- mollie/models/list_entity_refund.py +352 -0
- mollie/models/list_entity_settlement.py +457 -0
- mollie/models/list_entity_terminal.py +157 -0
- mollie/models/list_entity_webhook.py +117 -0
- mollie/models/list_invoicesop.py +175 -0
- mollie/models/list_links.py +68 -0
- mollie/models/list_mandate_response.py +261 -0
- mollie/models/list_mandatesop.py +186 -0
- mollie/models/list_methodsop.py +332 -0
- mollie/models/list_payment_linksop.py +159 -0
- mollie/models/list_payment_response.py +1953 -0
- mollie/models/list_paymentsop.py +217 -0
- mollie/models/list_permissionsop.py +85 -0
- mollie/models/list_profile_response.py +194 -0
- mollie/models/list_profilesop.py +118 -0
- mollie/models/list_refundsop.py +189 -0
- mollie/models/list_route_get_response.py +97 -0
- mollie/models/list_sales_invoice_response.py +505 -0
- mollie/models/list_sales_invoicesop.py +172 -0
- mollie/models/list_settlement_capturesop.py +187 -0
- mollie/models/list_settlement_chargebacksop.py +187 -0
- mollie/models/list_settlement_paymentsop.py +233 -0
- mollie/models/list_settlement_refundsop.py +191 -0
- mollie/models/list_settlementsop.py +178 -0
- mollie/models/list_subscription_paymentsop.py +242 -0
- mollie/models/list_subscription_response.py +344 -0
- mollie/models/list_subscriptionsop.py +189 -0
- mollie/models/list_terminalsop.py +172 -0
- mollie/models/list_webhooksop.py +189 -0
- mollie/models/locale.py +32 -0
- mollie/models/locale_response.py +33 -0
- mollie/models/mandate_details_card_label_response.py +22 -0
- mollie/models/mandate_method.py +15 -0
- mollie/models/mandate_method_response.py +16 -0
- mollie/models/mandate_request.py +160 -0
- mollie/models/mandate_response.py +264 -0
- mollie/models/metadata.py +19 -0
- mollie/models/method.py +50 -0
- mollie/models/method_include_wallets_parameter.py +8 -0
- mollie/models/method_resource_parameter.py +9 -0
- mollie/models/method_response.py +59 -0
- mollie/models/method_status.py +15 -0
- mollie/models/mode.py +12 -0
- mollie/models/no_response_error.py +17 -0
- mollie/models/onboarding_vat_regulation.py +16 -0
- mollie/models/organization_vat_regulation.py +17 -0
- mollie/models/payment_address.py +130 -0
- mollie/models/payment_create_routeop.py +43 -0
- mollie/models/payment_details_card_audition_response.py +12 -0
- mollie/models/payment_details_card_funding_response.py +14 -0
- mollie/models/payment_details_card_label_response.py +23 -0
- mollie/models/payment_details_card_security_response.py +12 -0
- mollie/models/payment_details_failure_reason_response.py +25 -0
- mollie/models/payment_details_fee_region_response.py +20 -0
- mollie/models/payment_details_receipt_card_read_method_response.py +17 -0
- mollie/models/payment_details_receipt_card_verification_method_response.py +21 -0
- mollie/models/payment_details_seller_protection_response.py +20 -0
- mollie/models/payment_details_wallet_response.py +11 -0
- mollie/models/payment_line_item.py +96 -0
- mollie/models/payment_line_item_response.py +104 -0
- mollie/models/payment_line_type.py +20 -0
- mollie/models/payment_line_type_response.py +21 -0
- mollie/models/payment_link_method.py +36 -0
- mollie/models/payment_link_method_response.py +37 -0
- mollie/models/payment_link_response.py +348 -0
- mollie/models/payment_link_sequence_type.py +9 -0
- mollie/models/payment_link_sequence_type_response.py +10 -0
- mollie/models/payment_list_routesop.py +140 -0
- mollie/models/payment_method.py +53 -0
- mollie/models/payment_request.py +919 -0
- mollie/models/payment_response.py +1953 -0
- mollie/models/profile_request.py +67 -0
- mollie/models/profile_response.py +197 -0
- mollie/models/profile_review_status_response.py +12 -0
- mollie/models/recurring_line_item.py +77 -0
- mollie/models/refund_external_reference_type.py +10 -0
- mollie/models/refund_external_reference_type_response.py +11 -0
- mollie/models/refund_request.py +200 -0
- mollie/models/release_authorizationop.py +108 -0
- mollie/models/request_apple_pay_payment_sessionop.py +76 -0
- mollie/models/responsevalidationerror.py +27 -0
- mollie/models/revoke_mandateop.py +100 -0
- mollie/models/route_create_response.py +97 -0
- mollie/models/route_destination_type.py +10 -0
- mollie/models/route_destination_type_response.py +11 -0
- mollie/models/sales_invoice_discount.py +21 -0
- mollie/models/sales_invoice_discount_response.py +25 -0
- mollie/models/sales_invoice_discount_type.py +11 -0
- mollie/models/sales_invoice_discount_type_response.py +12 -0
- mollie/models/sales_invoice_email_details.py +20 -0
- mollie/models/sales_invoice_line_item.py +67 -0
- mollie/models/sales_invoice_line_item_response.py +70 -0
- mollie/models/sales_invoice_payment_details.py +59 -0
- mollie/models/sales_invoice_payment_details_response.py +66 -0
- mollie/models/sales_invoice_payment_details_source.py +12 -0
- mollie/models/sales_invoice_payment_details_source_response.py +13 -0
- mollie/models/sales_invoice_payment_term.py +16 -0
- mollie/models/sales_invoice_payment_term_response.py +17 -0
- mollie/models/sales_invoice_recipient.py +176 -0
- mollie/models/sales_invoice_recipient_locale.py +18 -0
- mollie/models/sales_invoice_recipient_locale_response.py +19 -0
- mollie/models/sales_invoice_recipient_response.py +182 -0
- mollie/models/sales_invoice_recipient_type.py +13 -0
- mollie/models/sales_invoice_recipient_type_response.py +14 -0
- mollie/models/sales_invoice_request.py +256 -0
- mollie/models/sales_invoice_response.py +509 -0
- mollie/models/sales_invoice_status.py +25 -0
- mollie/models/sales_invoice_status_response.py +26 -0
- mollie/models/sales_invoice_vat_mode.py +13 -0
- mollie/models/sales_invoice_vat_mode_response.py +14 -0
- mollie/models/sales_invoice_vat_scheme.py +11 -0
- mollie/models/sales_invoice_vat_scheme_response.py +12 -0
- mollie/models/security.py +35 -0
- mollie/models/sequence_type.py +10 -0
- mollie/models/sequence_type_response.py +11 -0
- mollie/models/sorting.py +9 -0
- mollie/models/status_reason.py +168 -0
- mollie/models/sub_group.py +52 -0
- mollie/models/sub_totals.py +120 -0
- mollie/models/submit_onboarding_dataop.py +214 -0
- mollie/models/subscription_method.py +12 -0
- mollie/models/subscription_method_response.py +13 -0
- mollie/models/subscription_request.py +213 -0
- mollie/models/subscription_response.py +349 -0
- mollie/models/terminal_brand.py +12 -0
- mollie/models/terminal_model.py +16 -0
- mollie/models/test_webhookop.py +64 -0
- mollie/models/update_customerop.py +43 -0
- mollie/models/update_payment_linkop.py +172 -0
- mollie/models/update_paymentop.py +332 -0
- mollie/models/update_profileop.py +147 -0
- mollie/models/update_sales_invoiceop.py +44 -0
- mollie/models/update_subscriptionop.py +188 -0
- mollie/models/update_values_sales_invoice.py +176 -0
- mollie/models/update_webhookop.py +83 -0
- mollie/models/url.py +24 -0
- mollie/models/url_nullable.py +25 -0
- mollie/models/webhook_event_types.py +18 -0
- mollie/models/webhook_status.py +14 -0
- mollie/onboarding.py +403 -0
- mollie/organizations.py +579 -0
- mollie/payment_links.py +1323 -0
- mollie/payments_sdk.py +1385 -0
- mollie/permissions.py +397 -0
- mollie/profiles.py +1209 -0
- mollie/py.typed +1 -0
- mollie/refunds_sdk.py +1111 -0
- mollie/sales_invoices.py +1121 -0
- mollie/sdk.py +265 -0
- mollie/sdkconfiguration.py +50 -0
- mollie/settlements.py +1735 -0
- mollie/subscriptions.py +1617 -0
- mollie/terminals.py +427 -0
- mollie/types/__init__.py +21 -0
- mollie/types/basemodel.py +39 -0
- mollie/utils/__init__.py +200 -0
- mollie/utils/annotations.py +79 -0
- mollie/utils/datetimes.py +23 -0
- mollie/utils/enums.py +74 -0
- mollie/utils/eventstreaming.py +248 -0
- mollie/utils/forms.py +223 -0
- mollie/utils/headers.py +136 -0
- mollie/utils/logger.py +27 -0
- mollie/utils/metadata.py +118 -0
- mollie/utils/queryparams.py +205 -0
- mollie/utils/requestbodies.py +66 -0
- mollie/utils/retries.py +217 -0
- mollie/utils/security.py +195 -0
- mollie/utils/serializers.py +249 -0
- mollie/utils/unmarshal_json_response.py +24 -0
- mollie/utils/url.py +155 -0
- mollie/utils/values.py +137 -0
- mollie/wallets.py +263 -0
- mollie/webhook_events.py +211 -0
- mollie/webhooks.py +1305 -0
- mollie_api_py-1.0.0.dist-info/METADATA +834 -0
- mollie_api_py-1.0.0.dist-info/RECORD +337 -0
- mollie_api_py-1.0.0.dist-info/WHEEL +4 -0
- mollie_api_py-1.0.0.dist-info/licenses/LICENSE.md +24 -0
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
from .amount import Amount, AmountTypedDict
|
|
5
|
+
from .list_entity_method_all import ListEntityMethodAll, ListEntityMethodAllTypedDict
|
|
6
|
+
from .locale import Locale
|
|
7
|
+
from .sequence_type import SequenceType
|
|
8
|
+
from .url import URL, URLTypedDict
|
|
9
|
+
from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
|
|
10
|
+
from mollie.utils import FieldMetadata, HeaderMetadata, QueryParamMetadata
|
|
11
|
+
import pydantic
|
|
12
|
+
from pydantic import model_serializer
|
|
13
|
+
from typing import List, Optional
|
|
14
|
+
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class ListAllMethodsGlobalsTypedDict(TypedDict):
|
|
18
|
+
profile_id: NotRequired[str]
|
|
19
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
20
|
+
retrieve the resources for.
|
|
21
|
+
|
|
22
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
23
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
24
|
+
"""
|
|
25
|
+
testmode: NotRequired[bool]
|
|
26
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
27
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
28
|
+
setting the `testmode` query parameter to `true`.
|
|
29
|
+
|
|
30
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class ListAllMethodsGlobals(BaseModel):
|
|
35
|
+
profile_id: Annotated[
|
|
36
|
+
Optional[str],
|
|
37
|
+
pydantic.Field(alias="profileId"),
|
|
38
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
39
|
+
] = None
|
|
40
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
41
|
+
retrieve the resources for.
|
|
42
|
+
|
|
43
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
44
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
45
|
+
"""
|
|
46
|
+
|
|
47
|
+
testmode: Annotated[
|
|
48
|
+
Optional[bool],
|
|
49
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
50
|
+
] = None
|
|
51
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
52
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
53
|
+
setting the `testmode` query parameter to `true`.
|
|
54
|
+
|
|
55
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
56
|
+
"""
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
class ListAllMethodsRequestTypedDict(TypedDict):
|
|
60
|
+
locale: NotRequired[Nullable[Locale]]
|
|
61
|
+
r"""Response language"""
|
|
62
|
+
amount: NotRequired[AmountTypedDict]
|
|
63
|
+
r"""If supplied, only payment methods that support the amount and currency
|
|
64
|
+
are returned.
|
|
65
|
+
|
|
66
|
+
Example: `/v2/methods/all?amount[value]=100.00&amount[currency]=USD`
|
|
67
|
+
"""
|
|
68
|
+
include: NotRequired[Nullable[str]]
|
|
69
|
+
r"""This endpoint allows you to include additional information via the `include` query string parameter."""
|
|
70
|
+
sequence_type: NotRequired[SequenceType]
|
|
71
|
+
r"""Set this parameter to `first` to only return the methods that
|
|
72
|
+
can be used for the first payment of a recurring sequence.
|
|
73
|
+
|
|
74
|
+
Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
|
|
75
|
+
"""
|
|
76
|
+
profile_id: NotRequired[str]
|
|
77
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
78
|
+
retrieve the resources for.
|
|
79
|
+
|
|
80
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
81
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
82
|
+
"""
|
|
83
|
+
testmode: NotRequired[bool]
|
|
84
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
85
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
86
|
+
setting the `testmode` query parameter to `true`.
|
|
87
|
+
|
|
88
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
89
|
+
"""
|
|
90
|
+
idempotency_key: NotRequired[str]
|
|
91
|
+
r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
class ListAllMethodsRequest(BaseModel):
|
|
95
|
+
locale: Annotated[
|
|
96
|
+
OptionalNullable[Locale],
|
|
97
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
98
|
+
] = UNSET
|
|
99
|
+
r"""Response language"""
|
|
100
|
+
|
|
101
|
+
amount: Annotated[
|
|
102
|
+
Optional[Amount],
|
|
103
|
+
FieldMetadata(query=QueryParamMetadata(style="deepObject", explode=True)),
|
|
104
|
+
] = None
|
|
105
|
+
r"""If supplied, only payment methods that support the amount and currency
|
|
106
|
+
are returned.
|
|
107
|
+
|
|
108
|
+
Example: `/v2/methods/all?amount[value]=100.00&amount[currency]=USD`
|
|
109
|
+
"""
|
|
110
|
+
|
|
111
|
+
include: Annotated[
|
|
112
|
+
OptionalNullable[str],
|
|
113
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
114
|
+
] = UNSET
|
|
115
|
+
r"""This endpoint allows you to include additional information via the `include` query string parameter."""
|
|
116
|
+
|
|
117
|
+
sequence_type: Annotated[
|
|
118
|
+
Optional[SequenceType],
|
|
119
|
+
pydantic.Field(alias="sequenceType"),
|
|
120
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
121
|
+
] = None
|
|
122
|
+
r"""Set this parameter to `first` to only return the methods that
|
|
123
|
+
can be used for the first payment of a recurring sequence.
|
|
124
|
+
|
|
125
|
+
Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
|
|
126
|
+
"""
|
|
127
|
+
|
|
128
|
+
profile_id: Annotated[
|
|
129
|
+
Optional[str],
|
|
130
|
+
pydantic.Field(alias="profileId"),
|
|
131
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
132
|
+
] = None
|
|
133
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
134
|
+
retrieve the resources for.
|
|
135
|
+
|
|
136
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
137
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
138
|
+
"""
|
|
139
|
+
|
|
140
|
+
testmode: Annotated[
|
|
141
|
+
Optional[bool],
|
|
142
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
143
|
+
] = None
|
|
144
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
145
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
146
|
+
setting the `testmode` query parameter to `true`.
|
|
147
|
+
|
|
148
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
149
|
+
"""
|
|
150
|
+
|
|
151
|
+
idempotency_key: Annotated[
|
|
152
|
+
Optional[str],
|
|
153
|
+
pydantic.Field(alias="idempotency-key"),
|
|
154
|
+
FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
|
|
155
|
+
] = None
|
|
156
|
+
r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
|
|
157
|
+
|
|
158
|
+
@model_serializer(mode="wrap")
|
|
159
|
+
def serialize_model(self, handler):
|
|
160
|
+
optional_fields = [
|
|
161
|
+
"locale",
|
|
162
|
+
"amount",
|
|
163
|
+
"include",
|
|
164
|
+
"sequenceType",
|
|
165
|
+
"profileId",
|
|
166
|
+
"testmode",
|
|
167
|
+
"idempotency-key",
|
|
168
|
+
]
|
|
169
|
+
nullable_fields = ["locale", "include"]
|
|
170
|
+
null_default_fields = []
|
|
171
|
+
|
|
172
|
+
serialized = handler(self)
|
|
173
|
+
|
|
174
|
+
m = {}
|
|
175
|
+
|
|
176
|
+
for n, f in type(self).model_fields.items():
|
|
177
|
+
k = f.alias or n
|
|
178
|
+
val = serialized.get(k)
|
|
179
|
+
serialized.pop(k, None)
|
|
180
|
+
|
|
181
|
+
optional_nullable = k in optional_fields and k in nullable_fields
|
|
182
|
+
is_set = (
|
|
183
|
+
self.__pydantic_fields_set__.intersection({n})
|
|
184
|
+
or k in null_default_fields
|
|
185
|
+
) # pylint: disable=no-member
|
|
186
|
+
|
|
187
|
+
if val is not None and val != UNSET_SENTINEL:
|
|
188
|
+
m[k] = val
|
|
189
|
+
elif val != UNSET_SENTINEL and (
|
|
190
|
+
not k in optional_fields or (optional_nullable and is_set)
|
|
191
|
+
):
|
|
192
|
+
m[k] = val
|
|
193
|
+
|
|
194
|
+
return m
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
class ListAllMethodsEmbeddedTypedDict(TypedDict):
|
|
198
|
+
methods: List[ListEntityMethodAllTypedDict]
|
|
199
|
+
r"""An array of payment method objects. For a complete
|
|
200
|
+
reference of the payment method object, refer to the [Get payment method endpoint](get-method)
|
|
201
|
+
documentation.
|
|
202
|
+
"""
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
class ListAllMethodsEmbedded(BaseModel):
|
|
206
|
+
methods: List[ListEntityMethodAll]
|
|
207
|
+
r"""An array of payment method objects. For a complete
|
|
208
|
+
reference of the payment method object, refer to the [Get payment method endpoint](get-method)
|
|
209
|
+
documentation.
|
|
210
|
+
"""
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
class ListAllMethodsLinksTypedDict(TypedDict):
|
|
214
|
+
self_: URLTypedDict
|
|
215
|
+
r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
|
|
216
|
+
documentation: URLTypedDict
|
|
217
|
+
r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
class ListAllMethodsLinks(BaseModel):
|
|
221
|
+
self_: Annotated[URL, pydantic.Field(alias="self")]
|
|
222
|
+
r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
|
|
223
|
+
|
|
224
|
+
documentation: URL
|
|
225
|
+
r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
class ListAllMethodsResponseTypedDict(TypedDict):
|
|
229
|
+
r"""A list of payment method objects. For a complete reference of the
|
|
230
|
+
payment method object, refer to the [Get payment method endpoint](get-method) documentation.
|
|
231
|
+
"""
|
|
232
|
+
|
|
233
|
+
count: int
|
|
234
|
+
r"""The number of payment method objects in this result set. Results are **not** paginated."""
|
|
235
|
+
embedded: ListAllMethodsEmbeddedTypedDict
|
|
236
|
+
links: ListAllMethodsLinksTypedDict
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
class ListAllMethodsResponse(BaseModel):
|
|
240
|
+
r"""A list of payment method objects. For a complete reference of the
|
|
241
|
+
payment method object, refer to the [Get payment method endpoint](get-method) documentation.
|
|
242
|
+
"""
|
|
243
|
+
|
|
244
|
+
count: int
|
|
245
|
+
r"""The number of payment method objects in this result set. Results are **not** paginated."""
|
|
246
|
+
|
|
247
|
+
embedded: Annotated[ListAllMethodsEmbedded, pydantic.Field(alias="_embedded")]
|
|
248
|
+
|
|
249
|
+
links: Annotated[ListAllMethodsLinks, pydantic.Field(alias="_links")]
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
from .list_entity_refund import ListEntityRefund, ListEntityRefundTypedDict
|
|
5
|
+
from .list_links import ListLinks, ListLinksTypedDict
|
|
6
|
+
from .sorting import Sorting
|
|
7
|
+
from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
|
|
8
|
+
from mollie.utils import FieldMetadata, HeaderMetadata, QueryParamMetadata
|
|
9
|
+
import pydantic
|
|
10
|
+
from pydantic import model_serializer
|
|
11
|
+
from typing import List, Optional
|
|
12
|
+
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class ListAllRefundsGlobalsTypedDict(TypedDict):
|
|
16
|
+
profile_id: NotRequired[str]
|
|
17
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
18
|
+
retrieve the resources for.
|
|
19
|
+
|
|
20
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
21
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
22
|
+
"""
|
|
23
|
+
testmode: NotRequired[bool]
|
|
24
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
25
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
26
|
+
setting the `testmode` query parameter to `true`.
|
|
27
|
+
|
|
28
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
29
|
+
"""
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
class ListAllRefundsGlobals(BaseModel):
|
|
33
|
+
profile_id: Annotated[
|
|
34
|
+
Optional[str],
|
|
35
|
+
pydantic.Field(alias="profileId"),
|
|
36
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
37
|
+
] = None
|
|
38
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
39
|
+
retrieve the resources for.
|
|
40
|
+
|
|
41
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
42
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
43
|
+
"""
|
|
44
|
+
|
|
45
|
+
testmode: Annotated[
|
|
46
|
+
Optional[bool],
|
|
47
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
48
|
+
] = None
|
|
49
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
50
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
51
|
+
setting the `testmode` query parameter to `true`.
|
|
52
|
+
|
|
53
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
54
|
+
"""
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
class ListAllRefundsRequestTypedDict(TypedDict):
|
|
58
|
+
from_: NotRequired[str]
|
|
59
|
+
r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
|
|
60
|
+
result set.
|
|
61
|
+
"""
|
|
62
|
+
limit: NotRequired[Nullable[int]]
|
|
63
|
+
r"""The maximum number of items to return. Defaults to 50 items."""
|
|
64
|
+
sort: NotRequired[Sorting]
|
|
65
|
+
r"""Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
|
|
66
|
+
newest to oldest.
|
|
67
|
+
"""
|
|
68
|
+
embed: NotRequired[Nullable[str]]
|
|
69
|
+
r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
|
|
70
|
+
parameter.
|
|
71
|
+
"""
|
|
72
|
+
profile_id: NotRequired[str]
|
|
73
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
74
|
+
retrieve the resources for.
|
|
75
|
+
|
|
76
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
77
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
78
|
+
"""
|
|
79
|
+
testmode: NotRequired[bool]
|
|
80
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
81
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
82
|
+
setting the `testmode` query parameter to `true`.
|
|
83
|
+
|
|
84
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
85
|
+
"""
|
|
86
|
+
idempotency_key: NotRequired[str]
|
|
87
|
+
r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
class ListAllRefundsRequest(BaseModel):
|
|
91
|
+
from_: Annotated[
|
|
92
|
+
Optional[str],
|
|
93
|
+
pydantic.Field(alias="from"),
|
|
94
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
95
|
+
] = None
|
|
96
|
+
r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
|
|
97
|
+
result set.
|
|
98
|
+
"""
|
|
99
|
+
|
|
100
|
+
limit: Annotated[
|
|
101
|
+
OptionalNullable[int],
|
|
102
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
103
|
+
] = UNSET
|
|
104
|
+
r"""The maximum number of items to return. Defaults to 50 items."""
|
|
105
|
+
|
|
106
|
+
sort: Annotated[
|
|
107
|
+
Optional[Sorting],
|
|
108
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
109
|
+
] = None
|
|
110
|
+
r"""Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
|
|
111
|
+
newest to oldest.
|
|
112
|
+
"""
|
|
113
|
+
|
|
114
|
+
embed: Annotated[
|
|
115
|
+
OptionalNullable[str],
|
|
116
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
117
|
+
] = UNSET
|
|
118
|
+
r"""This endpoint allows embedding related API items by appending the following values via the `embed` query string
|
|
119
|
+
parameter.
|
|
120
|
+
"""
|
|
121
|
+
|
|
122
|
+
profile_id: Annotated[
|
|
123
|
+
Optional[str],
|
|
124
|
+
pydantic.Field(alias="profileId"),
|
|
125
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
126
|
+
] = None
|
|
127
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
128
|
+
retrieve the resources for.
|
|
129
|
+
|
|
130
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
131
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
132
|
+
"""
|
|
133
|
+
|
|
134
|
+
testmode: Annotated[
|
|
135
|
+
Optional[bool],
|
|
136
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
137
|
+
] = None
|
|
138
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
139
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
140
|
+
setting the `testmode` query parameter to `true`.
|
|
141
|
+
|
|
142
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
143
|
+
"""
|
|
144
|
+
|
|
145
|
+
idempotency_key: Annotated[
|
|
146
|
+
Optional[str],
|
|
147
|
+
pydantic.Field(alias="idempotency-key"),
|
|
148
|
+
FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
|
|
149
|
+
] = None
|
|
150
|
+
r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
|
|
151
|
+
|
|
152
|
+
@model_serializer(mode="wrap")
|
|
153
|
+
def serialize_model(self, handler):
|
|
154
|
+
optional_fields = [
|
|
155
|
+
"from",
|
|
156
|
+
"limit",
|
|
157
|
+
"sort",
|
|
158
|
+
"embed",
|
|
159
|
+
"profileId",
|
|
160
|
+
"testmode",
|
|
161
|
+
"idempotency-key",
|
|
162
|
+
]
|
|
163
|
+
nullable_fields = ["limit", "embed"]
|
|
164
|
+
null_default_fields = []
|
|
165
|
+
|
|
166
|
+
serialized = handler(self)
|
|
167
|
+
|
|
168
|
+
m = {}
|
|
169
|
+
|
|
170
|
+
for n, f in type(self).model_fields.items():
|
|
171
|
+
k = f.alias or n
|
|
172
|
+
val = serialized.get(k)
|
|
173
|
+
serialized.pop(k, None)
|
|
174
|
+
|
|
175
|
+
optional_nullable = k in optional_fields and k in nullable_fields
|
|
176
|
+
is_set = (
|
|
177
|
+
self.__pydantic_fields_set__.intersection({n})
|
|
178
|
+
or k in null_default_fields
|
|
179
|
+
) # pylint: disable=no-member
|
|
180
|
+
|
|
181
|
+
if val is not None and val != UNSET_SENTINEL:
|
|
182
|
+
m[k] = val
|
|
183
|
+
elif val != UNSET_SENTINEL and (
|
|
184
|
+
not k in optional_fields or (optional_nullable and is_set)
|
|
185
|
+
):
|
|
186
|
+
m[k] = val
|
|
187
|
+
|
|
188
|
+
return m
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
class ListAllRefundsEmbeddedTypedDict(TypedDict):
|
|
192
|
+
refunds: List[ListEntityRefundTypedDict]
|
|
193
|
+
r"""An array of refund objects."""
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
class ListAllRefundsEmbedded(BaseModel):
|
|
197
|
+
refunds: List[ListEntityRefund]
|
|
198
|
+
r"""An array of refund objects."""
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
class ListAllRefundsResponseTypedDict(TypedDict):
|
|
202
|
+
r"""A list of refund objects"""
|
|
203
|
+
|
|
204
|
+
count: int
|
|
205
|
+
r"""The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
|
|
206
|
+
as well.
|
|
207
|
+
|
|
208
|
+
The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
|
|
209
|
+
limit is 50 items.
|
|
210
|
+
"""
|
|
211
|
+
embedded: ListAllRefundsEmbeddedTypedDict
|
|
212
|
+
links: ListLinksTypedDict
|
|
213
|
+
r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
class ListAllRefundsResponse(BaseModel):
|
|
217
|
+
r"""A list of refund objects"""
|
|
218
|
+
|
|
219
|
+
count: int
|
|
220
|
+
r"""The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
|
|
221
|
+
as well.
|
|
222
|
+
|
|
223
|
+
The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
|
|
224
|
+
limit is 50 items.
|
|
225
|
+
"""
|
|
226
|
+
|
|
227
|
+
embedded: Annotated[ListAllRefundsEmbedded, pydantic.Field(alias="_embedded")]
|
|
228
|
+
|
|
229
|
+
links: Annotated[ListLinks, pydantic.Field(alias="_links")]
|
|
230
|
+
r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
from .list_links import ListLinks, ListLinksTypedDict
|
|
5
|
+
from .list_subscription_response import (
|
|
6
|
+
ListSubscriptionResponse,
|
|
7
|
+
ListSubscriptionResponseTypedDict,
|
|
8
|
+
)
|
|
9
|
+
from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
|
|
10
|
+
from mollie.utils import FieldMetadata, HeaderMetadata, QueryParamMetadata
|
|
11
|
+
import pydantic
|
|
12
|
+
from pydantic import model_serializer
|
|
13
|
+
from typing import List, Optional
|
|
14
|
+
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class ListAllSubscriptionsGlobalsTypedDict(TypedDict):
|
|
18
|
+
profile_id: NotRequired[str]
|
|
19
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
20
|
+
retrieve the resources for.
|
|
21
|
+
|
|
22
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
23
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
24
|
+
"""
|
|
25
|
+
testmode: NotRequired[bool]
|
|
26
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
27
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
28
|
+
setting the `testmode` query parameter to `true`.
|
|
29
|
+
|
|
30
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class ListAllSubscriptionsGlobals(BaseModel):
|
|
35
|
+
profile_id: Annotated[
|
|
36
|
+
Optional[str],
|
|
37
|
+
pydantic.Field(alias="profileId"),
|
|
38
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
39
|
+
] = None
|
|
40
|
+
r"""The identifier referring to the [profile](get-profile) you wish to
|
|
41
|
+
retrieve the resources for.
|
|
42
|
+
|
|
43
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
|
|
44
|
+
organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
45
|
+
"""
|
|
46
|
+
|
|
47
|
+
testmode: Annotated[
|
|
48
|
+
Optional[bool],
|
|
49
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
50
|
+
] = None
|
|
51
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
52
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
53
|
+
setting the `testmode` query parameter to `true`.
|
|
54
|
+
|
|
55
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
56
|
+
"""
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
class ListAllSubscriptionsRequestTypedDict(TypedDict):
|
|
60
|
+
from_: NotRequired[Nullable[str]]
|
|
61
|
+
r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
|
|
62
|
+
result set.
|
|
63
|
+
"""
|
|
64
|
+
limit: NotRequired[Nullable[int]]
|
|
65
|
+
r"""The maximum number of items to return. Defaults to 50 items."""
|
|
66
|
+
profile_id: NotRequired[Nullable[str]]
|
|
67
|
+
r"""The identifier referring to the [profile](get-profile) you wish to retrieve subscriptions for.
|
|
68
|
+
|
|
69
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` is already implied.
|
|
70
|
+
|
|
71
|
+
To retrieve all subscriptions across the organization, use an organization-level API credential and omit the
|
|
72
|
+
`profileId` parameter.
|
|
73
|
+
"""
|
|
74
|
+
testmode: NotRequired[bool]
|
|
75
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
76
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
77
|
+
setting the `testmode` query parameter to `true`.
|
|
78
|
+
|
|
79
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
80
|
+
"""
|
|
81
|
+
idempotency_key: NotRequired[str]
|
|
82
|
+
r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
class ListAllSubscriptionsRequest(BaseModel):
|
|
86
|
+
from_: Annotated[
|
|
87
|
+
OptionalNullable[str],
|
|
88
|
+
pydantic.Field(alias="from"),
|
|
89
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
90
|
+
] = UNSET
|
|
91
|
+
r"""Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
|
|
92
|
+
result set.
|
|
93
|
+
"""
|
|
94
|
+
|
|
95
|
+
limit: Annotated[
|
|
96
|
+
OptionalNullable[int],
|
|
97
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
98
|
+
] = UNSET
|
|
99
|
+
r"""The maximum number of items to return. Defaults to 50 items."""
|
|
100
|
+
|
|
101
|
+
profile_id: Annotated[
|
|
102
|
+
OptionalNullable[str],
|
|
103
|
+
pydantic.Field(alias="profileId"),
|
|
104
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
105
|
+
] = UNSET
|
|
106
|
+
r"""The identifier referring to the [profile](get-profile) you wish to retrieve subscriptions for.
|
|
107
|
+
|
|
108
|
+
Most API credentials are linked to a single profile. In these cases the `profileId` is already implied.
|
|
109
|
+
|
|
110
|
+
To retrieve all subscriptions across the organization, use an organization-level API credential and omit the
|
|
111
|
+
`profileId` parameter.
|
|
112
|
+
"""
|
|
113
|
+
|
|
114
|
+
testmode: Annotated[
|
|
115
|
+
Optional[bool],
|
|
116
|
+
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
|
117
|
+
] = None
|
|
118
|
+
r"""Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
119
|
+
parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
120
|
+
setting the `testmode` query parameter to `true`.
|
|
121
|
+
|
|
122
|
+
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
123
|
+
"""
|
|
124
|
+
|
|
125
|
+
idempotency_key: Annotated[
|
|
126
|
+
Optional[str],
|
|
127
|
+
pydantic.Field(alias="idempotency-key"),
|
|
128
|
+
FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
|
|
129
|
+
] = None
|
|
130
|
+
r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
|
|
131
|
+
|
|
132
|
+
@model_serializer(mode="wrap")
|
|
133
|
+
def serialize_model(self, handler):
|
|
134
|
+
optional_fields = ["from", "limit", "profileId", "testmode", "idempotency-key"]
|
|
135
|
+
nullable_fields = ["from", "limit", "profileId"]
|
|
136
|
+
null_default_fields = []
|
|
137
|
+
|
|
138
|
+
serialized = handler(self)
|
|
139
|
+
|
|
140
|
+
m = {}
|
|
141
|
+
|
|
142
|
+
for n, f in type(self).model_fields.items():
|
|
143
|
+
k = f.alias or n
|
|
144
|
+
val = serialized.get(k)
|
|
145
|
+
serialized.pop(k, None)
|
|
146
|
+
|
|
147
|
+
optional_nullable = k in optional_fields and k in nullable_fields
|
|
148
|
+
is_set = (
|
|
149
|
+
self.__pydantic_fields_set__.intersection({n})
|
|
150
|
+
or k in null_default_fields
|
|
151
|
+
) # pylint: disable=no-member
|
|
152
|
+
|
|
153
|
+
if val is not None and val != UNSET_SENTINEL:
|
|
154
|
+
m[k] = val
|
|
155
|
+
elif val != UNSET_SENTINEL and (
|
|
156
|
+
not k in optional_fields or (optional_nullable and is_set)
|
|
157
|
+
):
|
|
158
|
+
m[k] = val
|
|
159
|
+
|
|
160
|
+
return m
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
class ListAllSubscriptionsEmbeddedTypedDict(TypedDict):
|
|
164
|
+
subscriptions: NotRequired[List[ListSubscriptionResponseTypedDict]]
|
|
165
|
+
r"""A list of subscription objects."""
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
class ListAllSubscriptionsEmbedded(BaseModel):
|
|
169
|
+
subscriptions: Optional[List[ListSubscriptionResponse]] = None
|
|
170
|
+
r"""A list of subscription objects."""
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
class ListAllSubscriptionsResponseTypedDict(TypedDict):
|
|
174
|
+
r"""A list of subscription objects."""
|
|
175
|
+
|
|
176
|
+
count: int
|
|
177
|
+
r"""The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
|
|
178
|
+
as well.
|
|
179
|
+
|
|
180
|
+
The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
|
|
181
|
+
limit is 50 items.
|
|
182
|
+
"""
|
|
183
|
+
embedded: ListAllSubscriptionsEmbeddedTypedDict
|
|
184
|
+
links: ListLinksTypedDict
|
|
185
|
+
r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
class ListAllSubscriptionsResponse(BaseModel):
|
|
189
|
+
r"""A list of subscription objects."""
|
|
190
|
+
|
|
191
|
+
count: int
|
|
192
|
+
r"""The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
|
|
193
|
+
as well.
|
|
194
|
+
|
|
195
|
+
The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
|
|
196
|
+
limit is 50 items.
|
|
197
|
+
"""
|
|
198
|
+
|
|
199
|
+
embedded: Annotated[ListAllSubscriptionsEmbedded, pydantic.Field(alias="_embedded")]
|
|
200
|
+
|
|
201
|
+
links: Annotated[ListLinks, pydantic.Field(alias="_links")]
|
|
202
|
+
r"""Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field."""
|