moovio_sdk 0.3.8__py3-none-any.whl

moovio_sdk/models/components/cardacquiringrefund.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .refundcarddetails import RefundCardDetails, RefundCardDetailsTypedDict
+from .refundstatus import RefundStatus
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CardAcquiringRefundTypedDict(TypedDict):
+    r"""Details of a card refund."""
+
+    refund_id: str
+    r"""Identifier for the refund."""
+    created_on: datetime
+    updated_on: datetime
+    status: RefundStatus
+    amount: AmountTypedDict
+    card_details: NotRequired[RefundCardDetailsTypedDict]
+
+
+class CardAcquiringRefund(BaseModel):
+    r"""Details of a card refund."""
+
+    refund_id: Annotated[str, pydantic.Field(alias="refundID")]
+    r"""Identifier for the refund."""
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+
+    updated_on: Annotated[datetime, pydantic.Field(alias="updatedOn")]
+
+    status: RefundStatus
+
+    amount: Amount
+
+    card_details: Annotated[
+        Optional[RefundCardDetails], pydantic.Field(alias="cardDetails")
+    ] = None

moovio_sdk/models/components/cardaddress.py

@@ -0,0 +1,32 @@
+"""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 CardAddressTypedDict(TypedDict):
+    postal_code: str
+    address_line1: NotRequired[str]
+    address_line2: NotRequired[str]
+    city: NotRequired[str]
+    state_or_province: NotRequired[str]
+    country: NotRequired[str]
+
+
+class CardAddress(BaseModel):
+    postal_code: Annotated[str, pydantic.Field(alias="postalCode")]
+
+    address_line1: Annotated[Optional[str], pydantic.Field(alias="addressLine1")] = None
+
+    address_line2: Annotated[Optional[str], pydantic.Field(alias="addressLine2")] = None
+
+    city: Optional[str] = None
+
+    state_or_province: Annotated[
+        Optional[str], pydantic.Field(alias="stateOrProvince")
+    ] = None
+
+    country: Optional[str] = None

moovio_sdk/models/components/cardbrand.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardBrand(str, Enum):
+    r"""The card brand."""
+
+    AMERICAN_EXPRESS = "American Express"
+    DISCOVER = "Discover"
+    MASTERCARD = "Mastercard"
+    VISA = "Visa"
+    UNKNOWN = "Unknown"

moovio_sdk/models/components/cardexpiration.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 CardExpirationTypedDict(TypedDict):
+    r"""The expiration date of the card or token."""
+
+    month: str
+    year: str
+
+
+class CardExpiration(BaseModel):
+    r"""The expiration date of the card or token."""
+
+    month: str
+
+    year: str

moovio_sdk/models/components/cardexpirationerror.py

@@ -0,0 +1,17 @@
+"""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 CardExpirationErrorTypedDict(TypedDict):
+    month: NotRequired[str]
+    year: NotRequired[str]
+
+
+class CardExpirationError(BaseModel):
+    month: Optional[str] = None
+
+    year: Optional[str] = None

moovio_sdk/models/components/cardissuingnetwork.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardIssuingNetwork(str, Enum):
+    r"""The name of the network a card transaction is routed through."""
+
+    DISCOVER = "discover"
+    SHAZAM = "shazam"
+    VISA = "visa"

moovio_sdk/models/components/cardpaymentdetails.py

@@ -0,0 +1,23 @@
+"""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 CardPaymentDetailsTypedDict(TypedDict):
+    r"""Options for payment links used to collect a card payment."""
+
+    dynamic_descriptor: NotRequired[str]
+    r"""An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field."""
+
+
+class CardPaymentDetails(BaseModel):
+    r"""Options for payment links used to collect a card payment."""
+
+    dynamic_descriptor: Annotated[
+        Optional[str], pydantic.Field(alias="dynamicDescriptor")
+    ] = None
+    r"""An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field."""

moovio_sdk/models/components/cardpaymentdetailserror.py

@@ -0,0 +1,17 @@
+"""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 CardPaymentDetailsErrorTypedDict(TypedDict):
+    dynamic_descriptor: NotRequired[str]
+
+
+class CardPaymentDetailsError(BaseModel):
+    dynamic_descriptor: Annotated[
+        Optional[str], pydantic.Field(alias="dynamicDescriptor")
+    ] = None

moovio_sdk/models/components/cardpaymentpaymentmethod.py

@@ -0,0 +1,33 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paymentmethodscard import PaymentMethodsCard, PaymentMethodsCardTypedDict
+from enum import Enum
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CardPaymentPaymentMethodPaymentMethodType(str, Enum):
+    CARD_PAYMENT = "card-payment"
+
+
+class CardPaymentPaymentMethodTypedDict(TypedDict):
+    payment_method_id: str
+    r"""ID of the payment method."""
+    payment_method_type: CardPaymentPaymentMethodPaymentMethodType
+    card: PaymentMethodsCardTypedDict
+    r"""A card as contained within a payment method."""
+
+
+class CardPaymentPaymentMethod(BaseModel):
+    payment_method_id: Annotated[str, pydantic.Field(alias="paymentMethodID")]
+    r"""ID of the payment method."""
+
+    payment_method_type: Annotated[
+        CardPaymentPaymentMethodPaymentMethodType,
+        pydantic.Field(alias="paymentMethodType"),
+    ]
+
+    card: PaymentMethodsCard
+    r"""A card as contained within a payment method."""

moovio_sdk/models/components/cardpaymentsettings.py

@@ -0,0 +1,23 @@
+"""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 CardPaymentSettingsTypedDict(TypedDict):
+    r"""User provided settings to manage card payments. This data is only allowed on a business account."""
+
+    statement_descriptor: NotRequired[str]
+    r"""The description that shows up on credit card transactions. This will default to the accounts display name on account creation."""
+
+
+class CardPaymentSettings(BaseModel):
+    r"""User provided settings to manage card payments. This data is only allowed on a business account."""
+
+    statement_descriptor: Annotated[
+        Optional[str], pydantic.Field(alias="statementDescriptor")
+    ] = None
+    r"""The description that shows up on credit card transactions. This will default to the accounts display name on account creation."""

moovio_sdk/models/components/cardtransactiondetails.py

@@ -0,0 +1,94 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .cardtransactionfailurecode import CardTransactionFailureCode
+from .cardtransactionstatus import CardTransactionStatus
+from .transactionsource import TransactionSource
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CardTransactionDetailsTypedDict(TypedDict):
+    r"""Card-specific details about the transaction."""
+
+    status: CardTransactionStatus
+    r"""Status of a transaction within the card payment lifecycle."""
+    failure_code: NotRequired[CardTransactionFailureCode]
+    dynamic_descriptor: NotRequired[str]
+    r"""An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field."""
+    transaction_source: NotRequired[TransactionSource]
+    r"""Specifies the nature and initiator of a transaction.
+
+    Crucial for recurring and merchant-initiated transactions as per card scheme rules.
+    Omit for customer-initiated e-commerce transactions.
+    """
+    initiated_on: NotRequired[datetime]
+    confirmed_on: NotRequired[datetime]
+    settled_on: NotRequired[datetime]
+    failed_on: NotRequired[datetime]
+    canceled_on: NotRequired[datetime]
+    completed_on: NotRequired[datetime]
+    interchange_qualification: NotRequired[str]
+    r"""The program assigned by the card network that determines the interchange rate for the transfer."""
+    fee_program: NotRequired[str]
+    r"""The program assigned by the card network that determines the interchange rate for the transfer."""
+
+
+class CardTransactionDetails(BaseModel):
+    r"""Card-specific details about the transaction."""
+
+    status: CardTransactionStatus
+    r"""Status of a transaction within the card payment lifecycle."""
+
+    failure_code: Annotated[
+        Optional[CardTransactionFailureCode], pydantic.Field(alias="failureCode")
+    ] = None
+
+    dynamic_descriptor: Annotated[
+        Optional[str], pydantic.Field(alias="dynamicDescriptor")
+    ] = None
+    r"""An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field."""
+
+    transaction_source: Annotated[
+        Optional[TransactionSource], pydantic.Field(alias="transactionSource")
+    ] = None
+    r"""Specifies the nature and initiator of a transaction.
+
+    Crucial for recurring and merchant-initiated transactions as per card scheme rules.
+    Omit for customer-initiated e-commerce transactions.
+    """
+
+    initiated_on: Annotated[Optional[datetime], pydantic.Field(alias="initiatedOn")] = (
+        None
+    )
+
+    confirmed_on: Annotated[Optional[datetime], pydantic.Field(alias="confirmedOn")] = (
+        None
+    )
+
+    settled_on: Annotated[Optional[datetime], pydantic.Field(alias="settledOn")] = None
+
+    failed_on: Annotated[Optional[datetime], pydantic.Field(alias="failedOn")] = None
+
+    canceled_on: Annotated[Optional[datetime], pydantic.Field(alias="canceledOn")] = (
+        None
+    )
+
+    completed_on: Annotated[Optional[datetime], pydantic.Field(alias="completedOn")] = (
+        None
+    )
+
+    interchange_qualification: Annotated[
+        Optional[str],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="interchangeQualification",
+        ),
+    ] = None
+    r"""The program assigned by the card network that determines the interchange rate for the transfer."""
+
+    fee_program: Annotated[Optional[str], pydantic.Field(alias="feeProgram")] = None
+    r"""The program assigned by the card network that determines the interchange rate for the transfer."""

moovio_sdk/models/components/cardtransactionfailurecode.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardTransactionFailureCode(str, Enum):
+    CALL_ISSUER = "call-issuer"
+    DO_NOT_HONOR = "do-not-honor"
+    PROCESSING_ERROR = "processing-error"
+    INVALID_TRANSACTION = "invalid-transaction"
+    INVALID_AMOUNT = "invalid-amount"
+    NO_SUCH_ISSUER = "no-such-issuer"
+    REENTER_TRANSACTION = "reenter-transaction"
+    CVV_MISMATCH = "cvv-mismatch"
+    LOST_OR_STOLEN = "lost-or-stolen"
+    INSUFFICIENT_FUNDS = "insufficient-funds"
+    INVALID_CARD_NUMBER = "invalid-card-number"
+    INVALID_MERCHANT = "invalid-merchant"
+    EXPIRED_CARD = "expired-card"
+    INCORRECT_PIN = "incorrect-pin"
+    TRANSACTION_NOT_ALLOWED = "transaction-not-allowed"
+    SUSPECTED_FRAUD = "suspected-fraud"
+    AMOUNT_LIMIT_EXCEEDED = "amount-limit-exceeded"
+    VELOCITY_LIMIT_EXCEEDED = "velocity-limit-exceeded"
+    REVOCATION_OF_AUTHORIZATION = "revocation-of-authorization"
+    CARD_NOT_ACTIVATED = "card-not-activated"
+    ISSUER_NOT_AVAILABLE = "issuer-not-available"
+    COULD_NOT_ROUTE = "could-not-route"
+    CARDHOLDER_ACCOUNT_CLOSED = "cardholder-account-closed"
+    UNKNOWN_ISSUE = "unknown-issue"
+    DUPLICATE_TRANSACTION = "duplicate-transaction"

moovio_sdk/models/components/cardtransactionstatus.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardTransactionStatus(str, Enum):
+    r"""Status of a transaction within the card payment lifecycle."""
+
+    INITIATED = "initiated"
+    CONFIRMED = "confirmed"
+    CANCELED = "canceled"
+    SETTLED = "settled"
+    FAILED = "failed"
+    COMPLETED = "completed"

moovio_sdk/models/components/cardtype.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardType(str, Enum):
+    r"""The type of the card."""
+
+    DEBIT = "debit"
+    CREDIT = "credit"
+    PREPAID = "prepaid"
+    UNKNOWN = "unknown"

moovio_sdk/models/components/cardupdatereason.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardUpdateReason(str, Enum):
+    r"""The results of the card update request."""
+
+    UNSPECIFIED = "unspecified"
+    ACCOUNT_CLOSED = "account-closed"
+    CONTACT_CARDHOLDER = "contact-cardholder"
+    EXPIRATION_UPDATE = "expiration-update"
+    NO_CHANGE = "no-change"
+    NO_MATCH = "no-match"
+    NUMBER_UPDATE = "number-update"

moovio_sdk/models/components/cardverification.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .accountnameverification import (
+    AccountNameVerification,
+    AccountNameVerificationTypedDict,
+)
+from .cardverificationresult import CardVerificationResult
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CardVerificationTypedDict(TypedDict):
+    r"""The results of submitting cardholder data to a card network for verification."""
+
+    cvv: CardVerificationResult
+    address_line1: CardVerificationResult
+    postal_code: CardVerificationResult
+    account_name: AccountNameVerificationTypedDict
+    r"""The results of submitting cardholder name to a card network for verification."""
+
+
+class CardVerification(BaseModel):
+    r"""The results of submitting cardholder data to a card network for verification."""
+
+    cvv: CardVerificationResult
+
+    address_line1: Annotated[
+        CardVerificationResult, pydantic.Field(alias="addressLine1")
+    ]
+
+    postal_code: Annotated[CardVerificationResult, pydantic.Field(alias="postalCode")]
+
+    account_name: Annotated[
+        AccountNameVerification, pydantic.Field(alias="accountName")
+    ]
+    r"""The results of submitting cardholder name to a card network for verification."""

moovio_sdk/models/components/cardverificationresult.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CardVerificationResult(str, Enum):
+    NO_MATCH = "noMatch"
+    MATCH = "match"
+    NOT_CHECKED = "notChecked"
+    UNAVAILABLE = "unavailable"
+    PARTIAL_MATCH = "partialMatch"

moovio_sdk/models/components/cardvolumedistribution.py

@@ -0,0 +1,29 @@
+"""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 CardVolumeDistributionTypedDict(TypedDict):
+    ecommerce_percentage: int
+    card_present_percentage: int
+    mail_or_phone_percentage: int
+    debt_repayment_percentage: int
+
+
+class CardVolumeDistribution(BaseModel):
+    ecommerce_percentage: Annotated[int, pydantic.Field(alias="ecommercePercentage")]
+
+    card_present_percentage: Annotated[
+        int, pydantic.Field(alias="cardPresentPercentage")
+    ]
+
+    mail_or_phone_percentage: Annotated[
+        int, pydantic.Field(alias="mailOrPhonePercentage")
+    ]
+
+    debt_repayment_percentage: Annotated[
+        int, pydantic.Field(alias="debtRepaymentPercentage")
+    ]

moovio_sdk/models/components/cardvolumedistributionerror.py

@@ -0,0 +1,32 @@
+"""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 CardVolumeDistributionErrorTypedDict(TypedDict):
+    ecommerce_percentage: NotRequired[str]
+    card_present_percentage: NotRequired[str]
+    mail_or_phone_percentage: NotRequired[str]
+    debt_repayment_percentage: NotRequired[str]
+
+
+class CardVolumeDistributionError(BaseModel):
+    ecommerce_percentage: Annotated[
+        Optional[str], pydantic.Field(alias="ecommercePercentage")
+    ] = None
+
+    card_present_percentage: Annotated[
+        Optional[str], pydantic.Field(alias="cardPresentPercentage")
+    ] = None
+
+    mail_or_phone_percentage: Annotated[
+        Optional[str], pydantic.Field(alias="mailOrPhonePercentage")
+    ] = None
+
+    debt_repayment_percentage: Annotated[
+        Optional[str], pydantic.Field(alias="debtRepaymentPercentage")
+    ] = None

moovio_sdk/models/components/collectionpaymentmethodtype.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class CollectionPaymentMethodType(str, Enum):
+    r"""Payment methods allowed for collecting a payment."""
+
+    APPLE_PAY = "apple-pay"
+    CARD_PAYMENT = "card-payment"
+    ACH_DEBIT_COLLECT = "ach-debit-collect"

moovio_sdk/models/components/colorsvalidationerror.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .brandcolorvalidationerror import (
+    BrandColorValidationError,
+    BrandColorValidationErrorTypedDict,
+)
+from moovio_sdk.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ColorsValidationErrorTypedDict(TypedDict):
+    light: NotRequired[BrandColorValidationErrorTypedDict]
+    dark: NotRequired[BrandColorValidationErrorTypedDict]
+
+
+class ColorsValidationError(BaseModel):
+    light: Optional[BrandColorValidationError] = None
+
+    dark: Optional[BrandColorValidationError] = None

moovio_sdk/models/components/completebankaccountverification.py

@@ -0,0 +1,15 @@
+"""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 CompleteBankAccountVerificationTypedDict(TypedDict):
+    code: str
+    r"""Code provided by user from their bank account transactions"""
+
+
+class CompleteBankAccountVerification(BaseModel):
+    code: str
+    r"""Code provided by user from their bank account transactions"""

moovio_sdk/models/components/completedmicrodeposits.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .microdepositstatus import MicroDepositStatus
+from moovio_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class CompletedMicroDepositsTypedDict(TypedDict):
+    status: MicroDepositStatus
+
+
+class CompletedMicroDeposits(BaseModel):
+    status: MicroDepositStatus

moovio_sdk/models/components/completemicrodeposits.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 List
+from typing_extensions import TypedDict
+
+
+class CompleteMicroDepositsTypedDict(TypedDict):
+    r"""Request to complete the micro-deposit verification workflow."""
+
+    amounts: List[int]
+    r"""Two positive integers, in cents, equal to the values of the micro-deposits sent to the bank account."""
+
+
+class CompleteMicroDeposits(BaseModel):
+    r"""Request to complete the micro-deposit verification workflow."""
+
+    amounts: List[int]
+    r"""Two positive integers, in cents, equal to the values of the micro-deposits sent to the bank account."""

moovio_sdk/models/components/countrieserrors.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.types import BaseModel
+from typing import Dict
+from typing_extensions import TypedDict
+
+
+class CountriesErrorsTypedDict(TypedDict):
+    countries: Dict[str, str]
+
+
+class CountriesErrors(BaseModel):
+    countries: Dict[str, str]