moovio_sdk 0.3.8__py3-none-any.whl

moovio_sdk/models/components/moovfeedetails.py

@@ -0,0 +1,36 @@
+"""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 MoovFeeDetailsTypedDict(TypedDict):
+    r"""Processing and pass-through costs that add up to the moovFee."""
+
+    moov_processing: str
+    r"""Moov processing fee. String type represents dollars with up to 9 decimal place precision."""
+    card_scheme: NotRequired[str]
+    r"""Card scheme fees accrued during authorization and settlement. String type represents dollars with up to 9 decimal place precision."""
+    interchange: NotRequired[str]
+    r"""Network interchange fee for Visa, Mastercard, or Discover. String type represents dollars with up to 9 decimal place precision."""
+    discount: NotRequired[str]
+    r"""Network discount fee for American Express. String type represents dollars with up to 9 decimal place precision."""
+
+
+class MoovFeeDetails(BaseModel):
+    r"""Processing and pass-through costs that add up to the moovFee."""
+
+    moov_processing: Annotated[str, pydantic.Field(alias="moovProcessing")]
+    r"""Moov processing fee. String type represents dollars with up to 9 decimal place precision."""
+
+    card_scheme: Annotated[Optional[str], pydantic.Field(alias="cardScheme")] = None
+    r"""Card scheme fees accrued during authorization and settlement. String type represents dollars with up to 9 decimal place precision."""
+
+    interchange: Optional[str] = None
+    r"""Network interchange fee for Visa, Mastercard, or Discover. String type represents dollars with up to 9 decimal place precision."""
+
+    discount: Optional[str] = None
+    r"""Network discount fee for American Express. String type represents dollars with up to 9 decimal place precision."""

moovio_sdk/models/components/moovwalletpaymentmethod.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paymentmethodswallet import PaymentMethodsWallet, PaymentMethodsWalletTypedDict
+from enum import Enum
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class MoovWalletPaymentMethodPaymentMethodType(str, Enum):
+    MOOV_WALLET = "moov-wallet"
+
+
+class MoovWalletPaymentMethodTypedDict(TypedDict):
+    payment_method_id: str
+    r"""ID of the payment method."""
+    payment_method_type: MoovWalletPaymentMethodPaymentMethodType
+    wallet: PaymentMethodsWalletTypedDict
+
+
+class MoovWalletPaymentMethod(BaseModel):
+    payment_method_id: Annotated[str, pydantic.Field(alias="paymentMethodID")]
+    r"""ID of the payment method."""
+
+    payment_method_type: Annotated[
+        MoovWalletPaymentMethodPaymentMethodType,
+        pydantic.Field(alias="paymentMethodType"),
+    ]
+
+    wallet: PaymentMethodsWallet

moovio_sdk/models/components/mxauthorizationcode.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 MXAuthorizationCodeTypedDict(TypedDict):
+    r"""The authorization code of a MX account which allows a processor to retrieve a linked payment account.
+
+    `sandbox` - When linking a bank account to a `sandbox` account using a MX authorization code it will utilize MX's sandbox environment.
+    The MX authorization code provided must be generated from MX's sandbox environment.
+    """
+
+    authorization_code: str
+
+
+class MXAuthorizationCode(BaseModel):
+    r"""The authorization code of a MX account which allows a processor to retrieve a linked payment account.
+
+    `sandbox` - When linking a bank account to a `sandbox` account using a MX authorization code it will utilize MX's sandbox environment.
+    The MX authorization code provided must be generated from MX's sandbox environment.
+    """
+
+    authorization_code: Annotated[str, pydantic.Field(alias="authorizationCode")]

moovio_sdk/models/components/mxpayload.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mxauthorizationcode import MXAuthorizationCode, MXAuthorizationCodeTypedDict
+from moovio_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class MxPayloadTypedDict(TypedDict):
+    r"""Describes the account to link to the Moov account using a MX processor token.
+
+    `sandbox` - When linking a bank account to a `sandbox` account using an MX authorization token a default bank account routing number will
+    be used. The following default data will be used to generate the bank account in this flow:
+
+    ```
+    RoutingNumber: \"123456780\",
+    BankName: \"Gringotts Bank\"
+    ```
+    """
+
+    mx: MXAuthorizationCodeTypedDict
+    r"""The authorization code of a MX account which allows a processor to retrieve a linked payment account.
+
+    `sandbox` - When linking a bank account to a `sandbox` account using a MX authorization code it will utilize MX's sandbox environment.
+    The MX authorization code provided must be generated from MX's sandbox environment.
+    """
+
+
+class MxPayload(BaseModel):
+    r"""Describes the account to link to the Moov account using a MX processor token.
+
+    `sandbox` - When linking a bank account to a `sandbox` account using an MX authorization token a default bank account routing number will
+    be used. The following default data will be used to generate the bank account in this flow:
+
+    ```
+    RoutingNumber: \"123456780\",
+    BankName: \"Gringotts Bank\"
+    ```
+    """
+
+    mx: MXAuthorizationCode
+    r"""The authorization code of a MX account which allows a processor to retrieve a linked payment account.
+
+    `sandbox` - When linking a bank account to a `sandbox` account using a MX authorization code it will utilize MX's sandbox environment.
+    The MX authorization code provided must be generated from MX's sandbox environment.
+    """

moovio_sdk/models/components/occurrence.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .runtransfer import RunTransfer, RunTransferTypedDict
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OccurrenceTypedDict(TypedDict):
+    r"""Occurrences to either create or modify."""
+
+    canceled: NotRequired[bool]
+    r"""If set to true, will cancel the occurrence. If set false will resume the occurrence. If unset leaves the value unchanged."""
+    occurrence_id: NotRequired[str]
+    r"""If set this defines what occurrence to modify, if invalid will fail the request.
+    If null or \"\" it defines to add a new occurrence.
+    """
+    run_on: NotRequired[datetime]
+    r"""Timestamp to run the transfer after. Value must be into the future."""
+    run_transfer: NotRequired[RunTransferTypedDict]
+    r"""Defines the attributes of a transfer."""
+
+
+class Occurrence(BaseModel):
+    r"""Occurrences to either create or modify."""
+
+    canceled: Optional[bool] = None
+    r"""If set to true, will cancel the occurrence. If set false will resume the occurrence. If unset leaves the value unchanged."""
+
+    occurrence_id: Annotated[Optional[str], pydantic.Field(alias="occurrenceID")] = None
+    r"""If set this defines what occurrence to modify, if invalid will fail the request.
+    If null or \"\" it defines to add a new occurrence.
+    """
+
+    run_on: Annotated[Optional[datetime], pydantic.Field(alias="runOn")] = None
+    r"""Timestamp to run the transfer after. Value must be into the future."""
+
+    run_transfer: Annotated[
+        Optional[RunTransfer], pydantic.Field(alias="runTransfer")
+    ] = None
+    r"""Defines the attributes of a transfer."""

moovio_sdk/models/components/occurrencesresponse.py

@@ -0,0 +1,80 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mode import Mode
+from .occurrencestatus import OccurrenceStatus
+from .runtransfer import RunTransfer, RunTransferTypedDict
+from datetime import datetime
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ErrorTypedDict(TypedDict):
+    r"""Contains details on why the occurrence errored."""
+
+    message: NotRequired[str]
+
+
+class Error(BaseModel):
+    r"""Contains details on why the occurrence errored."""
+
+    message: Optional[str] = None
+
+
+class OccurrencesResponseTypedDict(TypedDict):
+    run_on: datetime
+    run_transfer: RunTransferTypedDict
+    r"""Defines the attributes of a transfer."""
+    schedule_id: NotRequired[str]
+    occurrence_id: NotRequired[str]
+    mode: NotRequired[Mode]
+    r"""Sandbox or production account mode of this schedule."""
+    generated: NotRequired[bool]
+    r"""True if this was generated by a RRule."""
+    indefinite: NotRequired[bool]
+    r"""True if the RRule set runs indefinitely."""
+    canceled_on: NotRequired[datetime]
+    ran_on: NotRequired[datetime]
+    ran_transfer_id: NotRequired[str]
+    status: NotRequired[OccurrenceStatus]
+    r"""Status of the completed occurrence."""
+    error: NotRequired[ErrorTypedDict]
+    r"""Contains details on why the occurrence errored."""
+
+
+class OccurrencesResponse(BaseModel):
+    run_on: Annotated[datetime, pydantic.Field(alias="runOn")]
+
+    run_transfer: Annotated[RunTransfer, pydantic.Field(alias="runTransfer")]
+    r"""Defines the attributes of a transfer."""
+
+    schedule_id: Annotated[Optional[str], pydantic.Field(alias="scheduleID")] = None
+
+    occurrence_id: Annotated[Optional[str], pydantic.Field(alias="occurrenceID")] = None
+
+    mode: Optional[Mode] = None
+    r"""Sandbox or production account mode of this schedule."""
+
+    generated: Optional[bool] = None
+    r"""True if this was generated by a RRule."""
+
+    indefinite: Optional[bool] = None
+    r"""True if the RRule set runs indefinitely."""
+
+    canceled_on: Annotated[Optional[datetime], pydantic.Field(alias="canceledOn")] = (
+        None
+    )
+
+    ran_on: Annotated[Optional[datetime], pydantic.Field(alias="ranOn")] = None
+
+    ran_transfer_id: Annotated[Optional[str], pydantic.Field(alias="ranTransferID")] = (
+        None
+    )
+
+    status: Optional[OccurrenceStatus] = None
+    r"""Status of the completed occurrence."""
+
+    error: Optional[Error] = None
+    r"""Contains details on why the occurrence errored."""

moovio_sdk/models/components/occurrencestatus.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class OccurrenceStatus(str, Enum):
+    r"""Status of the completed occurrence."""
+
+    PENDING = "pending"
+    FAILED = "failed"
+    COMPLETED = "completed"

moovio_sdk/models/components/onboardinginvite.py

@@ -0,0 +1,91 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .applicationscope import ApplicationScope
+from .capabilityid import CapabilityID
+from .createaccount import CreateAccount, CreateAccountTypedDict
+from .onboardingpartneraccount import (
+    OnboardingPartnerAccount,
+    OnboardingPartnerAccountTypedDict,
+)
+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 OnboardingInviteTypedDict(TypedDict):
+    code: str
+    r"""A unique code that identifies an onboarding invite."""
+    link: str
+    r"""A unique URL, including the invite code, that the recipient can follow to redeem the invitation."""
+    scopes: List[ApplicationScope]
+    r"""List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this
+    account. These values are used to determine what can be done with the account onboarded.
+    """
+    capabilities: List[CapabilityID]
+    r"""List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this
+    account. These values are used to determine what information to collect from the user during onboarding.
+    """
+    fee_plan_codes: List[str]
+    r"""List of fee plan codes to assign the account created by the invitee."""
+    created_on: datetime
+    return_url: NotRequired[str]
+    r"""The scopes requested by the inviter."""
+    terms_of_service_url: NotRequired[str]
+    r"""The terms of service URL set by the inviter."""
+    redeemed_account_id: NotRequired[str]
+    r"""The account ID of the account that redeemed the invite."""
+    prefill: NotRequired[CreateAccountTypedDict]
+    partner: NotRequired[OnboardingPartnerAccountTypedDict]
+    r"""The account that created the onboarding invite."""
+    revoked_on: NotRequired[datetime]
+    redeemed_on: NotRequired[datetime]
+
+
+class OnboardingInvite(BaseModel):
+    code: str
+    r"""A unique code that identifies an onboarding invite."""
+
+    link: str
+    r"""A unique URL, including the invite code, that the recipient can follow to redeem the invitation."""
+
+    scopes: List[ApplicationScope]
+    r"""List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this
+    account. These values are used to determine what can be done with the account onboarded.
+    """
+
+    capabilities: List[CapabilityID]
+    r"""List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this
+    account. These values are used to determine what information to collect from the user during onboarding.
+    """
+
+    fee_plan_codes: Annotated[List[str], pydantic.Field(alias="feePlanCodes")]
+    r"""List of fee plan codes to assign the account created by the invitee."""
+
+    created_on: Annotated[datetime, pydantic.Field(alias="createdOn")]
+
+    return_url: Annotated[Optional[str], pydantic.Field(alias="returnURL")] = None
+    r"""The scopes requested by the inviter."""
+
+    terms_of_service_url: Annotated[
+        Optional[str], pydantic.Field(alias="termsOfServiceURL")
+    ] = None
+    r"""The terms of service URL set by the inviter."""
+
+    redeemed_account_id: Annotated[
+        Optional[str], pydantic.Field(alias="redeemedAccountID")
+    ] = None
+    r"""The account ID of the account that redeemed the invite."""
+
+    prefill: Optional[CreateAccount] = None
+
+    partner: Optional[OnboardingPartnerAccount] = None
+    r"""The account that created the onboarding invite."""
+
+    revoked_on: Annotated[Optional[datetime], pydantic.Field(alias="revokedOn")] = None
+
+    redeemed_on: Annotated[Optional[datetime], pydantic.Field(alias="redeemedOn")] = (
+        None
+    )

moovio_sdk/models/components/onboardinginviterequest.py

@@ -0,0 +1,57 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .applicationscope import ApplicationScope
+from .capabilityid import CapabilityID
+from .createaccount import CreateAccount, CreateAccountTypedDict
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OnboardingInviteRequestTypedDict(TypedDict):
+    r"""Request to create an onboarding invite."""
+
+    scopes: List[ApplicationScope]
+    r"""List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this
+    account. These values are used to determine what can be done with the account onboarded.
+    """
+    capabilities: List[CapabilityID]
+    r"""List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this
+    account. These values are used to determine what information to collect from the user during onboarding.
+    """
+    fee_plan_codes: List[str]
+    r"""List of fee plan codes to assign the account created by the invitee."""
+    return_url: NotRequired[str]
+    r"""Optional URL to redirect the user to after they complete the onboarding process."""
+    terms_of_service_url: NotRequired[str]
+    r"""Optional URL to your organization's terms of service."""
+    prefill: NotRequired[CreateAccountTypedDict]
+
+
+class OnboardingInviteRequest(BaseModel):
+    r"""Request to create an onboarding invite."""
+
+    scopes: List[ApplicationScope]
+    r"""List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this
+    account. These values are used to determine what can be done with the account onboarded.
+    """
+
+    capabilities: List[CapabilityID]
+    r"""List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this
+    account. These values are used to determine what information to collect from the user during onboarding.
+    """
+
+    fee_plan_codes: Annotated[List[str], pydantic.Field(alias="feePlanCodes")]
+    r"""List of fee plan codes to assign the account created by the invitee."""
+
+    return_url: Annotated[Optional[str], pydantic.Field(alias="returnURL")] = None
+    r"""Optional URL to redirect the user to after they complete the onboarding process."""
+
+    terms_of_service_url: Annotated[
+        Optional[str], pydantic.Field(alias="termsOfServiceURL")
+    ] = None
+    r"""Optional URL to your organization's terms of service."""
+
+    prefill: Optional[CreateAccount] = None

moovio_sdk/models/components/onboardingpartneraccount.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mode import Mode
+from moovio_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class OnboardingPartnerAccountTypedDict(TypedDict):
+    r"""The account that created the onboarding invite."""
+
+    account_id: str
+    r"""The account ID of the partner that created the invite."""
+    account_mode: Mode
+    r"""The operating mode for an account."""
+    display_name: str
+    r"""The name of the Moov account used to create the onboarding invite."""
+
+
+class OnboardingPartnerAccount(BaseModel):
+    r"""The account that created the onboarding invite."""
+
+    account_id: Annotated[str, pydantic.Field(alias="accountID")]
+    r"""The account ID of the partner that created the invite."""
+
+    account_mode: Annotated[Mode, pydantic.Field(alias="accountMode")]
+    r"""The operating mode for an account."""
+
+    display_name: Annotated[str, pydantic.Field(alias="displayName")]
+    r"""The name of the Moov account used to create the onboarding invite."""

moovio_sdk/models/components/partnerpricing.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .billablefee import BillableFee, BillableFeeTypedDict
+from .cardacquiringmodel import CardAcquiringModel
+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 PartnerPricingTypedDict(TypedDict):
+    plan_id: str
+    name: str
+    r"""The name of the fee plan."""
+    revenue_share: int
+    r"""The integer percentage value of the revenue split for partner."""
+    card_acquiring_model: CardAcquiringModel
+    r"""Specifies the card processing pricing model"""
+    billable_fees: List[BillableFeeTypedDict]
+    created_at: datetime
+    description: NotRequired[str]
+    r"""A description of the fee plan."""
+
+
+class PartnerPricing(BaseModel):
+    plan_id: Annotated[str, pydantic.Field(alias="planID")]
+
+    name: str
+    r"""The name of the fee plan."""
+
+    revenue_share: Annotated[int, pydantic.Field(alias="revenueShare")]
+    r"""The integer percentage value of the revenue split for partner."""
+
+    card_acquiring_model: Annotated[
+        CardAcquiringModel, pydantic.Field(alias="cardAcquiringModel")
+    ]
+    r"""Specifies the card processing pricing model"""
+
+    billable_fees: Annotated[List[BillableFee], pydantic.Field(alias="billableFees")]
+
+    created_at: Annotated[datetime, pydantic.Field(alias="createdAt")]
+
+    description: Optional[str] = None
+    r"""A description of the fee plan."""

moovio_sdk/models/components/partnerpricingagreement.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .billablefee import BillableFee, BillableFeeTypedDict
+from .cardacquiringmodel import CardAcquiringModel
+from .feeplanagreementstatus import FeePlanAgreementStatus
+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 PartnerPricingAgreementTypedDict(TypedDict):
+    agreement_id: str
+    plan_id: str
+    name: str
+    r"""The name of the agreement."""
+    accepted_on: datetime
+    status: FeePlanAgreementStatus
+    card_acquiring_model: CardAcquiringModel
+    r"""Specifies the card processing pricing model"""
+    billable_fees: List[BillableFeeTypedDict]
+    revenue_share: int
+    r"""The integer percentage value of the revenue split for partner."""
+    account_id: NotRequired[str]
+    description: NotRequired[str]
+    r"""The description of the agreement."""
+
+
+class PartnerPricingAgreement(BaseModel):
+    agreement_id: Annotated[str, pydantic.Field(alias="agreementID")]
+
+    plan_id: Annotated[str, pydantic.Field(alias="planID")]
+
+    name: str
+    r"""The name of the agreement."""
+
+    accepted_on: Annotated[datetime, pydantic.Field(alias="acceptedOn")]
+
+    status: FeePlanAgreementStatus
+
+    card_acquiring_model: Annotated[
+        CardAcquiringModel, pydantic.Field(alias="cardAcquiringModel")
+    ]
+    r"""Specifies the card processing pricing model"""
+
+    billable_fees: Annotated[List[BillableFee], pydantic.Field(alias="billableFees")]
+
+    revenue_share: Annotated[int, pydantic.Field(alias="revenueShare")]
+    r"""The integer percentage value of the revenue split for partner."""
+
+    account_id: Annotated[Optional[str], pydantic.Field(alias="accountID")] = None
+
+    description: Optional[str] = None
+    r"""The description of the agreement."""