@lightsparkdev/grid 0.2.1

package/resources/customers/customers.d.ts

@@ -0,0 +1,1238 @@
+import { APIResource } from "../../core/resource.js";
+import * as CustomersAPI from "./customers.js";
+import * as BulkAPI from "./bulk.js";
+import { Bulk, BulkGetJobStatusResponse, BulkUploadCsvParams, BulkUploadCsvResponse } from "./bulk.js";
+import * as ExternalAccountsAPI from "./external-accounts.js";
+import { BaseWalletInfo, BeneficiaryOneOf, CadAccountInfo, ClabeAccountInfo, ExternalAccount, ExternalAccountCreate, ExternalAccountCreateParams, ExternalAccountInfoOneOf, ExternalAccountListParams, ExternalAccounts, ExternalAccountsDefaultPagination, GbpAccountInfo, IbanAccountInfo, LightningWalletInfo, NgnAccountInfo, PhpAccountInfo, PixAccountInfo, PolygonWalletInfo, SgdAccountInfo, SolanaWalletInfo, SparkWalletInfo, TronWalletInfo, UpiAccountInfo, UsAccountInfo } from "./external-accounts.js";
+import * as InternalAccountsAPI from "../sandbox/internal-accounts.js";
+import { InternalAccountsDefaultPagination } from "../sandbox/internal-accounts.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { DefaultPagination, type DefaultPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Customers extends APIResource {
+    externalAccounts: ExternalAccountsAPI.ExternalAccounts;
+    bulk: BulkAPI.Bulk;
+    /**
+     * Register a new customer in the system with an account identifier and bank
+     * account information
+     *
+     * @example
+     * ```ts
+     * const customerOneOf = await client.customers.create({
+     *   CreateCustomerRequest: {
+     *     platformCustomerId: '9f84e0c2a72c4fa',
+     *     customerType: 'INDIVIDUAL',
+     *   },
+     * });
+     * ```
+     */
+    create(params: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerOneOf>;
+    /**
+     * Retrieve a customer by their system-generated ID
+     *
+     * @example
+     * ```ts
+     * const customer = await client.customers.retrieve(
+     *   'customerId',
+     * );
+     * ```
+     */
+    retrieve(customerID: string, options?: RequestOptions): APIPromise<CustomerRetrieveResponse>;
+    /**
+     * Update a customer's metadata by their system-generated ID
+     *
+     * @example
+     * ```ts
+     * const customer = await client.customers.update(
+     *   'customerId',
+     *   { UpdateCustomerRequest: { customerType: 'INDIVIDUAL' } },
+     * );
+     * ```
+     */
+    update(customerID: string, params: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerUpdateResponse>;
+    /**
+     * Retrieve a list of customers with optional filtering parameters. Returns all
+     * customers that match the specified filters. If no filters are provided, returns
+     * all customers (paginated).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerOneOf of client.customers.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomerOneovesDefaultPagination, CustomerOneOf>;
+    /**
+     * Delete a customer by their system-generated ID
+     *
+     * @example
+     * ```ts
+     * const customer = await client.customers.delete(
+     *   'customerId',
+     * );
+     * ```
+     */
+    delete(customerID: string, options?: RequestOptions): APIPromise<CustomerDeleteResponse>;
+    /**
+     * Generate a hosted KYC link to onboard a customer
+     *
+     * @example
+     * ```ts
+     * const response = await client.customers.getKYCLink({
+     *   platformCustomerId: 'platformCustomerId',
+     * });
+     * ```
+     */
+    getKYCLink(query: CustomerGetKYCLinkParams, options?: RequestOptions): APIPromise<CustomerGetKYCLinkResponse>;
+    /**
+     * Retrieve a list of internal accounts with optional filtering parameters. Returns
+     * all internal accounts that match the specified filters. If no filters are
+     * provided, returns all internal accounts (paginated).
+     *
+     * Internal accounts are created automatically when a customer is created based on
+     * the platform configuration.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const internalAccount of client.customers.listInternalAccounts()) {
+     *   // ...
+     * }
+     * ```
+     */
+    listInternalAccounts(query?: CustomerListInternalAccountsParams | null | undefined, options?: RequestOptions): PagePromise<InternalAccountsDefaultPagination, InternalAccountsAPI.InternalAccount>;
+}
+export type CustomerOneovesDefaultPagination = DefaultPagination<CustomerOneOf>;
+export interface Customer {
+    /**
+     * Platform-specific customer identifier
+     */
+    platformCustomerId: string;
+    /**
+     * Full UMA address (always present in responses, even if system-generated). This
+     * is an optional identifier to route payments to the customer.
+     */
+    umaAddress: string;
+    /**
+     * System-generated unique identifier
+     */
+    id?: string;
+    /**
+     * Creation timestamp
+     */
+    createdAt?: string;
+    /**
+     * Whether the customer is marked as deleted
+     */
+    isDeleted?: boolean;
+    /**
+     * The current KYC status of a customer
+     */
+    kycStatus?: 'APPROVED' | 'REJECTED' | 'PENDING_REVIEW' | 'EXPIRED' | 'CANCELED' | 'MANUALLY_APPROVED' | 'MANUALLY_REJECTED';
+    /**
+     * Last update timestamp
+     */
+    updatedAt?: string;
+}
+export interface CustomerCreate {
+    /**
+     * Platform-specific customer identifier. If not provided, one will be generated by
+     * the system.
+     */
+    platformCustomerId: string;
+    /**
+     * Optional UMA address identifier. If not provided during customer creation, one
+     * will be generated by the system. If provided during customer update, the UMA
+     * address will be updated to the provided value. This is an optional identifier to
+     * route payments to the customer. This is an optional identifier to route payments
+     * to the customer.
+     */
+    umaAddress?: string;
+}
+export type CustomerOneOf = CustomerOneOf.IndividualCustomer | CustomerOneOf.BusinessCustomer;
+export declare namespace CustomerOneOf {
+    interface IndividualCustomer extends CustomersAPI.Customer {
+        customerType: 'INDIVIDUAL';
+        address?: IndividualCustomer.Address;
+        /**
+         * Date of birth in ISO 8601 format (YYYY-MM-DD)
+         */
+        birthDate?: string;
+        /**
+         * Individual's full name
+         */
+        fullName?: string;
+        /**
+         * Country code (ISO 3166-1 alpha-2)
+         */
+        nationality?: string;
+    }
+    namespace IndividualCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+    }
+    interface BusinessCustomer extends CustomersAPI.Customer {
+        customerType: 'BUSINESS';
+        address?: BusinessCustomer.Address;
+        beneficialOwners?: Array<BusinessCustomer.BeneficialOwner>;
+        businessInfo?: BusinessCustomer.BusinessInfo;
+    }
+    namespace BusinessCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+        interface BeneficialOwner {
+            /**
+             * Individual's full name
+             */
+            fullName: string;
+            /**
+             * Type of individual in the corporation
+             */
+            individualType: 'DIRECTOR' | 'CONTROL_PERSON' | 'BUSINESS_POINT_OF_CONTACT' | 'TRUSTEE' | 'SETTLOR' | 'GENERAL_PARTNER';
+            address?: BeneficialOwner.Address;
+            /**
+             * Date of birth in ISO 8601 format (YYYY-MM-DD)
+             */
+            birthDate?: string;
+            /**
+             * Email address of the individual
+             */
+            emailAddress?: string;
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            nationality?: string;
+            /**
+             * Percent of ownership when individual type is beneficial owner
+             */
+            percentageOwnership?: number;
+            /**
+             * Phone number of the individual in E.164 format
+             */
+            phoneNumber?: string;
+            /**
+             * Tax identification number of the individual. This could be a Social Security
+             * Number (SSN) for US individuals, Tax Identification Number (TIN) for non-US
+             * individuals, or a Passport Number.
+             */
+            taxId?: string;
+            /**
+             * Title at company
+             */
+            title?: string;
+        }
+        namespace BeneficialOwner {
+            interface Address {
+                /**
+                 * Country code (ISO 3166-1 alpha-2)
+                 */
+                country: string;
+                /**
+                 * Street address line 1
+                 */
+                line1: string;
+                /**
+                 * Postal/ZIP code
+                 */
+                postalCode: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * State/Province/Region
+                 */
+                state?: string;
+            }
+        }
+        interface BusinessInfo {
+            /**
+             * Legal name of the business
+             */
+            legalName: string;
+            /**
+             * Business registration number
+             */
+            registrationNumber?: string;
+            /**
+             * Tax identification number
+             */
+            taxId?: string;
+        }
+    }
+}
+export interface CustomerUpdate {
+    /**
+     * Optional UMA address identifier. If provided, the customer's UMA address will be
+     * updated. This is an optional identifier to route payments to the customer.
+     */
+    umaAddress?: string;
+}
+export type CustomerRetrieveResponse = CustomerRetrieveResponse.IndividualCustomer | CustomerRetrieveResponse.BusinessCustomer;
+export declare namespace CustomerRetrieveResponse {
+    interface IndividualCustomer extends CustomersAPI.Customer {
+        customerType: 'INDIVIDUAL';
+        address?: IndividualCustomer.Address;
+        /**
+         * Date of birth in ISO 8601 format (YYYY-MM-DD)
+         */
+        birthDate?: string;
+        /**
+         * Individual's full name
+         */
+        fullName?: string;
+        /**
+         * Country code (ISO 3166-1 alpha-2)
+         */
+        nationality?: string;
+    }
+    namespace IndividualCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+    }
+    interface BusinessCustomer extends CustomersAPI.Customer {
+        customerType: 'BUSINESS';
+        address?: BusinessCustomer.Address;
+        beneficialOwners?: Array<BusinessCustomer.BeneficialOwner>;
+        businessInfo?: BusinessCustomer.BusinessInfo;
+    }
+    namespace BusinessCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+        interface BeneficialOwner {
+            /**
+             * Individual's full name
+             */
+            fullName: string;
+            /**
+             * Type of individual in the corporation
+             */
+            individualType: 'DIRECTOR' | 'CONTROL_PERSON' | 'BUSINESS_POINT_OF_CONTACT' | 'TRUSTEE' | 'SETTLOR' | 'GENERAL_PARTNER';
+            address?: BeneficialOwner.Address;
+            /**
+             * Date of birth in ISO 8601 format (YYYY-MM-DD)
+             */
+            birthDate?: string;
+            /**
+             * Email address of the individual
+             */
+            emailAddress?: string;
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            nationality?: string;
+            /**
+             * Percent of ownership when individual type is beneficial owner
+             */
+            percentageOwnership?: number;
+            /**
+             * Phone number of the individual in E.164 format
+             */
+            phoneNumber?: string;
+            /**
+             * Tax identification number of the individual. This could be a Social Security
+             * Number (SSN) for US individuals, Tax Identification Number (TIN) for non-US
+             * individuals, or a Passport Number.
+             */
+            taxId?: string;
+            /**
+             * Title at company
+             */
+            title?: string;
+        }
+        namespace BeneficialOwner {
+            interface Address {
+                /**
+                 * Country code (ISO 3166-1 alpha-2)
+                 */
+                country: string;
+                /**
+                 * Street address line 1
+                 */
+                line1: string;
+                /**
+                 * Postal/ZIP code
+                 */
+                postalCode: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * State/Province/Region
+                 */
+                state?: string;
+            }
+        }
+        interface BusinessInfo {
+            /**
+             * Legal name of the business
+             */
+            legalName: string;
+            /**
+             * Business registration number
+             */
+            registrationNumber?: string;
+            /**
+             * Tax identification number
+             */
+            taxId?: string;
+        }
+    }
+}
+export type CustomerUpdateResponse = CustomerUpdateResponse.IndividualCustomer | CustomerUpdateResponse.BusinessCustomer;
+export declare namespace CustomerUpdateResponse {
+    interface IndividualCustomer extends CustomersAPI.Customer {
+        customerType: 'INDIVIDUAL';
+        address?: IndividualCustomer.Address;
+        /**
+         * Date of birth in ISO 8601 format (YYYY-MM-DD)
+         */
+        birthDate?: string;
+        /**
+         * Individual's full name
+         */
+        fullName?: string;
+        /**
+         * Country code (ISO 3166-1 alpha-2)
+         */
+        nationality?: string;
+    }
+    namespace IndividualCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+    }
+    interface BusinessCustomer extends CustomersAPI.Customer {
+        customerType: 'BUSINESS';
+        address?: BusinessCustomer.Address;
+        beneficialOwners?: Array<BusinessCustomer.BeneficialOwner>;
+        businessInfo?: BusinessCustomer.BusinessInfo;
+    }
+    namespace BusinessCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+        interface BeneficialOwner {
+            /**
+             * Individual's full name
+             */
+            fullName: string;
+            /**
+             * Type of individual in the corporation
+             */
+            individualType: 'DIRECTOR' | 'CONTROL_PERSON' | 'BUSINESS_POINT_OF_CONTACT' | 'TRUSTEE' | 'SETTLOR' | 'GENERAL_PARTNER';
+            address?: BeneficialOwner.Address;
+            /**
+             * Date of birth in ISO 8601 format (YYYY-MM-DD)
+             */
+            birthDate?: string;
+            /**
+             * Email address of the individual
+             */
+            emailAddress?: string;
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            nationality?: string;
+            /**
+             * Percent of ownership when individual type is beneficial owner
+             */
+            percentageOwnership?: number;
+            /**
+             * Phone number of the individual in E.164 format
+             */
+            phoneNumber?: string;
+            /**
+             * Tax identification number of the individual. This could be a Social Security
+             * Number (SSN) for US individuals, Tax Identification Number (TIN) for non-US
+             * individuals, or a Passport Number.
+             */
+            taxId?: string;
+            /**
+             * Title at company
+             */
+            title?: string;
+        }
+        namespace BeneficialOwner {
+            interface Address {
+                /**
+                 * Country code (ISO 3166-1 alpha-2)
+                 */
+                country: string;
+                /**
+                 * Street address line 1
+                 */
+                line1: string;
+                /**
+                 * Postal/ZIP code
+                 */
+                postalCode: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * State/Province/Region
+                 */
+                state?: string;
+            }
+        }
+        interface BusinessInfo {
+            /**
+             * Legal name of the business
+             */
+            legalName: string;
+            /**
+             * Business registration number
+             */
+            registrationNumber?: string;
+            /**
+             * Tax identification number
+             */
+            taxId?: string;
+        }
+    }
+}
+export type CustomerDeleteResponse = CustomerDeleteResponse.IndividualCustomer | CustomerDeleteResponse.BusinessCustomer;
+export declare namespace CustomerDeleteResponse {
+    interface IndividualCustomer extends CustomersAPI.Customer {
+        customerType: 'INDIVIDUAL';
+        address?: IndividualCustomer.Address;
+        /**
+         * Date of birth in ISO 8601 format (YYYY-MM-DD)
+         */
+        birthDate?: string;
+        /**
+         * Individual's full name
+         */
+        fullName?: string;
+        /**
+         * Country code (ISO 3166-1 alpha-2)
+         */
+        nationality?: string;
+    }
+    namespace IndividualCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+    }
+    interface BusinessCustomer extends CustomersAPI.Customer {
+        customerType: 'BUSINESS';
+        address?: BusinessCustomer.Address;
+        beneficialOwners?: Array<BusinessCustomer.BeneficialOwner>;
+        businessInfo?: BusinessCustomer.BusinessInfo;
+    }
+    namespace BusinessCustomer {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+        interface BeneficialOwner {
+            /**
+             * Individual's full name
+             */
+            fullName: string;
+            /**
+             * Type of individual in the corporation
+             */
+            individualType: 'DIRECTOR' | 'CONTROL_PERSON' | 'BUSINESS_POINT_OF_CONTACT' | 'TRUSTEE' | 'SETTLOR' | 'GENERAL_PARTNER';
+            address?: BeneficialOwner.Address;
+            /**
+             * Date of birth in ISO 8601 format (YYYY-MM-DD)
+             */
+            birthDate?: string;
+            /**
+             * Email address of the individual
+             */
+            emailAddress?: string;
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            nationality?: string;
+            /**
+             * Percent of ownership when individual type is beneficial owner
+             */
+            percentageOwnership?: number;
+            /**
+             * Phone number of the individual in E.164 format
+             */
+            phoneNumber?: string;
+            /**
+             * Tax identification number of the individual. This could be a Social Security
+             * Number (SSN) for US individuals, Tax Identification Number (TIN) for non-US
+             * individuals, or a Passport Number.
+             */
+            taxId?: string;
+            /**
+             * Title at company
+             */
+            title?: string;
+        }
+        namespace BeneficialOwner {
+            interface Address {
+                /**
+                 * Country code (ISO 3166-1 alpha-2)
+                 */
+                country: string;
+                /**
+                 * Street address line 1
+                 */
+                line1: string;
+                /**
+                 * Postal/ZIP code
+                 */
+                postalCode: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * State/Province/Region
+                 */
+                state?: string;
+            }
+        }
+        interface BusinessInfo {
+            /**
+             * Legal name of the business
+             */
+            legalName: string;
+            /**
+             * Business registration number
+             */
+            registrationNumber?: string;
+            /**
+             * Tax identification number
+             */
+            taxId?: string;
+        }
+    }
+}
+export interface CustomerGetKYCLinkResponse {
+    /**
+     * The customer id of the newly created customer on the system
+     */
+    customerId?: string;
+    /**
+     * A hosted KYC link for your customer to complete KYC
+     */
+    kycUrl?: string;
+    /**
+     * The platform id of the customer to onboard
+     */
+    platformCustomerId?: string;
+}
+export interface CustomerCreateParams {
+    CreateCustomerRequest: CustomerCreateParams.IndividualCustomerCreateRequest | CustomerCreateParams.BusinessCustomerCreateRequest;
+}
+export declare namespace CustomerCreateParams {
+    interface IndividualCustomerCreateRequest extends CustomersAPI.CustomerCreate {
+        customerType: 'INDIVIDUAL';
+        address?: IndividualCustomerCreateRequest.Address;
+        /**
+         * Date of birth in ISO 8601 format (YYYY-MM-DD)
+         */
+        birthDate?: string;
+        /**
+         * Individual's full name
+         */
+        fullName?: string;
+        /**
+         * Country code (ISO 3166-1 alpha-2)
+         */
+        nationality?: string;
+    }
+    namespace IndividualCustomerCreateRequest {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+    }
+    interface BusinessCustomerCreateRequest extends CustomersAPI.CustomerCreate {
+        customerType: 'BUSINESS';
+        address?: BusinessCustomerCreateRequest.Address;
+        beneficialOwners?: Array<BusinessCustomerCreateRequest.BeneficialOwner>;
+        businessInfo?: BusinessCustomerCreateRequest.BusinessInfo;
+    }
+    namespace BusinessCustomerCreateRequest {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+        interface BeneficialOwner {
+            /**
+             * Individual's full name
+             */
+            fullName: string;
+            /**
+             * Type of individual in the corporation
+             */
+            individualType: 'DIRECTOR' | 'CONTROL_PERSON' | 'BUSINESS_POINT_OF_CONTACT' | 'TRUSTEE' | 'SETTLOR' | 'GENERAL_PARTNER';
+            address?: BeneficialOwner.Address;
+            /**
+             * Date of birth in ISO 8601 format (YYYY-MM-DD)
+             */
+            birthDate?: string;
+            /**
+             * Email address of the individual
+             */
+            emailAddress?: string;
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            nationality?: string;
+            /**
+             * Percent of ownership when individual type is beneficial owner
+             */
+            percentageOwnership?: number;
+            /**
+             * Phone number of the individual in E.164 format
+             */
+            phoneNumber?: string;
+            /**
+             * Tax identification number of the individual. This could be a Social Security
+             * Number (SSN) for US individuals, Tax Identification Number (TIN) for non-US
+             * individuals, or a Passport Number.
+             */
+            taxId?: string;
+            /**
+             * Title at company
+             */
+            title?: string;
+        }
+        namespace BeneficialOwner {
+            interface Address {
+                /**
+                 * Country code (ISO 3166-1 alpha-2)
+                 */
+                country: string;
+                /**
+                 * Street address line 1
+                 */
+                line1: string;
+                /**
+                 * Postal/ZIP code
+                 */
+                postalCode: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * State/Province/Region
+                 */
+                state?: string;
+            }
+        }
+        interface BusinessInfo {
+            /**
+             * Legal name of the business
+             */
+            legalName: string;
+            /**
+             * Business registration number
+             */
+            registrationNumber?: string;
+            /**
+             * Tax identification number
+             */
+            taxId?: string;
+        }
+    }
+}
+export interface CustomerUpdateParams {
+    UpdateCustomerRequest: CustomerUpdateParams.IndividualCustomerUpdateRequest | CustomerUpdateParams.BusinessCustomerUpdateRequest;
+}
+export declare namespace CustomerUpdateParams {
+    interface IndividualCustomerUpdateRequest extends CustomersAPI.CustomerUpdate {
+        customerType: 'INDIVIDUAL';
+        address?: IndividualCustomerUpdateRequest.Address;
+        /**
+         * Date of birth in ISO 8601 format (YYYY-MM-DD)
+         */
+        birthDate?: string;
+        /**
+         * Individual's full name
+         */
+        fullName?: string;
+        /**
+         * Country code (ISO 3166-1 alpha-2)
+         */
+        nationality?: string;
+    }
+    namespace IndividualCustomerUpdateRequest {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+    }
+    interface BusinessCustomerUpdateRequest extends CustomersAPI.CustomerUpdate {
+        customerType: 'BUSINESS';
+        address?: BusinessCustomerUpdateRequest.Address;
+        beneficialOwners?: Array<BusinessCustomerUpdateRequest.BeneficialOwner>;
+        /**
+         * Additional information for business entities
+         */
+        businessInfo?: BusinessCustomerUpdateRequest.BusinessInfo;
+    }
+    namespace BusinessCustomerUpdateRequest {
+        interface Address {
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            country: string;
+            /**
+             * Street address line 1
+             */
+            line1: string;
+            /**
+             * Postal/ZIP code
+             */
+            postalCode: string;
+            /**
+             * City
+             */
+            city?: string;
+            /**
+             * Street address line 2
+             */
+            line2?: string;
+            /**
+             * State/Province/Region
+             */
+            state?: string;
+        }
+        interface BeneficialOwner {
+            /**
+             * Individual's full name
+             */
+            fullName: string;
+            /**
+             * Type of individual in the corporation
+             */
+            individualType: 'DIRECTOR' | 'CONTROL_PERSON' | 'BUSINESS_POINT_OF_CONTACT' | 'TRUSTEE' | 'SETTLOR' | 'GENERAL_PARTNER';
+            address?: BeneficialOwner.Address;
+            /**
+             * Date of birth in ISO 8601 format (YYYY-MM-DD)
+             */
+            birthDate?: string;
+            /**
+             * Email address of the individual
+             */
+            emailAddress?: string;
+            /**
+             * Country code (ISO 3166-1 alpha-2)
+             */
+            nationality?: string;
+            /**
+             * Percent of ownership when individual type is beneficial owner
+             */
+            percentageOwnership?: number;
+            /**
+             * Phone number of the individual in E.164 format
+             */
+            phoneNumber?: string;
+            /**
+             * Tax identification number of the individual. This could be a Social Security
+             * Number (SSN) for US individuals, Tax Identification Number (TIN) for non-US
+             * individuals, or a Passport Number.
+             */
+            taxId?: string;
+            /**
+             * Title at company
+             */
+            title?: string;
+        }
+        namespace BeneficialOwner {
+            interface Address {
+                /**
+                 * Country code (ISO 3166-1 alpha-2)
+                 */
+                country: string;
+                /**
+                 * Street address line 1
+                 */
+                line1: string;
+                /**
+                 * Postal/ZIP code
+                 */
+                postalCode: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * State/Province/Region
+                 */
+                state?: string;
+            }
+        }
+        /**
+         * Additional information for business entities
+         */
+        interface BusinessInfo {
+            /**
+             * Legal name of the business
+             */
+            legalName?: string;
+            /**
+             * Business registration number
+             */
+            registrationNumber?: string;
+            /**
+             * Tax identification number
+             */
+            taxId?: string;
+        }
+    }
+}
+export interface CustomerListParams extends DefaultPaginationParams {
+    /**
+     * Filter customers created after this timestamp (inclusive)
+     */
+    createdAfter?: string;
+    /**
+     * Filter customers created before this timestamp (inclusive)
+     */
+    createdBefore?: string;
+    /**
+     * Filter by customer type
+     */
+    customerType?: 'INDIVIDUAL' | 'BUSINESS';
+    /**
+     * Whether to include deleted customers in the results. Default is false.
+     */
+    isIncludingDeleted?: boolean;
+    /**
+     * Maximum number of results to return (default 20, max 100)
+     */
+    limit?: number;
+    /**
+     * Filter by platform-specific customer identifier
+     */
+    platformCustomerId?: string;
+    /**
+     * Filter by uma address
+     */
+    umaAddress?: string;
+    /**
+     * Filter customers updated after this timestamp (inclusive)
+     */
+    updatedAfter?: string;
+    /**
+     * Filter customers updated before this timestamp (inclusive)
+     */
+    updatedBefore?: string;
+}
+export interface CustomerGetKYCLinkParams {
+    /**
+     * The platform id of the customer to onboard
+     */
+    platformCustomerId: string;
+    /**
+     * An optional uri a customer will be redirected to after completing the hosted KYC
+     * flow
+     */
+    redirectUri?: string;
+}
+export interface CustomerListInternalAccountsParams extends DefaultPaginationParams {
+    /**
+     * Filter by currency code
+     */
+    currency?: string;
+    /**
+     * Filter by internal accounts associated with a specific customer
+     */
+    customerId?: string;
+    /**
+     * Maximum number of results to return (default 20, max 100)
+     */
+    limit?: number;
+}
+export declare namespace Customers {
+    export { type Customer as Customer, type CustomerCreate as CustomerCreate, type CustomerOneOf as CustomerOneOf, type CustomerUpdate as CustomerUpdate, type CustomerRetrieveResponse as CustomerRetrieveResponse, type CustomerUpdateResponse as CustomerUpdateResponse, type CustomerDeleteResponse as CustomerDeleteResponse, type CustomerGetKYCLinkResponse as CustomerGetKYCLinkResponse, type CustomerOneovesDefaultPagination as CustomerOneovesDefaultPagination, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerGetKYCLinkParams as CustomerGetKYCLinkParams, type CustomerListInternalAccountsParams as CustomerListInternalAccountsParams, };
+    export { ExternalAccounts as ExternalAccounts, type BaseWalletInfo as BaseWalletInfo, type BeneficiaryOneOf as BeneficiaryOneOf, type CadAccountInfo as CadAccountInfo, type ClabeAccountInfo as ClabeAccountInfo, type ExternalAccount as ExternalAccount, type ExternalAccountCreate as ExternalAccountCreate, type ExternalAccountInfoOneOf as ExternalAccountInfoOneOf, type GbpAccountInfo as GbpAccountInfo, type IbanAccountInfo as IbanAccountInfo, type LightningWalletInfo as LightningWalletInfo, type NgnAccountInfo as NgnAccountInfo, type PhpAccountInfo as PhpAccountInfo, type PixAccountInfo as PixAccountInfo, type PolygonWalletInfo as PolygonWalletInfo, type SgdAccountInfo as SgdAccountInfo, type SolanaWalletInfo as SolanaWalletInfo, type SparkWalletInfo as SparkWalletInfo, type TronWalletInfo as TronWalletInfo, type UpiAccountInfo as UpiAccountInfo, type UsAccountInfo as UsAccountInfo, type ExternalAccountsDefaultPagination as ExternalAccountsDefaultPagination, type ExternalAccountCreateParams as ExternalAccountCreateParams, type ExternalAccountListParams as ExternalAccountListParams, };
+    export { Bulk as Bulk, type BulkGetJobStatusResponse as BulkGetJobStatusResponse, type BulkUploadCsvResponse as BulkUploadCsvResponse, type BulkUploadCsvParams as BulkUploadCsvParams, };
+}
+export { type InternalAccountsDefaultPagination };
+//# sourceMappingURL=customers.d.ts.map