UNPKG

@mozaic-io/mozaic-sdk-node

Version:

The Mozaic Node SDK enables you to pay your creators easily via the Mozaic API.

2,441 lines 768 kB
/** * Mozaic.io API Documentation * A global payment, payout and smart contract for the Creator Economy. * * The version of the OpenAPI document: v2 * Contact: dev@jammber.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * pending accepted suspended * export * @enum {string} */ export declare const AcceptPaymentStatusEnum: { /** * */ readonly Pending: "pending"; /** * */ readonly Accepted: "accepted"; /** * */ readonly Suspended: "suspended"; }; export type AcceptPaymentStatusEnum = typeof AcceptPaymentStatusEnum[keyof typeof AcceptPaymentStatusEnum]; /** * * export * @interface AccessControlRule */ export interface AccessControlRule { /** * * @type {string} * memberof AccessControlRule */ 'AccountId'?: string | null; /** * * @type {string} * memberof AccessControlRule */ 'UserId'?: string | null; /** * * @type {string} * memberof AccessControlRule */ 'RoleName'?: string | null; /** * * @type {boolean} * memberof AccessControlRule */ 'ValueFound'?: boolean; /** * * @type {string} * memberof AccessControlRule */ 'ResourcePath'?: string | null; /** * * @type {AccessPerspective} * memberof AccessControlRule */ 'Perspective'?: AccessPerspective; /** * * @type {LicenseAssignmentStatuses} * memberof AccessControlRule */ 'LicenseStatus'?: LicenseAssignmentStatuses; /** * * @type {number} * memberof AccessControlRule */ 'ResourceAccessId'?: number; /** * * @type {string} * memberof AccessControlRule */ 'UID'?: string | null; /** * * @type {string} * memberof AccessControlRule */ 'PersonaId'?: string | null; /** * * @type {number} * memberof AccessControlRule */ 'RestrictionLevel'?: number; /** * * @type {boolean} * memberof AccessControlRule */ 'CanEdit'?: boolean; /** * * @type {boolean} * memberof AccessControlRule */ 'CanView'?: boolean; /** * * @type {boolean} * memberof AccessControlRule */ 'CanDelete'?: boolean; /** * * @type {boolean} * memberof AccessControlRule */ 'CanCreate'?: boolean; /** * * @type {boolean} * memberof AccessControlRule */ 'CanDownload'?: boolean; /** * * @type {boolean} * memberof AccessControlRule */ 'AllowSensitive'?: boolean; /** * * @type {boolean} * memberof AccessControlRule */ 'AcceptanceRequired'?: boolean; /** * * @type {string} * memberof AccessControlRule */ 'ResourceAccessUID'?: string | null; /** * * @type {boolean} * memberof AccessControlRule */ 'HasExplicitAccess'?: boolean; } /** * none self collaborators all invite admin webHook function * export * @enum {string} */ export declare const AccessPerspective: { /** * */ readonly None: "none"; /** * */ readonly Self: "self"; /** * */ readonly Collaborators: "collaborators"; /** * */ readonly All: "all"; /** * */ readonly Invite: "invite"; /** * */ readonly Admin: "admin"; /** * */ readonly WebHook: "webHook"; /** * */ readonly Function: "function"; }; export type AccessPerspective = typeof AccessPerspective[keyof typeof AccessPerspective]; /** * * export * @interface AccountSession */ export interface AccountSession { /** * * @type {string} * memberof AccountSession */ 'object'?: string | null; /** * * @type {string} * memberof AccountSession */ 'account'?: string | null; /** * * @type {string} * memberof AccountSession */ 'client_secret'?: string | null; /** * * @type {AccountSessionComponents} * memberof AccountSession */ 'components'?: AccountSessionComponents; /** * * @type {string} * memberof AccountSession */ 'expires_at'?: string; /** * * @type {boolean} * memberof AccountSession */ 'livemode'?: boolean; } /** * * export * @interface AccountSessionComponents */ export interface AccountSessionComponents { /** * * @type {AccountSessionComponentsAccountManagement} * memberof AccountSessionComponents */ 'account_management'?: AccountSessionComponentsAccountManagement; /** * * @type {AccountSessionComponentsAccountOnboarding} * memberof AccountSessionComponents */ 'account_onboarding'?: AccountSessionComponentsAccountOnboarding; /** * * @type {AccountSessionComponentsBalances} * memberof AccountSessionComponents */ 'balances'?: AccountSessionComponentsBalances; /** * * @type {AccountSessionComponentsDocuments} * memberof AccountSessionComponents */ 'documents'?: AccountSessionComponentsDocuments; /** * * @type {AccountSessionComponentsNotificationBanner} * memberof AccountSessionComponents */ 'notification_banner'?: AccountSessionComponentsNotificationBanner; /** * * @type {AccountSessionComponentsPaymentDetails} * memberof AccountSessionComponents */ 'payment_details'?: AccountSessionComponentsPaymentDetails; /** * * @type {AccountSessionComponentsPayments} * memberof AccountSessionComponents */ 'payments'?: AccountSessionComponentsPayments; /** * * @type {AccountSessionComponentsPayouts} * memberof AccountSessionComponents */ 'payouts'?: AccountSessionComponentsPayouts; /** * * @type {AccountSessionComponentsPayoutsList} * memberof AccountSessionComponents */ 'payouts_list'?: AccountSessionComponentsPayoutsList; /** * * @type {AccountSessionComponentsTaxRegistrations} * memberof AccountSessionComponents */ 'tax_registrations'?: AccountSessionComponentsTaxRegistrations; /** * * @type {AccountSessionComponentsTaxSettings} * memberof AccountSessionComponents */ 'tax_settings'?: AccountSessionComponentsTaxSettings; } /** * * export * @interface AccountSessionComponentsAccountManagement */ export interface AccountSessionComponentsAccountManagement { /** * * @type {boolean} * memberof AccountSessionComponentsAccountManagement */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsAccountManagementFeatures} * memberof AccountSessionComponentsAccountManagement */ 'features'?: AccountSessionComponentsAccountManagementFeatures; } /** * * export * @interface AccountSessionComponentsAccountManagementFeatures */ export interface AccountSessionComponentsAccountManagementFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsAccountManagementFeatures */ 'disable_stripe_user_authentication'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsAccountManagementFeatures */ 'external_account_collection'?: boolean; } /** * * export * @interface AccountSessionComponentsAccountOnboarding */ export interface AccountSessionComponentsAccountOnboarding { /** * * @type {boolean} * memberof AccountSessionComponentsAccountOnboarding */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsAccountOnboardingFeatures} * memberof AccountSessionComponentsAccountOnboarding */ 'features'?: AccountSessionComponentsAccountOnboardingFeatures; } /** * * export * @interface AccountSessionComponentsAccountOnboardingFeatures */ export interface AccountSessionComponentsAccountOnboardingFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsAccountOnboardingFeatures */ 'disable_stripe_user_authentication'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsAccountOnboardingFeatures */ 'external_account_collection'?: boolean; } /** * * export * @interface AccountSessionComponentsBalances */ export interface AccountSessionComponentsBalances { /** * * @type {boolean} * memberof AccountSessionComponentsBalances */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsBalancesFeatures} * memberof AccountSessionComponentsBalances */ 'features'?: AccountSessionComponentsBalancesFeatures; } /** * * export * @interface AccountSessionComponentsBalancesFeatures */ export interface AccountSessionComponentsBalancesFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsBalancesFeatures */ 'disable_stripe_user_authentication'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsBalancesFeatures */ 'edit_payout_schedule'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsBalancesFeatures */ 'external_account_collection'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsBalancesFeatures */ 'instant_payouts'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsBalancesFeatures */ 'standard_payouts'?: boolean; } /** * * export * @interface AccountSessionComponentsDocuments */ export interface AccountSessionComponentsDocuments { /** * * @type {boolean} * memberof AccountSessionComponentsDocuments */ 'enabled'?: boolean; /** * * @type {object} * memberof AccountSessionComponentsDocuments */ 'features'?: object; } /** * * export * @interface AccountSessionComponentsNotificationBanner */ export interface AccountSessionComponentsNotificationBanner { /** * * @type {boolean} * memberof AccountSessionComponentsNotificationBanner */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsNotificationBannerFeatures} * memberof AccountSessionComponentsNotificationBanner */ 'features'?: AccountSessionComponentsNotificationBannerFeatures; } /** * * export * @interface AccountSessionComponentsNotificationBannerFeatures */ export interface AccountSessionComponentsNotificationBannerFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsNotificationBannerFeatures */ 'disable_stripe_user_authentication'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsNotificationBannerFeatures */ 'external_account_collection'?: boolean; } /** * * export * @interface AccountSessionComponentsPaymentDetails */ export interface AccountSessionComponentsPaymentDetails { /** * * @type {boolean} * memberof AccountSessionComponentsPaymentDetails */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsPaymentDetailsFeatures} * memberof AccountSessionComponentsPaymentDetails */ 'features'?: AccountSessionComponentsPaymentDetailsFeatures; } /** * * export * @interface AccountSessionComponentsPaymentDetailsFeatures */ export interface AccountSessionComponentsPaymentDetailsFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsPaymentDetailsFeatures */ 'capture_payments'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPaymentDetailsFeatures */ 'destination_on_behalf_of_charge_management'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPaymentDetailsFeatures */ 'dispute_management'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPaymentDetailsFeatures */ 'refund_management'?: boolean; } /** * * export * @interface AccountSessionComponentsPayments */ export interface AccountSessionComponentsPayments { /** * * @type {boolean} * memberof AccountSessionComponentsPayments */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsPaymentsFeatures} * memberof AccountSessionComponentsPayments */ 'features'?: AccountSessionComponentsPaymentsFeatures; } /** * * export * @interface AccountSessionComponentsPaymentsFeatures */ export interface AccountSessionComponentsPaymentsFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsPaymentsFeatures */ 'capture_payments'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPaymentsFeatures */ 'destination_on_behalf_of_charge_management'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPaymentsFeatures */ 'dispute_management'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPaymentsFeatures */ 'refund_management'?: boolean; } /** * * export * @interface AccountSessionComponentsPayouts */ export interface AccountSessionComponentsPayouts { /** * * @type {boolean} * memberof AccountSessionComponentsPayouts */ 'enabled'?: boolean; /** * * @type {AccountSessionComponentsPayoutsFeatures} * memberof AccountSessionComponentsPayouts */ 'features'?: AccountSessionComponentsPayoutsFeatures; } /** * * export * @interface AccountSessionComponentsPayoutsFeatures */ export interface AccountSessionComponentsPayoutsFeatures { /** * * @type {boolean} * memberof AccountSessionComponentsPayoutsFeatures */ 'disable_stripe_user_authentication'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPayoutsFeatures */ 'edit_payout_schedule'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPayoutsFeatures */ 'external_account_collection'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPayoutsFeatures */ 'instant_payouts'?: boolean; /** * * @type {boolean} * memberof AccountSessionComponentsPayoutsFeatures */ 'standard_payouts'?: boolean; } /** * * export * @interface AccountSessionComponentsPayoutsList */ export interface AccountSessionComponentsPayoutsList { /** * * @type {boolean} * memberof AccountSessionComponentsPayoutsList */ 'enabled'?: boolean; /** * * @type {object} * memberof AccountSessionComponentsPayoutsList */ 'features'?: object; } /** * * export * @interface AccountSessionComponentsTaxRegistrations */ export interface AccountSessionComponentsTaxRegistrations { /** * * @type {boolean} * memberof AccountSessionComponentsTaxRegistrations */ 'enabled'?: boolean; /** * * @type {object} * memberof AccountSessionComponentsTaxRegistrations */ 'features'?: object; } /** * * export * @interface AccountSessionComponentsTaxSettings */ export interface AccountSessionComponentsTaxSettings { /** * * @type {boolean} * memberof AccountSessionComponentsTaxSettings */ 'enabled'?: boolean; /** * * @type {object} * memberof AccountSessionComponentsTaxSettings */ 'features'?: object; } /** * * export * @interface AccountUpdateEmailRequest */ export interface AccountUpdateEmailRequest { /** * * @type {string} * memberof AccountUpdateEmailRequest */ 'Email'?: string | null; /** * * @type {string} * memberof AccountUpdateEmailRequest */ 'Name'?: string | null; /** * * @type {string} * memberof AccountUpdateEmailRequest */ 'UserId'?: string | null; } /** * Contact * export * @interface AccountUserPersona */ export interface AccountUserPersona { /** * * @type {string} * memberof AccountUserPersona */ 'contact_id'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'user_account_id'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'user_id'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'known_name'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'first_name'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'last_name'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'email'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'mobile_number'?: string | null; /** * * @type {string} * memberof AccountUserPersona */ 'role'?: string | null; } /** * * export * @interface Activity */ export interface Activity { /** * id of the object this activity is associated with * @type {string} * memberof Activity */ 'key'?: string | null; /** * * @type {ActivityType} * memberof Activity */ 'type'?: ActivityType; /** * * @type {ActivityStatus} * memberof Activity */ 'status'?: ActivityStatus; /** * A short description of the activity (pulled from a resource file) * @type {string} * memberof Activity */ 'title'?: string | null; /** * A full description of the activity (pulled from a resouce file) * @type {string} * memberof Activity */ 'caption'?: string | null; /** * Id of the User associated with this Payment\'s wallet * @type {string} * memberof Activity */ 'user_id'?: string | null; /** * Id of the Persona associated with this Payment\'s wallet * @type {string} * memberof Activity */ 'persona_id'?: string | null; /** * Id of the account authorized to send payments * @type {string} * memberof Activity */ 'tenant_id'?: string | null; /** * * @type {Array<ActivityTask>} * memberof Activity */ 'tasks'?: Array<ActivityTask> | null; /** * * @type {string} * memberof Activity */ 'short_id'?: string | null; /** * * @type {string} * memberof Activity */ 'id'?: string | null; /** * The name of this object * @type {string} * memberof Activity */ 'object'?: string | null; /** * * @type {string} * memberof Activity */ 'created_at'?: string; } /** * unknown started pending completed needsAttention failed notStarted * export * @enum {string} */ export declare const ActivityStatus: { /** * */ readonly Unknown: "unknown"; /** * */ readonly Started: "started"; /** * */ readonly Pending: "pending"; /** * */ readonly Completed: "completed"; /** * */ readonly NeedsAttention: "needsAttention"; /** * */ readonly Failed: "failed"; /** * */ readonly NotStarted: "notStarted"; }; export type ActivityStatus = typeof ActivityStatus[keyof typeof ActivityStatus]; /** * * export * @interface ActivityTask */ export interface ActivityTask { /** * * @type {string} * memberof ActivityTask */ 'id'?: string | null; /** * * @type {string} * memberof ActivityTask */ 'title'?: string | null; /** * * @type {string} * memberof ActivityTask */ 'link'?: string | null; /** * * @type {ActivityTaskStatus} * memberof ActivityTask */ 'status'?: ActivityTaskStatus; /** * * @type {string} * memberof ActivityTask */ 'date_completed'?: string | null; /** * * @type {string} * memberof ActivityTask */ 'short_id'?: string | null; /** * The name of this object * @type {string} * memberof ActivityTask */ 'object'?: string | null; /** * * @type {string} * memberof ActivityTask */ 'created_at'?: string; } /** * notStarted inProgress completed * export * @enum {string} */ export declare const ActivityTaskStatus: { /** * */ readonly NotStarted: "notStarted"; /** * */ readonly InProgress: "inProgress"; /** * */ readonly Completed: "completed"; }; export type ActivityTaskStatus = typeof ActivityTaskStatus[keyof typeof ActivityTaskStatus]; /** * * export * @interface ActivityTaskUpdateDeets */ export interface ActivityTaskUpdateDeets { /** * The id of the object this activity is associated with * @type {string} * memberof ActivityTaskUpdateDeets */ 'key'?: string | null; /** * * @type {ActivityType} * memberof ActivityTaskUpdateDeets */ 'type': ActivityType; /** * * @type {ActivityTaskStatus} * memberof ActivityTaskUpdateDeets */ 'status': ActivityTaskStatus; /** * Specifies the id of the activity task * @type {string} * memberof ActivityTaskUpdateDeets */ 'task_id': string; /** * The user id to operate on their behalf (tenants only) * @type {string} * memberof ActivityTaskUpdateDeets */ 'user_id'?: string | null; /** * * @type {string} * memberof ActivityTaskUpdateDeets */ 'object'?: string | null; } /** * contactCreated invited onboarded readyForPayouts firstPayout firstPayment * export * @enum {string} */ export declare const ActivityType: { /** * */ readonly ContactCreated: "contactCreated"; /** * */ readonly Invited: "invited"; /** * */ readonly Onboarded: "onboarded"; /** * */ readonly ReadyForPayouts: "readyForPayouts"; /** * */ readonly FirstPayout: "firstPayout"; /** * */ readonly FirstPayment: "firstPayment"; }; export type ActivityType = typeof ActivityType[keyof typeof ActivityType]; /** * * export * @interface AddressDeets */ export interface AddressDeets { /** * Common name of the address like Central Park, If we already have this in our db, it will pick that address by default * @type {string} * memberof AddressDeets */ 'common_name'?: string | null; /** * Address line 1 * @type {string} * memberof AddressDeets */ 'line1'?: string | null; /** * Address line 2 * @type {string} * memberof AddressDeets */ 'line2'?: string | null; /** * City name * @type {string} * memberof AddressDeets */ 'city'?: string | null; /** * Latitude and Longitude * @type {string} * memberof AddressDeets */ 'lat_long'?: string | null; /** * Postal code or ZIP code * @type {string} * memberof AddressDeets */ 'postal_code'?: string | null; /** * State, region or province * @type {string} * memberof AddressDeets */ 'state_region'?: string | null; /** * Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) * @type {string} * memberof AddressDeets */ 'country_code'?: string | null; } /** * * export * @interface Amount */ export interface Amount { /** * The currency of the amount * @type {string} * memberof Amount */ 'currency'?: string | null; /** * The id of the wallet to use. If an Wallet id is not specified the platform balance is used if the amount is less than or equal to the balance, otherwise the default Wallet for the currency will be charged * @type {string} * memberof Amount */ 'wallet_id'?: string | null; /** * The quantity of Currency to send Note that quantity is either base units or fractional depending on the currency and wallet type * @type {number} * memberof Amount */ 'quantity'?: number; /** * * @type {string} * memberof Amount */ 'localized_formatted_quantity'?: string | null; /** * The source currency of the amount. * @type {string} * memberof Amount */ 'source_currency'?: string | null; /** * The source quantity before conversion. * @type {number} * memberof Amount */ 'source_quantity'?: number; /** * The exchange rate used for the last conversion. * @type {number} * memberof Amount */ 'exchange_rate'?: number | null; /** * The date the exchange rate was applied. * @type {string} * memberof Amount */ 'rate_date'?: string | null; } /** * * export * @interface ApiKey */ export interface ApiKey { /** * * @type {string} * memberof ApiKey */ 'ClientId'?: string | null; /** * * @type {string} * memberof ApiKey */ 'ClientSecret'?: string | null; } /** * * export * @interface ApplicationUser */ export interface ApplicationUser { /** * * @type {string} * memberof ApplicationUser */ 'LastActivityDateTime'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'LastLoginDateTime'?: string | null; /** * * @type {boolean} * memberof ApplicationUser */ 'IsAutoRegistered'?: boolean; /** * * @type {boolean} * memberof ApplicationUser */ 'RequiresPassword'?: boolean; /** * * @type {string} * memberof ApplicationUser */ 'AuthObjectId'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'Id'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'UserName'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'NormalizedUserName'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'Email'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'NormalizedEmail'?: string | null; /** * * @type {boolean} * memberof ApplicationUser */ 'EmailConfirmed'?: boolean; /** * * @type {string} * memberof ApplicationUser */ 'PasswordHash'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'SecurityStamp'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'ConcurrencyStamp'?: string | null; /** * * @type {string} * memberof ApplicationUser */ 'PhoneNumber'?: string | null; /** * * @type {boolean} * memberof ApplicationUser */ 'PhoneNumberConfirmed'?: boolean; /** * * @type {boolean} * memberof ApplicationUser */ 'TwoFactorEnabled'?: boolean; /** * * @type {string} * memberof ApplicationUser */ 'LockoutEnd'?: string | null; /** * * @type {boolean} * memberof ApplicationUser */ 'LockoutEnabled'?: boolean; /** * * @type {number} * memberof ApplicationUser */ 'AccessFailedCount'?: number; } /** * development stage sandbox demo production integration * export * @enum {string} */ export declare const AspnetCoreEnvironment: { /** * */ readonly Development: "development"; /** * */ readonly Stage: "stage"; /** * */ readonly Sandbox: "sandbox"; /** * */ readonly Demo: "demo"; /** * */ readonly Production: "production"; /** * */ readonly Integration: "integration"; }; export type AspnetCoreEnvironment = typeof AspnetCoreEnvironment[keyof typeof AspnetCoreEnvironment]; /** * * export * @interface AttributionDeets */ export interface AttributionDeets { /** * The role or credit of the attribution * @type {string} * memberof AttributionDeets */ 'Role'?: string | null; /** * * @type {ContactDeets} * memberof AttributionDeets */ 'Contact'?: ContactDeets; } /** * * export * @interface Auth0OtpGenerateDeets */ export interface Auth0OtpGenerateDeets { /** * email or phone number or handle * @type {string} * memberof Auth0OtpGenerateDeets */ 'user_name'?: string | null; } /** * * export * @interface Auth0OtpGenerateResponse */ export interface Auth0OtpGenerateResponse { /** * * @type {string} * memberof Auth0OtpGenerateResponse */ '_id'?: string | null; /** * * @type {string} * memberof Auth0OtpGenerateResponse */ 'email'?: string | null; /** * * @type {boolean} * memberof Auth0OtpGenerateResponse */ 'email_verified'?: boolean; } /** * * export * @interface Auth0OtpVerifyDeets */ export interface Auth0OtpVerifyDeets { /** * email or phone number or handle * @type {string} * memberof Auth0OtpVerifyDeets */ 'user_name'?: string | null; /** * * @type {string} * memberof Auth0OtpVerifyDeets */ 'client_assertion'?: string | null; /** * * @type {string} * memberof Auth0OtpVerifyDeets */ 'verification_code'?: string | null; } /** * * export * @interface Auth0RefreshTokenRequestDeet */ export interface Auth0RefreshTokenRequestDeet { /** * * @type {string} * memberof Auth0RefreshTokenRequestDeet */ 'refresh_token': string; } /** * * export * @interface AuthLinkRequestDeet */ export interface AuthLinkRequestDeet { /** * * @type {string} * memberof AuthLinkRequestDeet */ 'refresh_url'?: string | null; /** * * @type {string} * memberof AuthLinkRequestDeet */ 'business_type'?: string | null; /** * * @type {string} * memberof AuthLinkRequestDeet */ 'country_code'?: string | null; /** * * @type {string} * memberof AuthLinkRequestDeet */ 'redirect_url'?: string | null; /** * * @type {string} * memberof AuthLinkRequestDeet */ 'object'?: string | null; } /** * * export * @interface AuthLinkResponse */ export interface AuthLinkResponse { /** * * @type {string} * memberof AuthLinkResponse */ 'link'?: string | null; } /** * * export * @interface AvatarBytes */ export interface AvatarBytes { /** * A base64 encoded byte array for the PNG image * @type {string} * memberof AvatarBytes */ 'base64_bytes'?: string | null; } /** * * export * @interface AvatarPromptCreateDeets */ export interface AvatarPromptCreateDeets { /** * * @type {string} * memberof AvatarPromptCreateDeets */ 'prompt'?: string | null; /** * The user id to operate on their behalf (tenants only) * @type {string} * memberof AvatarPromptCreateDeets */ 'user_id'?: string | null; /** * * @type {string} * memberof AvatarPromptCreateDeets */ 'object'?: string | null; } /** * * export * @interface AvatarSize */ export interface AvatarSize { /** * * @type {string} * memberof AvatarSize */ 'small'?: string | null; /** * * @type {string} * memberof AvatarSize */ 'medium'?: string | null; /** * * @type {string} * memberof AvatarSize */ 'large'?: string | null; } /** * default contact simpleContarct paymentCycle * export * @enum {string} */ export declare const AvatarType: { /** * */ readonly Default: "default"; /** * */ readonly Contact: "contact"; /** * */ readonly SimpleContarct: "simpleContarct"; /** * */ readonly PaymentCycle: "paymentCycle"; }; export type AvatarType = typeof AvatarType[keyof typeof AvatarType]; /** * contact simpleContarct paymentCycle profile * export * @enum {string} */ export declare const AvatarTypeEnum: { /** * */ readonly Contact: "contact"; /** * */ readonly SimpleContarct: "simpleContarct"; /** * */ readonly PaymentCycle: "paymentCycle"; /** * */ readonly Profile: "profile"; }; export type AvatarTypeEnum = typeof AvatarTypeEnum[keyof typeof AvatarTypeEnum]; /** * * export * @interface Balance */ export interface Balance { /** * * @type {string} * memberof Balance */ 'user_id'?: string | null; /** * * @type {number} * memberof Balance */ 'available_balance'?: number; /** * * @type {number} * memberof Balance */ 'pending_balance'?: number; /** * * @type {number} * memberof Balance */ 'processing_balance'?: number; /** * * @type {Array<BalanceEntry>} * memberof Balance */ 'available_balances'?: Array<BalanceEntry> | null; /** * * @type {Array<BalanceEntry>} * memberof Balance */ 'processing_balances'?: Array<BalanceEntry> | null; /** * * @type {Array<BalanceEntry>} * memberof Balance */ 'pending_balances'?: Array<BalanceEntry> | null; /** * * @type {Array<BalanceEntry>} * memberof Balance */ 'suspended_balances'?: Array<BalanceEntry> | null; /** * * @type {Array<BalanceEntry>} * memberof Balance */ 'bitcoin_balances'?: Array<BalanceEntry> | null; /** * * @type {string} * memberof Balance */ 'currency'?: string | null; /** * * @type {string} * memberof Balance */ 'localized_formatted_available_balance'?: string | null; /** * * @type {string} * memberof Balance */ 'localized_formatted_pending_balance'?: string | null; /** * * @type {string} * memberof Balance */ 'localized_formatted_processing_balance'?: string | null; /** * * @type {number} * memberof Balance */ 'money_in'?: number; /** * * @type {string} * memberof Balance */ 'localized_formatted_money_in'?: string | null; /** * * @type {number} * memberof Balance */ 'money_out'?: number; /** * * @type {string} * memberof Balance */ 'localized_formatted_money_out'?: string | null; /** * * @type {string} * memberof Balance */ 'tenant_id'?: string | null; /** * * @type {string} * memberof Balance */ 'short_id'?: string | null; /** * * @type {string} * memberof Balance */ 'id'?: string | null; /** * The name of this object * @type {string} * memberof Balance */ 'object'?: string | null; /** * * @type {string} * memberof Balance */ 'created_at'?: string; } /** * * export * @interface BalanceEntry */ export interface BalanceEntry { /** * * @type {number} * memberof BalanceEntry */ 'money_in'?: number; /** * * @type {string} * memberof BalanceEntry */ 'localized_formatted_money_in'?: string | null; /** * * @type {number} * memberof BalanceEntry */ 'money_out'?: number; /** * * @type {string} * memberof BalanceEntry */ 'localized_formatted_money_out'?: string | null; /** * The source currency of the amount. * @type {string} * memberof BalanceEntry */ 'source_currency'?: string | null; /** * The source quantity before conversion. * @type {number} * memberof BalanceEntry */ 'source_quantity'?: number; /** * The exchange rate used for the last conversion. * @type {number} * memberof BalanceEntry */ 'exchange_rate'?: number | null; /** * The date the exchange rate was applied. * @type {string} * memberof BalanceEntry */ 'rate_date'?: string | null; /** * The currency of the amount * @type {string} * memberof BalanceEntry */ 'currency'?: string | null; /** * The id of the wallet to use. If an Wallet id is not specified the platform balance is used if the amount is less than or equal to the balance, otherwise the default Wallet for the currency will be charged * @type {string} * memberof BalanceEntry */ 'wallet_id'?: string | null; /** * The quantity of Currency to send Note that quantity is either base units or fractional depending on the currency and wallet type * @type {number} * memberof BalanceEntry */ 'quantity'?: number; /** * * @type {string} * memberof BalanceEntry */ 'localized_formatted_quantity'?: string | null; } /** * * export * @interface BaseError */ export interface BaseError { /** * The error message * @type {string} * memberof BaseError */ 'message'?: string | null; /** * The error code * @type {number} * memberof BaseError */ 'code'?: number; /** * The name of this object * @type {string} * memberof BaseError */ 'object'?: string | null; } /** * * export * @interface BaseTerms */ export interface BaseTerms { /** * * @type {string} * memberof BaseTerms */ '$entity'?: string | null; /** * * @type {string} * memberof BaseTerms */ 'id'?: string | null; /** * * @type {string} * memberof BaseTerms */ 'description'?: string | null; /** * * @type {TermHeader} * memberof BaseTerms */ 'header'?: TermHeader; /** * * @type {TermScope} * memberof BaseTerms */ 'scope'?: TermScope; /** * * @type {PayoutTerm} * memberof BaseTerms */ 'payout'?: PayoutTerm; /** * * @type {{ [key: string]: string | null; }} * memberof BaseTerms */ 'meta_data'?: { [key: string]: string | null; } | null; /** * * @type {Array<BaseTermsDescendentsInner>} * memberof BaseTerms */ 'descendents'?: Array<BaseTermsDescendentsInner> | null; /** * * @type {TermBalance} * memberof BaseTerms */ 'previous_balance'?: TermBalance; } /** * @type BaseTermsDescendentsInner * export */ export type BaseTermsDescendentsInner = BaseTerms | FlatAmountTerm | FlatRateTerm | Income | RecoupableTerm | TieredTerm | TieredTermTieredGroupTerm; /** * A lightweight object for specifying \'to\' and \'from\' addresses and other forms of general contact * export * @interface BasicContact */ export interface BasicContact { /** * The Mozaic handle for a contact * @type {string} * memberof BasicContact */ 'handle'?: string | null; /** * The email address of the contact * @type {string} * memberof BasicContact */ 'email'?: string | null; /** * The fully qualified phone number of the contact * @type {string} * memberof BasicContact */ 'phone'?: string | null; /** * Loosely, the name of the contact. May be changed during registration * @type {string} * memberof BasicContact */ 'name': string; /** * Specifies the persona associated with this contact record * @type {string} * memberof BasicContact */ 'persona_id'?: string | null; /** * Specifies the user associated with this contact record * @type {string} * memberof BasicContact */ 'user_id'?: string | null; /** * Specifies the user account id associated with this contact record * @type {string} * memberof BasicContact */ 'user_account_id'?: string | null; /** * Specifies whether this contact is in network or out of network * @type {boolean} * memberof BasicContact */ 'is_accepted_contact'?: boolean; /** * * @type {string} * memberof BasicContact */ 'country_code'?: string | null; /** * * @type {string} * memberof BasicContact */ 'external_id'?: string | null; /** * contact avatar * @type {Array<AvatarSize>} * memberof BasicContact */ 'avatar'?: Array<AvatarSize> | null; /** * * @type {string} * memberof BasicContact */ 'short_id'?: string | null; /** * * @type {string} * memberof BasicContact */ 'id'?: string | null; /** * The name of this object * @type {string} * memberof BasicContact */ 'object'?: string | null; /** * * @type {string} * memberof BasicContact */ 'created_at'?: string; } /** * A lightweight object for specifying \'to\' and \'from\' addresses and other forms of general contact * export * @interface BasicContactDeets */ export interface BasicContactDeets { /** * This can be either an email, mobile number, or mozaic handle * @type {string} * memberof BasicContactDeets */ 'point_of_contact': string; /** * Loosely, the name of the contact. May be changed during registration * @type {string} * memberof BasicContactDeets */ 'name': string; /** * * @type {string} * memberof BasicContactDeets */ 'user_account_id'?: string | null; /** * * @type {string} * memberof BasicContactDeets */ 'country_code'?: string | null; /** * * @type {string} * memberof BasicContactDeets */ 'external_id'?: string | null; /** * The user id to operate on their behalf (tenants only) * @type {string} * memberof BasicContactDeets */ 'user_id'?: string | null; /** * * @type {string} * memberof BasicContactDeets */ 'object'?: string | null; } /** * A list of BasicContact objects that have been mapped to Personas * export * @interface BasicContacts */ export interface BasicContacts { /** * * @type {Array<BasicContact>} * memberof BasicContacts */ 'data'?: Array<BasicContact> | null; /** * This is the count of records returned * @type {number} * memberof BasicContacts */ 'count'?: number; /** * * @type {number} * memberof BasicContacts */ 'page'?: number | null; /** * This is the total count of records available, Needed for pagination * @type {number} * memberof BasicContacts */ 'total_count'?: number; /** * The name of this object * @type {string} * memberof BasicContacts */ 'object'?: string | null; } /** * * export * @interface BatchRun */ export interface BatchRun { /** * * @type {string} * memberof BatchRun */ 'partner_account_id'?: string | null; /** * * @type {string} * memberof BatchRun */ 'batch_id'?: string | null; /** * * @type {string} * memberof BatchRun */ 'run_at'?: string; } /** * * export * @interface BillingDeets */ export interface BillingDeets { /** * * @type {string} * memberof BillingDeets */ 'name'?: string | null; /** * * @type {AddressDeets} * memberof BillingDeets */ 'address'?: AddressDeets; /** * * @type {string} * memberof BillingDeets */ 'object'?: string | null; } /** * * export * @interface BulkErrorResponse */ export interface BulkErrorResponse { /** * * @type {string} * memberof BulkErrorResponse */ 'message'?: string | null; /** * * @type {number} * memberof BulkErrorResponse */ 'number'?: number; } /** * * export * @interface CatalogEntryDeets */ export interface CatalogEntryDeets { /** * The id of a catalog this PortfolioItem belongs to * @type {string} * memberof CatalogEntryDeets */ 'catalog_id': string; /** * The ordinal position when necessary, otherwise ignored * @type {number} * memberof CatalogEntryDeets */ 'ordinal'?: number; } /** * system light dark notSet * export * @enum {string} */ export declare const ColorModeEnum: { /** * */ readonly System: "system"; /** * */ readonly Light: "light"; /** * */ readonly Dark: "dark"; /** * */ readonly NotSet: "notSet"; }; export type ColorModeEnum = typeof ColorModeEnum[keyof typeof ColorModeEnum]; /** * * export * @interface Connector */ export interface Connector { /** * Connector name. * @type {string} * memberof Connector */ 'connector_name'?: string | null; /** * Connector id. It will be auto generated. * @type {string} * memberof Connector */ 'connector_id'?: string | null; /** * Connector description. It will be auto generated. * @type {string} * memberof Connector */ 'description'?: string | null; /** * Connector logo URL. * @type {string} * memberof Connector */ 'thumbnail'?: string | null; /** * * @type {string} * memberof Connector */ 'short_id'?: string | null; /** * * @type {string} * memberof Connector */ 'id'?: string | null; /** * The name of this object * @type {string} * memberof Connector */ 'object'?: string | null; /** * * @type {string} * memberof Connector */ 'created_at'?: string; } /** * * export * @interface ConnectorAuth */ export interface ConnectorAuth { /** * Channel Id. * @type {string} * memberof ConnectorAuth */ 'channel_id'?: string | null; /** * Auth information * @type {any} * memberof ConnectorAuth */ 'auth_info'?: any | null; /** * * @type {string} * memberof ConnectorAuth */ 'short_id'?: string | null; /** * * @type {string} * memberof ConnectorAuth */ 'id'?: string | null; /** * The name of this object * @type {string} * memberof ConnectorAuth */ 'object'?: string | null; /** * * @type {string} * memberof ConnectorAuth */ 'created_at'?: string; } /** * * export * @interface ConnectorAuthListResponse */ export interface ConnectorAuthListResponse { /** * * @type {Array<ConnectorAuth>} * memberof ConnectorAuthListResponse */ 'data'?: Array<ConnectorAuth> | null; /** * This is the count of records returned * @type {number} * memberof ConnectorAuthListResponse */ 'count'?: number; /** * * @type {number} * memberof ConnectorAuthListResponse */ 'page'?: number | null; /** * This is the total count of records available, Needed for pagination * @type {number} * memberof ConnectorAuthListResponse */ 'total_count'?: number; /** * The name of this object * @type {string} * memberof ConnectorAuthListResponse */ 'object'?: string | null; } /** * * export * @interface ConnectorAuthUrl */ export interface ConnectorAuthUrl { /** * Auth url * @type {string} * memberof ConnectorAuthUrl */ 'auth_url'?: string | null; /** * * @type {string} * memberof ConnectorAuthUrl */ 'short_id'?: string | null; /** * * @type {string} * memberof ConnectorAuthUrl */ 'id'?: string | null; /** * The name of this object * @type {string} * memberof ConnectorAuthUrl */ 'object'?: string | null; /** * * @type {string} * memberof ConnectorAuthUrl */ 'created_at'?: string; } /** * * export * @interface ConnectorDeet */ export interface ConnectorDeet { /** * Connector name. * @type {string} * memberof ConnectorDeet */ 'connector_name'?: string | null; /** * Connector Id * @type {string} * memberof ConnectorDeet */ 'connector_id'?: string | null; /** * Description * @type {string} * memberof ConnectorDeet */ 'description'?: string | null; /** * Connector logo URL. * @type {string} * memberof ConnectorDeet */ 'thumbnail'?: string | null; /** * * @type {string} * memberof ConnectorDeet */ 'short_id'?: string | null; /** * * @type {string} * memberof ConnectorDeet */ 'id