moovio_sdk 0.3.8__py3-none-any.whl

moovio_sdk/models/components/patchaccount.py

@@ -0,0 +1,138 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .addressupdate import AddressUpdate, AddressUpdateTypedDict
+from .createaccountsettings import CreateAccountSettings, CreateAccountSettingsTypedDict
+from .manualtermsofserviceupdate import (
+    ManualTermsOfServiceUpdate,
+    ManualTermsOfServiceUpdateTypedDict,
+)
+from .patchprofile import PatchProfile, PatchProfileTypedDict
+from .phonenumber import PhoneNumber, PhoneNumberTypedDict
+from .termsofservicetokenupdate import (
+    TermsOfServiceTokenUpdate,
+    TermsOfServiceTokenUpdateTypedDict,
+)
+from moovio_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Dict, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+PatchAccountTermsOfServiceTypedDict = TypeAliasType(
+    "PatchAccountTermsOfServiceTypedDict",
+    Union[TermsOfServiceTokenUpdateTypedDict, ManualTermsOfServiceUpdateTypedDict],
+)
+
+
+PatchAccountTermsOfService = TypeAliasType(
+    "PatchAccountTermsOfService",
+    Union[TermsOfServiceTokenUpdate, ManualTermsOfServiceUpdate],
+)
+
+
+class PatchAccountCustomerSupportTypedDict(TypedDict):
+    r"""User-provided information that can be displayed on credit card transactions for customers to use when
+    contacting a customer support team. This data is only allowed on a business account.
+    """
+
+    phone: NotRequired[PhoneNumberTypedDict]
+    email: NotRequired[str]
+    address: NotRequired[AddressUpdateTypedDict]
+    website: NotRequired[str]
+
+
+class PatchAccountCustomerSupport(BaseModel):
+    r"""User-provided information that can be displayed on credit card transactions for customers to use when
+    contacting a customer support team. This data is only allowed on a business account.
+    """
+
+    phone: Optional[PhoneNumber] = None
+
+    email: Optional[str] = None
+
+    address: Optional[AddressUpdate] = None
+
+    website: Optional[str] = None
+
+
+class PatchAccountTypedDict(TypedDict):
+    r"""Describes the fields available when patching a Moov account."""
+
+    profile: NotRequired[PatchProfileTypedDict]
+    r"""Describes the fields available when patching a profile.
+    Each object can be patched independent of patching the other fields.
+    """
+    metadata: NotRequired[Nullable[Dict[str, str]]]
+    terms_of_service: NotRequired[PatchAccountTermsOfServiceTypedDict]
+    foreign_id: NotRequired[str]
+    customer_support: NotRequired[Nullable[PatchAccountCustomerSupportTypedDict]]
+    settings: NotRequired[CreateAccountSettingsTypedDict]
+
+
+class PatchAccount(BaseModel):
+    r"""Describes the fields available when patching a Moov account."""
+
+    profile: Optional[PatchProfile] = None
+    r"""Describes the fields available when patching a profile.
+    Each object can be patched independent of patching the other fields.
+    """
+
+    metadata: OptionalNullable[Dict[str, str]] = UNSET
+
+    terms_of_service: Annotated[
+        Optional[PatchAccountTermsOfService], pydantic.Field(alias="termsOfService")
+    ] = None
+
+    foreign_id: Annotated[Optional[str], pydantic.Field(alias="foreignID")] = None
+
+    customer_support: Annotated[
+        OptionalNullable[PatchAccountCustomerSupport],
+        pydantic.Field(alias="customerSupport"),
+    ] = UNSET
+
+    settings: Optional[CreateAccountSettings] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "profile",
+            "metadata",
+            "termsOfService",
+            "foreignID",
+            "customerSupport",
+            "settings",
+        ]
+        nullable_fields = ["metadata", "customerSupport"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in 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

moovio_sdk/models/components/patchaccounterror.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createaccountsettings import CreateAccountSettings, CreateAccountSettingsTypedDict
+from .createprofileerror import CreateProfileError, CreateProfileErrorTypedDict
+from .customersupporterror import CustomerSupportError, CustomerSupportErrorTypedDict
+from .termsofserviceerror import TermsOfServiceError, TermsOfServiceErrorTypedDict
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PatchAccountErrorTypedDict(TypedDict):
+    profile: NotRequired[CreateProfileErrorTypedDict]
+    metadata: NotRequired[str]
+    terms_of_service: NotRequired[TermsOfServiceErrorTypedDict]
+    foreign_id: NotRequired[str]
+    customer_support: NotRequired[CustomerSupportErrorTypedDict]
+    settings: NotRequired[CreateAccountSettingsTypedDict]
+
+
+class PatchAccountError(BaseModel):
+    profile: Optional[CreateProfileError] = None
+
+    metadata: Optional[str] = None
+
+    terms_of_service: Annotated[
+        Optional[TermsOfServiceError], pydantic.Field(alias="termsOfService")
+    ] = None
+
+    foreign_id: Annotated[Optional[str], pydantic.Field(alias="foreignID")] = None
+
+    customer_support: Annotated[
+        Optional[CustomerSupportError], pydantic.Field(alias="customerSupport")
+    ] = None
+
+    settings: Optional[CreateAccountSettings] = None

moovio_sdk/models/components/patchbusiness.py

@@ -0,0 +1,72 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .addressupdate import AddressUpdate, AddressUpdateTypedDict
+from .businesstype import BusinessType
+from .industrycodes import IndustryCodes, IndustryCodesTypedDict
+from .phonenumber import PhoneNumber, PhoneNumberTypedDict
+from .primaryregulator import PrimaryRegulator
+from .taxidupdate import TaxIDUpdate, TaxIDUpdateTypedDict
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PatchBusinessTypedDict(TypedDict):
+    legal_business_name: NotRequired[str]
+    doing_business_as: NotRequired[str]
+    business_type: NotRequired[BusinessType]
+    r"""The type of entity represented by this business."""
+    address: NotRequired[AddressUpdateTypedDict]
+    phone: NotRequired[PhoneNumberTypedDict]
+    email: NotRequired[str]
+    website: NotRequired[str]
+    description: NotRequired[str]
+    tax_id: NotRequired[TaxIDUpdateTypedDict]
+    r"""An EIN (employer identification number) for the business. For sole proprietors, an SSN can be used as the EIN."""
+    owners_provided: NotRequired[bool]
+    industry_codes: NotRequired[IndustryCodesTypedDict]
+    primary_regulator: NotRequired[PrimaryRegulator]
+    r"""If the business is a financial institution, this field describes its primary regulator."""
+
+
+class PatchBusiness(BaseModel):
+    legal_business_name: Annotated[
+        Optional[str], pydantic.Field(alias="legalBusinessName")
+    ] = None
+
+    doing_business_as: Annotated[
+        Optional[str], pydantic.Field(alias="doingBusinessAs")
+    ] = None
+
+    business_type: Annotated[
+        Optional[BusinessType], pydantic.Field(alias="businessType")
+    ] = None
+    r"""The type of entity represented by this business."""
+
+    address: Optional[AddressUpdate] = None
+
+    phone: Optional[PhoneNumber] = None
+
+    email: Optional[str] = None
+
+    website: Optional[str] = None
+
+    description: Optional[str] = None
+
+    tax_id: Annotated[Optional[TaxIDUpdate], pydantic.Field(alias="taxID")] = None
+    r"""An EIN (employer identification number) for the business. For sole proprietors, an SSN can be used as the EIN."""
+
+    owners_provided: Annotated[
+        Optional[bool], pydantic.Field(alias="ownersProvided")
+    ] = None
+
+    industry_codes: Annotated[
+        Optional[IndustryCodes], pydantic.Field(alias="industryCodes")
+    ] = None
+
+    primary_regulator: Annotated[
+        Optional[PrimaryRegulator], pydantic.Field(alias="primaryRegulator")
+    ] = None
+    r"""If the business is a financial institution, this field describes its primary regulator."""

moovio_sdk/models/components/patchindividual.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .addressupdate import AddressUpdate, AddressUpdateTypedDict
+from .birthdateupdate import BirthDateUpdate, BirthDateUpdateTypedDict
+from .governmentid import GovernmentID, GovernmentIDTypedDict
+from .individualnameupdate import IndividualNameUpdate, IndividualNameUpdateTypedDict
+from .phonenumber import PhoneNumber, PhoneNumberTypedDict
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PatchIndividualTypedDict(TypedDict):
+    r"""Describes the fields available when patching an individual."""
+
+    name: NotRequired[IndividualNameUpdateTypedDict]
+    phone: NotRequired[PhoneNumberTypedDict]
+    email: NotRequired[str]
+    address: NotRequired[AddressUpdateTypedDict]
+    birth_date: NotRequired[BirthDateUpdateTypedDict]
+    government_id: NotRequired[GovernmentIDTypedDict]
+
+
+class PatchIndividual(BaseModel):
+    r"""Describes the fields available when patching an individual."""
+
+    name: Optional[IndividualNameUpdate] = None
+
+    phone: Optional[PhoneNumber] = None
+
+    email: Optional[str] = None
+
+    address: Optional[AddressUpdate] = None
+
+    birth_date: Annotated[
+        Optional[BirthDateUpdate], pydantic.Field(alias="birthDate")
+    ] = None
+
+    government_id: Annotated[
+        Optional[GovernmentID], pydantic.Field(alias="governmentID")
+    ] = None

moovio_sdk/models/components/patchprofile.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .patchbusiness import PatchBusiness, PatchBusinessTypedDict
+from .patchindividual import PatchIndividual, PatchIndividualTypedDict
+from moovio_sdk.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class PatchProfileTypedDict(TypedDict):
+    r"""Describes the fields available when patching a profile.
+    Each object can be patched independent of patching the other fields.
+    """
+
+    individual: NotRequired[PatchIndividualTypedDict]
+    r"""Describes the fields available when patching an individual."""
+    business: NotRequired[PatchBusinessTypedDict]
+
+
+class PatchProfile(BaseModel):
+    r"""Describes the fields available when patching a profile.
+    Each object can be patched independent of patching the other fields.
+    """
+
+    individual: Optional[PatchIndividual] = None
+    r"""Describes the fields available when patching an individual."""
+
+    business: Optional[PatchBusiness] = None

moovio_sdk/models/components/patchsweepconfig.py

@@ -0,0 +1,147 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from moovio_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+class Status(str, Enum):
+    ENABLED = "enabled"
+    DISABLED = "disabled"
+
+
+class PushPaymentMethodID2TypedDict(TypedDict):
+    pass
+
+
+class PushPaymentMethodID2(BaseModel):
+    pass
+
+
+PushPaymentMethodIDTypedDict = TypeAliasType(
+    "PushPaymentMethodIDTypedDict", Union[PushPaymentMethodID2TypedDict, str]
+)
+
+
+PushPaymentMethodID = TypeAliasType(
+    "PushPaymentMethodID", Union[PushPaymentMethodID2, str]
+)
+
+
+class PullPaymentMethodID2TypedDict(TypedDict):
+    pass
+
+
+class PullPaymentMethodID2(BaseModel):
+    pass
+
+
+PullPaymentMethodIDTypedDict = TypeAliasType(
+    "PullPaymentMethodIDTypedDict", Union[PullPaymentMethodID2TypedDict, str]
+)
+
+
+PullPaymentMethodID = TypeAliasType(
+    "PullPaymentMethodID", Union[PullPaymentMethodID2, str]
+)
+
+
+class StatementDescriptor2TypedDict(TypedDict):
+    pass
+
+
+class StatementDescriptor2(BaseModel):
+    pass
+
+
+StatementDescriptorTypedDict = TypeAliasType(
+    "StatementDescriptorTypedDict", Union[StatementDescriptor2TypedDict, str]
+)
+
+
+StatementDescriptor = TypeAliasType(
+    "StatementDescriptor", Union[StatementDescriptor2, str]
+)
+
+
+class PatchSweepConfigTypedDict(TypedDict):
+    status: NotRequired[Nullable[Status]]
+    push_payment_method_id: NotRequired[Nullable[PushPaymentMethodIDTypedDict]]
+    pull_payment_method_id: NotRequired[Nullable[PullPaymentMethodIDTypedDict]]
+    statement_descriptor: NotRequired[Nullable[StatementDescriptorTypedDict]]
+    minimum_balance: NotRequired[Nullable[str]]
+
+
+class PatchSweepConfig(BaseModel):
+    status: OptionalNullable[Status] = UNSET
+
+    push_payment_method_id: Annotated[
+        OptionalNullable[PushPaymentMethodID],
+        pydantic.Field(alias="pushPaymentMethodID"),
+    ] = UNSET
+
+    pull_payment_method_id: Annotated[
+        OptionalNullable[PullPaymentMethodID],
+        pydantic.Field(alias="pullPaymentMethodID"),
+    ] = UNSET
+
+    statement_descriptor: Annotated[
+        OptionalNullable[StatementDescriptor],
+        pydantic.Field(alias="statementDescriptor"),
+    ] = UNSET
+
+    minimum_balance: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="minimumBalance")
+    ] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "status",
+            "pushPaymentMethodID",
+            "pullPaymentMethodID",
+            "statementDescriptor",
+            "minimumBalance",
+        ]
+        nullable_fields = [
+            "status",
+            "pushPaymentMethodID",
+            "pullPaymentMethodID",
+            "statementDescriptor",
+            "minimumBalance",
+        ]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in 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

moovio_sdk/models/components/patchtransfer.py

@@ -0,0 +1,51 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Dict
+from typing_extensions import NotRequired, TypedDict
+
+
+class PatchTransferTypedDict(TypedDict):
+    metadata: NotRequired[Nullable[Dict[str, str]]]
+
+
+class PatchTransfer(BaseModel):
+    metadata: OptionalNullable[Dict[str, str]] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["metadata"]
+        nullable_fields = ["metadata"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in 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

moovio_sdk/models/components/paymentdetailserror.py

@@ -0,0 +1,35 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .achpaymentdetailserror import (
+    ACHPaymentDetailsError,
+    ACHPaymentDetailsErrorTypedDict,
+)
+from .cardpaymentdetailserror import (
+    CardPaymentDetailsError,
+    CardPaymentDetailsErrorTypedDict,
+)
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PaymentDetailsErrorTypedDict(TypedDict):
+    allowed_methods: NotRequired[str]
+    card_details: NotRequired[CardPaymentDetailsErrorTypedDict]
+    ach_details: NotRequired[ACHPaymentDetailsErrorTypedDict]
+
+
+class PaymentDetailsError(BaseModel):
+    allowed_methods: Annotated[
+        Optional[str], pydantic.Field(alias="allowedMethods")
+    ] = None
+
+    card_details: Annotated[
+        Optional[CardPaymentDetailsError], pydantic.Field(alias="cardDetails")
+    ] = None
+
+    ach_details: Annotated[
+        Optional[ACHPaymentDetailsError], pydantic.Field(alias="achDetails")
+    ] = None

moovio_sdk/models/components/paymentlink.py

@@ -0,0 +1,125 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .mode import Mode
+from .paymentlinkcustomeroptions import (
+    PaymentLinkCustomerOptions,
+    PaymentLinkCustomerOptionsTypedDict,
+)
+from .paymentlinkdisplayoptions import (
+    PaymentLinkDisplayOptions,
+    PaymentLinkDisplayOptionsTypedDict,
+)
+from .paymentlinkpaymentdetails import (
+    PaymentLinkPaymentDetails,
+    PaymentLinkPaymentDetailsTypedDict,
+)
+from .paymentlinkpayoutdetails import (
+    PaymentLinkPayoutDetails,
+    PaymentLinkPayoutDetailsTypedDict,
+)
+from .paymentlinkstatus import PaymentLinkStatus
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PaymentLinkTypedDict(TypedDict):
+    code: str
+    r"""Unique code identifying this payment link."""
+    mode: Mode
+    r"""The operating mode for an account."""
+    status: PaymentLinkStatus
+    partner_account_id: str
+    r"""The partner's Moov account ID."""
+    merchant_account_id: str
+    r"""The merchant's Moov account ID."""
+    merchant_payment_method_id: str
+    r"""The merchant's preferred payment method ID. Must be a wallet payment method."""
+    link: str
+    r"""Link to the payment landing page for this payment link."""
+    amount: AmountTypedDict
+    uses: int
+    r"""The number of times this payment link has been used."""
+    display: PaymentLinkDisplayOptionsTypedDict
+    r"""Customizable display options for a payment link."""
+    customer: PaymentLinkCustomerOptionsTypedDict
+    created_on: datetime
+    updated_on: datetime
+    max_uses: NotRequired[int]
+    r"""An optional limit on the number of times this payment link can be used.
+
+    **For payouts, `maxUses` is always 1.**
+    """
+    last_used_on: NotRequired[datetime]
+    r"""The timestamp when this payment link was last used."""
+    expires_on: NotRequired[datetime]
+    r"""An optional expiration date for this payment link."""
+    payment: NotRequired[PaymentLinkPaymentDetailsTypedDict]
+    r"""Options for payment links used to collect payment."""
+    payout: NotRequired[PaymentLinkPayoutDetailsTypedDict]
+    disabled_on: NotRequired[datetime]
+
+
+class PaymentLink(BaseModel):
+    code: str
+    r"""Unique code identifying this payment link."""
+
+    mode: Mode
+    r"""The operating mode for an account."""
+
+    status: PaymentLinkStatus
+
+    partner_account_id: Annotated[str, pydantic.Field(alias="partnerAccountID")]
+    r"""The partner's Moov account ID."""
+
+    merchant_account_id: Annotated[str, pydantic.Field(alias="merchantAccountID")]
+    r"""The merchant's Moov account ID."""
+
+    merchant_payment_method_id: Annotated[
+        str, pydantic.Field(alias="merchantPaymentMethodID")
+    ]
+    r"""The merchant's preferred payment method ID. Must be a wallet payment method."""
+
+    link: str
+    r"""Link to the payment landing page for this payment link."""
+
+    amount: Amount
+
+    uses: int
+    r"""The number of times this payment link has been used."""
+
+    display: PaymentLinkDisplayOptions
+    r"""Customizable display options for a payment link."""
+
+    customer: PaymentLinkCustomerOptions
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+
+    updated_on: Annotated[datetime, pydantic.Field(alias="updatedOn")]
+
+    max_uses: Annotated[Optional[int], pydantic.Field(alias="maxUses")] = None
+    r"""An optional limit on the number of times this payment link can be used.
+
+    **For payouts, `maxUses` is always 1.**
+    """
+
+    last_used_on: Annotated[Optional[datetime], pydantic.Field(alias="lastUsedOn")] = (
+        None
+    )
+    r"""The timestamp when this payment link was last used."""
+
+    expires_on: Annotated[Optional[datetime], pydantic.Field(alias="expiresOn")] = None
+    r"""An optional expiration date for this payment link."""
+
+    payment: Optional[PaymentLinkPaymentDetails] = None
+    r"""Options for payment links used to collect payment."""
+
+    payout: Optional[PaymentLinkPayoutDetails] = None
+
+    disabled_on: Annotated[Optional[datetime], pydantic.Field(alias="disabledOn")] = (
+        None
+    )