moovio_sdk 0.3.8__py3-none-any.whl

moovio_sdk/models/components/account.py

@@ -0,0 +1,96 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .accountcapability import AccountCapability, AccountCapabilityTypedDict
+from .accounttype import AccountType
+from .customersupport import CustomerSupport, CustomerSupportTypedDict
+from .mode import Mode
+from .profile import Profile, ProfileTypedDict
+from .settings import Settings, SettingsTypedDict
+from .termsofservice import TermsOfService, TermsOfServiceTypedDict
+from .verification import Verification, VerificationTypedDict
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AccountTypedDict(TypedDict):
+    account_id: str
+    r"""Unique identifier for this account."""
+    mode: Mode
+    r"""The operating mode for an account."""
+    account_type: AccountType
+    r"""The type of entity represented by this account."""
+    display_name: str
+    profile: ProfileTypedDict
+    r"""Describes a Moov account profile. A profile will have a business or an individual, depending on the account's type."""
+    verification: VerificationTypedDict
+    r"""Describes identity verification status and relevant identity verification documents."""
+    created_on: datetime
+    updated_on: datetime
+    metadata: NotRequired[Dict[str, str]]
+    r"""Free-form key-value pair list. Useful for storing information that is not captured elsewhere."""
+    terms_of_service: NotRequired[TermsOfServiceTypedDict]
+    r"""Describes the acceptance of the Terms of Service."""
+    capabilities: NotRequired[List[AccountCapabilityTypedDict]]
+    foreign_id: NotRequired[str]
+    r"""Optional alias from a foreign/external system which can be used to reference this resource."""
+    customer_support: NotRequired[CustomerSupportTypedDict]
+    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.
+    """
+    settings: NotRequired[SettingsTypedDict]
+    r"""User provided settings to manage an account."""
+    disconnected_on: NotRequired[datetime]
+
+
+class Account(BaseModel):
+    account_id: Annotated[str, pydantic.Field(alias="accountID")]
+    r"""Unique identifier for this account."""
+
+    mode: Mode
+    r"""The operating mode for an account."""
+
+    account_type: Annotated[AccountType, pydantic.Field(alias="accountType")]
+    r"""The type of entity represented by this account."""
+
+    display_name: Annotated[str, pydantic.Field(alias="displayName")]
+
+    profile: Profile
+    r"""Describes a Moov account profile. A profile will have a business or an individual, depending on the account's type."""
+
+    verification: Verification
+    r"""Describes identity verification status and relevant identity verification documents."""
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+
+    updated_on: Annotated[datetime, pydantic.Field(alias="updatedOn")]
+
+    metadata: Optional[Dict[str, str]] = None
+    r"""Free-form key-value pair list. Useful for storing information that is not captured elsewhere."""
+
+    terms_of_service: Annotated[
+        Optional[TermsOfService], pydantic.Field(alias="termsOfService")
+    ] = None
+    r"""Describes the acceptance of the Terms of Service."""
+
+    capabilities: Optional[List[AccountCapability]] = None
+
+    foreign_id: Annotated[Optional[str], pydantic.Field(alias="foreignID")] = None
+    r"""Optional alias from a foreign/external system which can be used to reference this resource."""
+
+    customer_support: Annotated[
+        Optional[CustomerSupport], pydantic.Field(alias="customerSupport")
+    ] = None
+    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.
+    """
+
+    settings: Optional[Settings] = None
+    r"""User provided settings to manage an account."""
+
+    disconnected_on: Annotated[
+        Optional[datetime], pydantic.Field(alias="disconnectedOn")
+    ] = None

moovio_sdk/models/components/accountcapability.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class AccountCapabilityTypedDict(TypedDict):
+    r"""Describes an action or set of actions that an account is permitted to perform."""
+
+    capability: str
+    status: str
+
+
+class AccountCapability(BaseModel):
+    r"""Describes an action or set of actions that an account is permitted to perform."""
+
+    capability: str
+
+    status: str

moovio_sdk/models/components/accountcountries.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class AccountCountriesTypedDict(TypedDict):
+    r"""The countries in which an account operates."""
+
+    countries: List[str]
+
+
+class AccountCountries(BaseModel):
+    r"""The countries in which an account operates."""
+
+    countries: List[str]

moovio_sdk/models/components/accountnameverification.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .cardverificationresult import CardVerificationResult
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AccountNameVerificationTypedDict(TypedDict):
+    r"""The results of submitting cardholder name to a card network for verification."""
+
+    first_name: CardVerificationResult
+    last_name: CardVerificationResult
+    middle_name: CardVerificationResult
+    full_name: CardVerificationResult
+
+
+class AccountNameVerification(BaseModel):
+    r"""The results of submitting cardholder name to a card network for verification."""
+
+    first_name: Annotated[CardVerificationResult, pydantic.Field(alias="firstName")]
+
+    last_name: Annotated[CardVerificationResult, pydantic.Field(alias="lastName")]
+
+    middle_name: Annotated[CardVerificationResult, pydantic.Field(alias="middleName")]
+
+    full_name: Annotated[CardVerificationResult, pydantic.Field(alias="fullName")]

moovio_sdk/models/components/accounttype.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class AccountType(str, Enum):
+    r"""The type of entity represented by this account."""
+
+    INDIVIDUAL = "individual"
+    BUSINESS = "business"

moovio_sdk/models/components/accountverificationstatus.py

@@ -0,0 +1,19 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from typing_extensions import deprecated
+
+
+@deprecated(
+    "warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+)
+class AccountVerificationStatus(str, Enum):
+    r"""Possible states an account verification can be in."""
+
+    UNVERIFIED = "unverified"
+    PENDING = "pending"
+    RESUBMIT = "resubmit"
+    REVIEW = "review"
+    VERIFIED = "verified"
+    FAILED = "failed"

moovio_sdk/models/components/achcreditsamedaypaymentmethod.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paymentmethodsbankaccount import (
+    PaymentMethodsBankAccount,
+    PaymentMethodsBankAccountTypedDict,
+)
+from enum import Enum
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AchCreditSameDayPaymentMethodPaymentMethodType(str, Enum):
+    ACH_CREDIT_SAME_DAY = "ach-credit-same-day"
+
+
+class AchCreditSameDayPaymentMethodTypedDict(TypedDict):
+    payment_method_id: str
+    r"""ID of the payment method."""
+    payment_method_type: AchCreditSameDayPaymentMethodPaymentMethodType
+    bank_account: PaymentMethodsBankAccountTypedDict
+    r"""A bank account as contained within a payment method."""
+
+
+class AchCreditSameDayPaymentMethod(BaseModel):
+    payment_method_id: Annotated[str, pydantic.Field(alias="paymentMethodID")]
+    r"""ID of the payment method."""
+
+    payment_method_type: Annotated[
+        AchCreditSameDayPaymentMethodPaymentMethodType,
+        pydantic.Field(alias="paymentMethodType"),
+    ]
+
+    bank_account: Annotated[
+        PaymentMethodsBankAccount, pydantic.Field(alias="bankAccount")
+    ]
+    r"""A bank account as contained within a payment method."""

moovio_sdk/models/components/achcreditstandardpaymentmethod.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paymentmethodsbankaccount import (
+    PaymentMethodsBankAccount,
+    PaymentMethodsBankAccountTypedDict,
+)
+from enum import Enum
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AchCreditStandardPaymentMethodPaymentMethodType(str, Enum):
+    ACH_CREDIT_STANDARD = "ach-credit-standard"
+
+
+class AchCreditStandardPaymentMethodTypedDict(TypedDict):
+    payment_method_id: str
+    r"""ID of the payment method."""
+    payment_method_type: AchCreditStandardPaymentMethodPaymentMethodType
+    bank_account: PaymentMethodsBankAccountTypedDict
+    r"""A bank account as contained within a payment method."""
+
+
+class AchCreditStandardPaymentMethod(BaseModel):
+    payment_method_id: Annotated[str, pydantic.Field(alias="paymentMethodID")]
+    r"""ID of the payment method."""
+
+    payment_method_type: Annotated[
+        AchCreditStandardPaymentMethodPaymentMethodType,
+        pydantic.Field(alias="paymentMethodType"),
+    ]
+
+    bank_account: Annotated[
+        PaymentMethodsBankAccount, pydantic.Field(alias="bankAccount")
+    ]
+    r"""A bank account as contained within a payment method."""

moovio_sdk/models/components/achdebitcollectpaymentmethod.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paymentmethodsbankaccount import (
+    PaymentMethodsBankAccount,
+    PaymentMethodsBankAccountTypedDict,
+)
+from enum import Enum
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AchDebitCollectPaymentMethodPaymentMethodType(str, Enum):
+    ACH_DEBIT_COLLECT = "ach-debit-collect"
+
+
+class AchDebitCollectPaymentMethodTypedDict(TypedDict):
+    payment_method_id: str
+    r"""ID of the payment method."""
+    payment_method_type: AchDebitCollectPaymentMethodPaymentMethodType
+    bank_account: PaymentMethodsBankAccountTypedDict
+    r"""A bank account as contained within a payment method."""
+
+
+class AchDebitCollectPaymentMethod(BaseModel):
+    payment_method_id: Annotated[str, pydantic.Field(alias="paymentMethodID")]
+    r"""ID of the payment method."""
+
+    payment_method_type: Annotated[
+        AchDebitCollectPaymentMethodPaymentMethodType,
+        pydantic.Field(alias="paymentMethodType"),
+    ]
+
+    bank_account: Annotated[
+        PaymentMethodsBankAccount, pydantic.Field(alias="bankAccount")
+    ]
+    r"""A bank account as contained within a payment method."""

moovio_sdk/models/components/achdebitfundpaymentmethod.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paymentmethodsbankaccount import (
+    PaymentMethodsBankAccount,
+    PaymentMethodsBankAccountTypedDict,
+)
+from enum import Enum
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AchDebitFundPaymentMethodPaymentMethodType(str, Enum):
+    ACH_DEBIT_FUND = "ach-debit-fund"
+
+
+class AchDebitFundPaymentMethodTypedDict(TypedDict):
+    payment_method_id: str
+    r"""ID of the payment method."""
+    payment_method_type: AchDebitFundPaymentMethodPaymentMethodType
+    bank_account: PaymentMethodsBankAccountTypedDict
+    r"""A bank account as contained within a payment method."""
+
+
+class AchDebitFundPaymentMethod(BaseModel):
+    payment_method_id: Annotated[str, pydantic.Field(alias="paymentMethodID")]
+    r"""ID of the payment method."""
+
+    payment_method_type: Annotated[
+        AchDebitFundPaymentMethodPaymentMethodType,
+        pydantic.Field(alias="paymentMethodType"),
+    ]
+
+    bank_account: Annotated[
+        PaymentMethodsBankAccount, pydantic.Field(alias="bankAccount")
+    ]
+    r"""A bank account as contained within a payment method."""

moovio_sdk/models/components/achexception.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ACHExceptionTypedDict(TypedDict):
+    code: NotRequired[str]
+    reason: NotRequired[str]
+    description: NotRequired[str]
+
+
+class ACHException(BaseModel):
+    code: Optional[str] = None
+
+    reason: Optional[str] = None
+
+    description: Optional[str] = None

moovio_sdk/models/components/achlocation.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AchLocationTypedDict(TypedDict):
+    address: str
+    city: str
+    postal_code: str
+    postal_code_extension: str
+    state: str
+
+
+class AchLocation(BaseModel):
+    address: str
+
+    city: str
+
+    postal_code: Annotated[str, pydantic.Field(alias="postalCode")]
+
+    postal_code_extension: Annotated[str, pydantic.Field(alias="postalCodeExtension")]
+
+    state: str

moovio_sdk/models/components/achparticipant.py

@@ -0,0 +1,93 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .achlocation import AchLocation, AchLocationTypedDict
+from moovio_sdk.types import BaseModel, Nullable, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, TypedDict
+
+
+class LogoTypedDict(TypedDict):
+    name: str
+    url: str
+
+
+class Logo(BaseModel):
+    name: str
+
+    url: str
+
+
+class AchParticipantTypedDict(TypedDict):
+    ach_location: AchLocationTypedDict
+    customer_name: str
+    new_routing_number: str
+    office_code: str
+    phone_number: str
+    record_type_code: str
+    revised: str
+    routing_number: str
+    servicing_frb_number: str
+    status_code: str
+    view_code: str
+    clean_name: str
+    logo: Nullable[LogoTypedDict]
+
+
+class AchParticipant(BaseModel):
+    ach_location: Annotated[AchLocation, pydantic.Field(alias="achLocation")]
+
+    customer_name: Annotated[str, pydantic.Field(alias="customerName")]
+
+    new_routing_number: Annotated[str, pydantic.Field(alias="newRoutingNumber")]
+
+    office_code: Annotated[str, pydantic.Field(alias="officeCode")]
+
+    phone_number: Annotated[str, pydantic.Field(alias="phoneNumber")]
+
+    record_type_code: Annotated[str, pydantic.Field(alias="recordTypeCode")]
+
+    revised: str
+
+    routing_number: Annotated[str, pydantic.Field(alias="routingNumber")]
+
+    servicing_frb_number: Annotated[str, pydantic.Field(alias="servicingFRBNumber")]
+
+    status_code: Annotated[str, pydantic.Field(alias="statusCode")]
+
+    view_code: Annotated[str, pydantic.Field(alias="viewCode")]
+
+    clean_name: Annotated[str, pydantic.Field(alias="cleanName")]
+
+    logo: Nullable[Logo]
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["logo"]
+        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/achpaymentdetails.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ACHPaymentDetailsTypedDict(TypedDict):
+    r"""Options for payment links used to collect an ACH payment."""
+
+    company_entry_description: NotRequired[str]
+    r"""An optional override of the default NACHA company entry description for a transfer."""
+    originating_company_name: NotRequired[str]
+    r"""An optional override of the default NACHA company name for a transfer."""
+
+
+class ACHPaymentDetails(BaseModel):
+    r"""Options for payment links used to collect an ACH payment."""
+
+    company_entry_description: Annotated[
+        Optional[str], pydantic.Field(alias="companyEntryDescription")
+    ] = None
+    r"""An optional override of the default NACHA company entry description for a transfer."""
+
+    originating_company_name: Annotated[
+        Optional[str], pydantic.Field(alias="originatingCompanyName")
+    ] = None
+    r"""An optional override of the default NACHA company name for a transfer."""

moovio_sdk/models/components/achpaymentdetailserror.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ACHPaymentDetailsErrorTypedDict(TypedDict):
+    company_entry_description: NotRequired[str]
+    originating_company_name: NotRequired[str]
+
+
+class ACHPaymentDetailsError(BaseModel):
+    company_entry_description: Annotated[
+        Optional[str], pydantic.Field(alias="companyEntryDescription")
+    ] = None
+
+    originating_company_name: Annotated[
+        Optional[str], pydantic.Field(alias="originatingCompanyName")
+    ] = None

moovio_sdk/models/components/achpaymentsettings.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class ACHPaymentSettingsTypedDict(TypedDict):
+    company_name: str
+    r"""The description that shows up on ACH transactions. This will default to the account's display name on account creation."""
+
+
+class ACHPaymentSettings(BaseModel):
+    company_name: Annotated[str, pydantic.Field(alias="companyName")]
+    r"""The description that shows up on ACH transactions. This will default to the account's display name on account creation."""

moovio_sdk/models/components/achreturncode.py

@@ -0,0 +1,51 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class ACHReturnCode(str, Enum):
+    r"""The return code of an ACH transaction that caused the bank account status to change.
+
+    - R02: Account Closed
+    - R03: No Account/Unable to Locate Account
+    - R04: Invalid Account Number
+    - R05: Improper Debit to Consumer Account
+    - R07: Authorization Revoked by Customer
+    - R08: Payment Stopped
+    - R10: Customer Advises Originator is Not Known or Authorized to Receiver
+    - R11: Customer Advises Entry Not in Accordance with the Terms of the Authorization
+    - R12: Branch Sold to Another DFI
+    - R13: RDFI not qualified to participate
+    - R14: Representative payee deceased or unable to continue in that capacity
+    - R15: Beneficiary or bank account holder
+    - R16: Bank account frozen
+    - R17: Entry with Invalid Account Number Initiated Under Questionable Circumstances
+    - R20: Non-payment bank account
+    - R23: Credit entry refused by receiver
+    - R29: Corporate customer advises not authorized
+    - R34: Limited participation RDFI
+    - R38: Stop Payment on Source Document (Adjustment Entry)
+    - R39: Improper Source Document
+    """
+
+    R02 = "R02"
+    R03 = "R03"
+    R04 = "R04"
+    R05 = "R05"
+    R07 = "R07"
+    R08 = "R08"
+    R10 = "R10"
+    R11 = "R11"
+    R12 = "R12"
+    R13 = "R13"
+    R14 = "R14"
+    R15 = "R15"
+    R16 = "R16"
+    R17 = "R17"
+    R20 = "R20"
+    R23 = "R23"
+    R29 = "R29"
+    R34 = "R34"
+    R38 = "R38"
+    R39 = "R39"