@orbis-systems/orbis-api-clients 0.7.12 → 0.7.13

package/dist/zerohash/index.d.ts

@@ -77,105 +77,6 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
     setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
     protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
 }
-declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Instant Account Verification
-     * @name Initiate
-     * @summary Initiate
-     * @request GET:/iav/init
-     * @secure
-     */
-    initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Account Verification
-     * @name InitiatePost
-     * @summary Initiate Post
-     * @request POST:/iav/init
-     * @secure
-     */
-    initiatePost(query: object, data: {
-        /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
-        subject?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Account Verification
-     * @name Complete
-     * @summary Complete
-     * @request POST:/iav/complete
-     * @secure
-     */
-    complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Account Verification
-     * @name ListBankAccounts
-     * @summary List Bank Accounts
-     * @request POST:/iav/list
-     * @secure
-     */
-    listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Account Verification
-     * @name LinkBankAccount
-     * @summary Link Bank Account
-     * @request POST:/iav/link
-     * @secure
-     */
-    linkBankAccount(data: {
-        /** @example "5VXXXXX" */
-        account?: any;
-        /** @example "XXXXXXX" */
-        bankAccountId?: any;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Account Verification
-     * @name ImportWithPlaid
-     * @summary Import With Plaid
-     * @request POST:/iav/import
-     * @secure
-     */
-    importWithPlaid(data: {
-        /** @example "3AB123456" */
-        account?: any;
-        /** @example "123456" */
-        bankAccountNumber?: any;
-        /** @example "John Smith" */
-        bankAccountOwnerName?: any;
-        /** @example "checking" */
-        bankAccountType?: any;
-        /** @example "122105155" */
-        bankRoutingNumber?: any;
-        /** @example "Checking x456" */
-        nickname?: any;
-        /** @example "{optional}" */
-        note?: any;
-        /** @example "{optional}" */
-        remoteAddr?: any;
-        /** @example "{optional}" */
-        remoteDevice?: any;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
-declare class TransfersAch<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Ach
-     * @name Deposit
-     * @summary Deposit
-     * @request POST:/transfer/ach/deposit
-     * @secure
-     */
-    deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Ach
-     * @name Withdraw
-     * @summary Withdraw
-     * @request POST:/transfer/ach/withdraw
-     * @secure
-     */
-    withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
 declare class TransfersAcats<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -309,80 +210,233 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
         type?: string;
     }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
-declare class TransfersWires<HandleError extends boolean = boolean> {
+declare class TransfersAch<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @tags Transfers Wires
-     * @name Outgoing
-     * @summary Outgoing
-     * @request POST:/transfer/wire/outgoing
+     * @tags Transfers Ach
+     * @name Deposit
+     * @summary Deposit
+     * @request POST:/transfer/ach/deposit
      * @secure
      */
-    outgoing(data: {
-        /** @example "TRACCOUNT" */
+    deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Ach
+     * @name Withdraw
+     * @summary Withdraw
+     * @request POST:/transfer/ach/withdraw
+     * @secure
+     */
+    withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
+declare class TransfersBank<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Bank
+     * @name FundTransfer
+     * @summary Fund transfer
+     * @request POST:/transfer/bank/{direction}
+     * @secure
+     */
+    fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
+declare class TransfersCheques<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Cheques
+     * @name Withdrawal
+     * @summary Withdrawal
+     * @request POST:/transfer/check/outgoing
+     * @secure
+     */
+    withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
+declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Instant Account Verification
+     * @name Initiate
+     * @summary Initiate
+     * @request GET:/iav/init
+     * @secure
+     */
+    initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Account Verification
+     * @name InitiatePost
+     * @summary Initiate Post
+     * @request POST:/iav/init
+     * @secure
+     */
+    initiatePost(query: object, data: {
+        /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
+        subject?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Account Verification
+     * @name Complete
+     * @summary Complete
+     * @request POST:/iav/complete
+     * @secure
+     */
+    complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Account Verification
+     * @name ListBankAccounts
+     * @summary List Bank Accounts
+     * @request POST:/iav/list
+     * @secure
+     */
+    listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Account Verification
+     * @name LinkBankAccount
+     * @summary Link Bank Account
+     * @request POST:/iav/link
+     * @secure
+     */
+    linkBankAccount(data: {
+        /** @example "5VXXXXX" */
         account?: any;
-        /** @example 200 */
+        /** @example "XXXXXXX" */
+        bankAccountId?: any;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Account Verification
+     * @name ImportWithPlaid
+     * @summary Import With Plaid
+     * @request POST:/iav/import
+     * @secure
+     */
+    importWithPlaid(data: {
+        /** @example "3AB123456" */
+        account?: any;
+        /** @example "123456" */
+        bankAccountNumber?: any;
+        /** @example "John Smith" */
+        bankAccountOwnerName?: any;
+        /** @example "checking" */
+        bankAccountType?: any;
+        /** @example "122105155" */
+        bankRoutingNumber?: any;
+        /** @example "Checking x456" */
+        nickname?: any;
+        /** @example "{optional}" */
+        note?: any;
+        /** @example "{optional}" */
+        remoteAddr?: any;
+        /** @example "{optional}" */
+        remoteDevice?: any;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
+declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Instant Cash Transfers
+     * @name DepositWithdrawal
+     * @summary Deposit/Withdrawal
+     * @request POST:/transfer/ict/${direction}
+     * @secure
+     */
+    depositWithdrawal(direction: string, data: {
+        /** @example "ABC123456" */
+        account?: any;
+        /** @example 100 */
         amount?: any;
-        beneficiary?: {
-            /** @example "AAA012345" */
-            account?: string;
-            /** @example "CHECKING|SAVINGS" */
-            accountType?: string;
+        /** @example "USD" */
+        currency?: any;
+        originator?: {
             address?: {
                 /** @example "Central City" */
                 city?: string;
                 /** @example "USA" */
                 country?: string;
-                /** @example "11235" */
+                /** @example "12345" */
                 postalCode?: string;
-                /** @example "ST" */
+                /** @example "NY" */
                 stateProvince?: string;
                 /** @example ["123 Main St"] */
                 streetAddress?: string[];
             };
-            /** @example "John Smith" */
-            name?: string;
-            /** @example false */
-            thirdParty?: boolean;
-        };
-        /** @example "Partial|Full" */
-        disbursementType?: any;
-        /** @example 1234 */
-        entryId?: any;
-        /** @example false */
-        international?: any;
-        iraDetails?: {
-            /** @example "" */
-            contributionType?: string;
-            /** @example 2020 */
-            contributionYear?: number;
+            /** @example "John" */
+            firstName?: string;
+            institution?: {
+                /** @example "123456789" */
+                accountNumber?: string;
+                /** @example "Central City Central Bank" */
+                name?: string;
+            };
+            /** @example "Smith" */
+            lastName?: string;
         };
-        recipientBank?: {
-            /** @example "" */
-            additionalInformation?: string;
-            /** @example "" */
-            city?: string;
-            /** @example "" */
-            country?: string;
-            identifier?: {
-                /** @example "021202162" */
-                id?: string;
-                /** @example "ABA|BIC" */
-                type?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Cash Transfers
+     * @name DepositWithdrawalV2
+     * @summary Deposit/Withdrawal V2
+     * @request POST:/transfer/v2/ict/${direction}
+     * @secure
+     */
+    depositWithdrawalV2(direction: string, data: {
+        /** @example "AB123456" */
+        account?: any;
+        /** @example 100.32 */
+        amount?: any;
+        counterparty?: {
+            address?: {
+                /** @example "Central City" */
+                city?: string;
+                /** @example "12345" */
+                postalCode?: string;
+                /** @example "CC" */
+                stateProvince?: string;
+                /** @example ["225 Baker St"] */
+                streetAddress?: string[];
             };
-            /** @example "" */
-            name?: string;
-            /** @example "" */
-            postalCode?: string;
-            /** @example "" */
-            stateProvince?: string;
+            /** @example "James" */
+            firstName?: string;
+            institution?: {
+                /** @example "123456" */
+                accountNumber?: string;
+                /** @example "Royal Central Bank" */
+                name?: string;
+            };
+            /** @example "Bond" */
+            lastName?: string;
         };
-        /** @example "0.0.0.0" */
+        /** @example "USD" */
+        currency?: any;
+        /** @example "1.1.1.1" */
         remoteAddr?: any;
-        /** @example "ultra fast browser 1.1" */
+        /** @example "Droid Phone" */
         remoteDevice?: any;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Cash Transfers
+     * @name ObtainTheReport
+     * @summary Obtain the report
+     * @request POST:/transfer/reports/obtain
+     * @secure
+     */
+    obtainTheReport(data: {
+        /** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
+        date?: any;
+        /** @example "RETAIL_BANKING" */
+        reportType?: any;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags Transfers Instant Cash Transfers
+     * @name ListReports
+     * @summary List reports
+     * @request GET:/transfer/reports
+     * @secure
+     */
+    listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
 declare class TransfersJournals<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -493,123 +547,6 @@ declare class TransfersPositions<HandleError extends boolean = boolean> {
         remoteDevice?: any;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
-declare class TransfersBank<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Bank
-     * @name FundTransfer
-     * @summary Fund transfer
-     * @request POST:/transfer/bank/{direction}
-     * @secure
-     */
-    fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
-declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Instant Cash Transfers
-     * @name DepositWithdrawal
-     * @summary Deposit/Withdrawal
-     * @request POST:/transfer/ict/${direction}
-     * @secure
-     */
-    depositWithdrawal(direction: string, data: {
-        /** @example "ABC123456" */
-        account?: any;
-        /** @example 100 */
-        amount?: any;
-        /** @example "USD" */
-        currency?: any;
-        originator?: {
-            address?: {
-                /** @example "Central City" */
-                city?: string;
-                /** @example "USA" */
-                country?: string;
-                /** @example "12345" */
-                postalCode?: string;
-                /** @example "NY" */
-                stateProvince?: string;
-                /** @example ["123 Main St"] */
-                streetAddress?: string[];
-            };
-            /** @example "John" */
-            firstName?: string;
-            institution?: {
-                /** @example "123456789" */
-                accountNumber?: string;
-                /** @example "Central City Central Bank" */
-                name?: string;
-            };
-            /** @example "Smith" */
-            lastName?: string;
-        };
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Cash Transfers
-     * @name DepositWithdrawalV2
-     * @summary Deposit/Withdrawal V2
-     * @request POST:/transfer/v2/ict/${direction}
-     * @secure
-     */
-    depositWithdrawalV2(direction: string, data: {
-        /** @example "AB123456" */
-        account?: any;
-        /** @example 100.32 */
-        amount?: any;
-        counterparty?: {
-            address?: {
-                /** @example "Central City" */
-                city?: string;
-                /** @example "12345" */
-                postalCode?: string;
-                /** @example "CC" */
-                stateProvince?: string;
-                /** @example ["225 Baker St"] */
-                streetAddress?: string[];
-            };
-            /** @example "James" */
-            firstName?: string;
-            institution?: {
-                /** @example "123456" */
-                accountNumber?: string;
-                /** @example "Royal Central Bank" */
-                name?: string;
-            };
-            /** @example "Bond" */
-            lastName?: string;
-        };
-        /** @example "USD" */
-        currency?: any;
-        /** @example "1.1.1.1" */
-        remoteAddr?: any;
-        /** @example "Droid Phone" */
-        remoteDevice?: any;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Cash Transfers
-     * @name ObtainTheReport
-     * @summary Obtain the report
-     * @request POST:/transfer/reports/obtain
-     * @secure
-     */
-    obtainTheReport(data: {
-        /** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
-        date?: any;
-        /** @example "RETAIL_BANKING" */
-        reportType?: any;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-    /**
-     * @tags Transfers Instant Cash Transfers
-     * @name ListReports
-     * @summary List reports
-     * @request GET:/transfer/reports
-     * @secure
-     */
-    listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
 declare class TransfersRelationships<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -854,17 +791,80 @@ declare class TransfersRelationships<HandleError extends boolean = boolean> {
         };
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
-declare class TransfersCheques<HandleError extends boolean = boolean> {
+declare class TransfersWires<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @tags Transfers Cheques
-     * @name Withdrawal
-     * @summary Withdrawal
-     * @request POST:/transfer/check/outgoing
+     * @tags Transfers Wires
+     * @name Outgoing
+     * @summary Outgoing
+     * @request POST:/transfer/wire/outgoing
      * @secure
      */
-    withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    outgoing(data: {
+        /** @example "TRACCOUNT" */
+        account?: any;
+        /** @example 200 */
+        amount?: any;
+        beneficiary?: {
+            /** @example "AAA012345" */
+            account?: string;
+            /** @example "CHECKING|SAVINGS" */
+            accountType?: string;
+            address?: {
+                /** @example "Central City" */
+                city?: string;
+                /** @example "USA" */
+                country?: string;
+                /** @example "11235" */
+                postalCode?: string;
+                /** @example "ST" */
+                stateProvince?: string;
+                /** @example ["123 Main St"] */
+                streetAddress?: string[];
+            };
+            /** @example "John Smith" */
+            name?: string;
+            /** @example false */
+            thirdParty?: boolean;
+        };
+        /** @example "Partial|Full" */
+        disbursementType?: any;
+        /** @example 1234 */
+        entryId?: any;
+        /** @example false */
+        international?: any;
+        iraDetails?: {
+            /** @example "" */
+            contributionType?: string;
+            /** @example 2020 */
+            contributionYear?: number;
+        };
+        recipientBank?: {
+            /** @example "" */
+            additionalInformation?: string;
+            /** @example "" */
+            city?: string;
+            /** @example "" */
+            country?: string;
+            identifier?: {
+                /** @example "021202162" */
+                id?: string;
+                /** @example "ABA|BIC" */
+                type?: string;
+            };
+            /** @example "" */
+            name?: string;
+            /** @example "" */
+            postalCode?: string;
+            /** @example "" */
+            stateProvince?: string;
+        };
+        /** @example "0.0.0.0" */
+        remoteAddr?: any;
+        /** @example "ultra fast browser 1.1" */
+        remoteDevice?: any;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
 declare class _Transfers1<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;