moovio_sdk 0.3.8__py3-none-any.whl

moovio_sdk/models/components/customersupporterror.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .addresserror import AddressError, AddressErrorTypedDict
+from .phonenumbererror import PhoneNumberError, PhoneNumberErrorTypedDict
+from moovio_sdk.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CustomerSupportErrorTypedDict(TypedDict):
+    phone: NotRequired[PhoneNumberErrorTypedDict]
+    email: NotRequired[str]
+    address: NotRequired[AddressErrorTypedDict]
+    website: NotRequired[str]
+
+
+class CustomerSupportError(BaseModel):
+    phone: Optional[PhoneNumberError] = None
+
+    email: Optional[str] = None
+
+    address: Optional[AddressError] = None
+
+    website: Optional[str] = None

moovio_sdk/models/components/debitholdperiod.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DebitHoldPeriod(str, Enum):
+    r"""An optional override of your default ACH hold period in banking days. The hold period must be longer than or equal to your default setting."""
+
+    NO_HOLD = "no-hold"
+    ONE_DAY = "1-day"
+    TWO_DAYS = "2-days"

moovio_sdk/models/components/disbursementpaymentmethodtype.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DisbursementPaymentMethodType(str, Enum):
+    r"""Payment methods allowed for disbursing funds."""
+
+    PUSH_TO_CARD = "push-to-card"
+    RTP_CREDIT = "rtp-credit"
+    ACH_CREDIT_SAME_DAY = "ach-credit-same-day"
+    ACH_CREDIT_STANDARD = "ach-credit-standard"

moovio_sdk/models/components/displayoptionserror.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 DisplayOptionsErrorTypedDict(TypedDict):
+    title: NotRequired[str]
+    description: NotRequired[str]
+    call_to_action: NotRequired[str]
+
+
+class DisplayOptionsError(BaseModel):
+    title: Optional[str] = None
+
+    description: Optional[str] = None
+
+    call_to_action: Annotated[Optional[str], pydantic.Field(alias="callToAction")] = (
+        None
+    )

moovio_sdk/models/components/dispute.py

@@ -0,0 +1,76 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .amount import Amount, AmountTypedDict
+from .disputephase import DisputePhase
+from .disputestatus import DisputeStatus
+from .disputetransferdetails import (
+    DisputeTransferDetails,
+    DisputeTransferDetailsTypedDict,
+)
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class DisputeTypedDict(TypedDict):
+    r"""Details of a card transaction dispute."""
+
+    dispute_id: str
+    merchant_account_id: str
+    amount: AmountTypedDict
+    network_reason_code: str
+    r"""Indicates the card network's category for the dispute.
+
+    These codes may differ between card brands. You can find more information on the code from the networkReasonDescription field.
+    """
+    transfer: DisputeTransferDetailsTypedDict
+    respond_by: datetime
+    status: DisputeStatus
+    r"""The status of a particular dispute.
+
+    Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/#dispute-statuses) to learn what each status means.
+    """
+    phase: DisputePhase
+    r"""The phase of a dispute within the dispute lifecycle."""
+    created_on: datetime
+    network_reason_description: NotRequired[str]
+    r"""Provides detail on the card network's categorization of the dispute."""
+
+
+class Dispute(BaseModel):
+    r"""Details of a card transaction dispute."""
+
+    dispute_id: Annotated[str, pydantic.Field(alias="disputeID")]
+
+    merchant_account_id: Annotated[str, pydantic.Field(alias="merchantAccountID")]
+
+    amount: Amount
+
+    network_reason_code: Annotated[str, pydantic.Field(alias="networkReasonCode")]
+    r"""Indicates the card network's category for the dispute.
+
+    These codes may differ between card brands. You can find more information on the code from the networkReasonDescription field.
+    """
+
+    transfer: DisputeTransferDetails
+
+    respond_by: Annotated[datetime, pydantic.Field(alias="respondBy")]
+
+    status: DisputeStatus
+    r"""The status of a particular dispute.
+
+    Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/#dispute-statuses) to learn what each status means.
+    """
+
+    phase: DisputePhase
+    r"""The phase of a dispute within the dispute lifecycle."""
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+
+    network_reason_description: Annotated[
+        Optional[str], pydantic.Field(alias="networkReasonDescription")
+    ] = None
+    r"""Provides detail on the card network's categorization of the dispute."""

moovio_sdk/models/components/disputeevidenceresponse.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .evidencetype import EvidenceType
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class DisputeEvidenceResponseTypedDict(TypedDict):
+    evidence_id: str
+    dispute_id: str
+    evidence_type: EvidenceType
+    created_on: datetime
+    updated_on: datetime
+    text: NotRequired[str]
+    r"""For text evidence, the text submitted as evidence."""
+    mime_type: NotRequired[str]
+    r"""For file evidence, the MIME type of the file."""
+    filename: NotRequired[str]
+    r"""For file evidence, the name of the file."""
+    size: NotRequired[int]
+    r"""For file evidence, the size of the file."""
+
+
+class DisputeEvidenceResponse(BaseModel):
+    evidence_id: Annotated[str, pydantic.Field(alias="evidenceID")]
+
+    dispute_id: Annotated[str, pydantic.Field(alias="disputeID")]
+
+    evidence_type: Annotated[EvidenceType, pydantic.Field(alias="evidenceType")]
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+
+    updated_on: Annotated[datetime, pydantic.Field(alias="updatedOn")]
+
+    text: Optional[str] = None
+    r"""For text evidence, the text submitted as evidence."""
+
+    mime_type: Annotated[Optional[str], pydantic.Field(alias="mimeType")] = None
+    r"""For file evidence, the MIME type of the file."""
+
+    filename: Optional[str] = None
+    r"""For file evidence, the name of the file."""
+
+    size: Optional[int] = None
+    r"""For file evidence, the size of the file."""

moovio_sdk/models/components/disputephase.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DisputePhase(str, Enum):
+    r"""The phase of a dispute within the dispute lifecycle."""
+
+    PRE_DISPUTE = "pre-dispute"
+    INQUIRY = "inquiry"
+    CHARGEBACK = "chargeback"
+    UNKNOWN = "unknown"

moovio_sdk/models/components/disputestatus.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DisputeStatus(str, Enum):
+    r"""The status of a particular dispute.
+
+    Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/#dispute-statuses) to learn what each status means.
+    """
+
+    RESPONSE_NEEDED = "response-needed"
+    RESOLVED = "resolved"
+    UNDER_REVIEW = "under-review"
+    CLOSED = "closed"
+    ACCEPTED = "accepted"
+    EXPIRED = "expired"
+    WON = "won"
+    LOST = "lost"

moovio_sdk/models/components/disputetransferdetails.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 DisputeTransferDetailsTypedDict(TypedDict):
+    transfer_id: str
+    r"""The disputed transfer's ID."""
+
+
+class DisputeTransferDetails(BaseModel):
+    transfer_id: Annotated[str, pydantic.Field(alias="transferID")]
+    r"""The disputed transfer's ID."""

moovio_sdk/models/components/document.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .documenttype import DocumentType
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class DocumentTypedDict(TypedDict):
+    document_id: str
+    type: DocumentType
+    r"""Types of documents that can be uploaded."""
+    content_type: str
+    r"""The document's MIME type."""
+    uploaded_at: datetime
+    parse_errors: NotRequired[List[str]]
+    r"""Optional array of errors encountered during automated parsing."""
+
+
+class Document(BaseModel):
+    document_id: Annotated[str, pydantic.Field(alias="documentID")]
+
+    type: DocumentType
+    r"""Types of documents that can be uploaded."""
+
+    content_type: Annotated[str, pydantic.Field(alias="contentType")]
+    r"""The document's MIME type."""
+
+    uploaded_at: Annotated[datetime, pydantic.Field(alias="uploadedAt")]
+
+    parse_errors: Annotated[
+        Optional[List[str]], pydantic.Field(alias="parseErrors")
+    ] = None
+    r"""Optional array of errors encountered during automated parsing."""

moovio_sdk/models/components/documenttype.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DocumentType(str, Enum):
+    r"""Types of documents that can be uploaded."""
+
+    DRIVERS_LICENSE = "driversLicense"
+    PASSPORT = "passport"
+    UTILITY_BILL = "utilityBill"
+    BANK_STATEMENT = "bankStatement"

moovio_sdk/models/components/domesticpullfromcard.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DomesticPullFromCard(str, Enum):
+    r"""Indicates if the card supports domestic pull-from-card transfer."""
+
+    NOT_SUPPORTED = "not-supported"
+    SUPPORTED = "supported"
+    UNKNOWN = "unknown"

moovio_sdk/models/components/domesticpushtocard.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class DomesticPushToCard(str, Enum):
+    r"""Indicates which level of domestic push-to-card transfer is supported by the card, if any."""
+
+    NOT_SUPPORTED = "not-supported"
+    STANDARD = "standard"
+    FAST_FUNDS = "fast-funds"
+    UNKNOWN = "unknown"

moovio_sdk/models/components/e2eetoken.py

@@ -0,0 +1,25 @@
+"""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 E2EETokenTypedDict(TypedDict):
+    r"""Wraps a compact-serialized JSON Web Encryption (JWE) token used for secure transmission of sensitive data (e.g., PCI information) through intermediaries.
+    This token is encrypted using the public key from /end-to-end-keys and wraps an AES key. For details and examples, refer to our
+    [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
+    """
+
+    token: str
+    r"""An [RFC](https://datatracker.ietf.org/doc/html/rfc7516) compact-serialized JSON Web Encryption (JWE) token."""
+
+
+class E2EEToken(BaseModel):
+    r"""Wraps a compact-serialized JSON Web Encryption (JWE) token used for secure transmission of sensitive data (e.g., PCI information) through intermediaries.
+    This token is encrypted using the public key from /end-to-end-keys and wraps an AES key. For details and examples, refer to our
+    [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
+    """
+
+    token: str
+    r"""An [RFC](https://datatracker.ietf.org/doc/html/rfc7516) compact-serialized JSON Web Encryption (JWE) token."""

moovio_sdk/models/components/e2eetokenupdate.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
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class E2EETokenUpdateTypedDict(TypedDict):
+    r"""Wraps a compact-serialized JSON Web Encryption (JWE) token used for secure transmission of sensitive data (e.g., PCI information) through intermediaries.
+    This token is encrypted using the public key from /end-to-end-keys and wraps an AES key. For details and examples, refer to our
+    [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
+    """
+
+    token: NotRequired[str]
+    r"""An [RFC](https://datatracker.ietf.org/doc/html/rfc7516) compact-serialized JSON Web Encryption (JWE) token."""
+
+
+class E2EETokenUpdate(BaseModel):
+    r"""Wraps a compact-serialized JSON Web Encryption (JWE) token used for secure transmission of sensitive data (e.g., PCI information) through intermediaries.
+    This token is encrypted using the public key from /end-to-end-keys and wraps an AES key. For details and examples, refer to our
+    [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
+    """
+
+    token: Optional[str] = None
+    r"""An [RFC](https://datatracker.ietf.org/doc/html/rfc7516) compact-serialized JSON Web Encryption (JWE) token."""

moovio_sdk/models/components/end2endencryptionerror.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 Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class End2EndEncryptionErrorTypedDict(TypedDict):
+    token: NotRequired[str]
+
+
+class End2EndEncryptionError(BaseModel):
+    token: Optional[str] = None

moovio_sdk/models/components/enrichedaddressresponse.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .addresssuggestion import AddressSuggestion, AddressSuggestionTypedDict
+from moovio_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class EnrichedAddressResponseTypedDict(TypedDict):
+    suggestions: List[AddressSuggestionTypedDict]
+
+
+class EnrichedAddressResponse(BaseModel):
+    suggestions: List[AddressSuggestion]

moovio_sdk/models/components/enrichedbusinessprofile.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .address import Address, AddressTypedDict
+from .enrichedindustrycodes import EnrichedIndustryCodes, EnrichedIndustryCodesTypedDict
+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 EnrichedBusinessProfileTypedDict(TypedDict):
+    address: NotRequired[AddressTypedDict]
+    email: NotRequired[str]
+    industry_codes: NotRequired[EnrichedIndustryCodesTypedDict]
+    legal_business_name: NotRequired[str]
+    phone: NotRequired[PhoneNumberTypedDict]
+    website: NotRequired[str]
+
+
+class EnrichedBusinessProfile(BaseModel):
+    address: Optional[Address] = None
+
+    email: Optional[str] = None
+
+    industry_codes: Annotated[
+        Optional[EnrichedIndustryCodes], pydantic.Field(alias="industryCodes")
+    ] = None
+
+    legal_business_name: Annotated[
+        Optional[str], pydantic.Field(alias="legalBusinessName")
+    ] = None
+
+    phone: Optional[PhoneNumber] = None
+
+    website: Optional[str] = None

moovio_sdk/models/components/enrichedbusinessresponse.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .enrichedbusinessprofile import (
+    EnrichedBusinessProfile,
+    EnrichedBusinessProfileTypedDict,
+)
+from moovio_sdk.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class EnrichedBusinessResponseTypedDict(TypedDict):
+    business: NotRequired[EnrichedBusinessProfileTypedDict]
+
+
+class EnrichedBusinessResponse(BaseModel):
+    business: Optional[EnrichedBusinessProfile] = None

moovio_sdk/models/components/enrichedindustries.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .enrichedindustry import EnrichedIndustry, EnrichedIndustryTypedDict
+from moovio_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class EnrichedIndustriesTypedDict(TypedDict):
+    industries: List[EnrichedIndustryTypedDict]
+
+
+class EnrichedIndustries(BaseModel):
+    industries: List[EnrichedIndustry]

moovio_sdk/models/components/enrichedindustry.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
+from typing_extensions import TypedDict
+
+
+class EnrichedIndustryTypedDict(TypedDict):
+    r"""An industry's MCC/SIC/NAICS codes, along with descriptive title."""
+
+    title: str
+    naics: str
+    r"""North American Industry Classification System"""
+    sic: str
+    r"""Standard Industrial Classification"""
+    mcc: str
+    r"""Merchant Category Code"""
+
+
+class EnrichedIndustry(BaseModel):
+    r"""An industry's MCC/SIC/NAICS codes, along with descriptive title."""
+
+    title: str
+
+    naics: str
+    r"""North American Industry Classification System"""
+
+    sic: str
+    r"""Standard Industrial Classification"""
+
+    mcc: str
+    r"""Merchant Category Code"""

moovio_sdk/models/components/enrichedindustrycodes.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 EnrichedIndustryCodesTypedDict(TypedDict):
+    naics: NotRequired[str]
+    sic: NotRequired[str]
+
+
+class EnrichedIndustryCodes(BaseModel):
+    naics: Optional[str] = None
+
+    sic: Optional[str] = None

moovio_sdk/models/components/evidencetextresponse.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .evidencetype import EvidenceType
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class EvidenceTextResponseTypedDict(TypedDict):
+    evidence_id: str
+    dispute_id: str
+    evidence_type: EvidenceType
+    text: str
+    created_on: datetime
+
+
+class EvidenceTextResponse(BaseModel):
+    evidence_id: Annotated[str, pydantic.Field(alias="evidenceID")]
+
+    dispute_id: Annotated[str, pydantic.Field(alias="disputeID")]
+
+    evidence_type: Annotated[EvidenceType, pydantic.Field(alias="evidenceType")]
+
+    text: str
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]

moovio_sdk/models/components/evidencetype.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class EvidenceType(str, Enum):
+    RECEIPT = "receipt"
+    PROOF_OF_DELIVERY = "proof-of-delivery"
+    CANCELATION_POLICY = "cancelation-policy"
+    TERMS_OF_SERVICE = "terms-of-service"
+    CUSTOMER_COMMUNICATION = "customer-communication"
+    GENERIC_EVIDENCE = "generic-evidence"
+    COVER_LETTER = "cover-letter"
+    OTHER = "other"

moovio_sdk/models/components/evidenceuploadresponse.py

@@ -0,0 +1,50 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .evidencetype import EvidenceType
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class EvidenceUploadResponseTypedDict(TypedDict):
+    r"""Details of a successfully uploaded evidence file."""
+
+    evidence_id: str
+    r"""The ID of the evidence."""
+    dispute_id: str
+    r"""The ID of the dispute the evidence is associated with."""
+    filename: str
+    r"""The name of the evidence file."""
+    mime_type: str
+    r"""The MIME type of the evidence file."""
+    size: int
+    r"""The size of the evidence file."""
+    evidence_type: EvidenceType
+    created_on: datetime
+    r"""The date and time the evidence was uploaded."""
+
+
+class EvidenceUploadResponse(BaseModel):
+    r"""Details of a successfully uploaded evidence file."""
+
+    evidence_id: Annotated[str, pydantic.Field(alias="evidenceID")]
+    r"""The ID of the evidence."""
+
+    dispute_id: Annotated[str, pydantic.Field(alias="disputeID")]
+    r"""The ID of the dispute the evidence is associated with."""
+
+    filename: str
+    r"""The name of the evidence file."""
+
+    mime_type: Annotated[str, pydantic.Field(alias="mimeType")]
+    r"""The MIME type of the evidence file."""
+
+    size: int
+    r"""The size of the evidence file."""
+
+    evidence_type: Annotated[EvidenceType, pydantic.Field(alias="evidenceType")]
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+    r"""The date and time the evidence was uploaded."""