@riocrypto/common 1.0.1706 → 1.0.1711

package/build/clients/rio-client.d.ts

@@ -1,281 +0,0 @@
-import { AxiosInstance, AxiosStatic } from "axios";
-import { Auth } from "../types/auth";
-import { AuthUpdate } from "../types/auth-update";
-import { BankPayout } from "../types/bank-payout";
-import { CryptoAddress } from "../types/crypto-address";
-import { Country } from "../types/country";
-import { Fiat } from "../types/fiat";
-import { Order } from "../types/order";
-import { OrderInput } from "../types/order-input";
-import { PaymentMethod } from "../types/payment-method";
-import { PayoutMethod } from "../types/payout-method";
-import { RioSettings } from "../types/rio-settings";
-import { RioSettingsUpdate } from "../types/rio-settings-update";
-import { User } from "../types/user";
-import { UserInput } from "../types/user-input";
-import { UserUpdate } from "../types/user-update";
-import { BankPayment } from "../types/bank-payment";
-import { BankAccount } from "../types/bank-account";
-import { Quote } from "../types/quote";
-import { Crypto } from "../types/crypto";
-import { QuoteInput } from "../types/quote-input";
-import { UserQuery } from "../types/user-query";
-import { OrderQuery } from "../types/order-query";
-import { BankAccountQuery } from "../types/bank-account-query";
-import { Invoice } from "../types/invoice";
-import { CryptoAddressQuery } from "../types/crypto-address-query";
-import { ChainedQuoteInput } from "../types/chained-quote-input";
-import { ChainedQuote } from "../types/chained-quote";
-import { ChainedOrderInput } from "../types/chained-order-input";
-import { ChainedOrder } from "../types/chained-order";
-import { ChainedOrderQuery } from "../types/chained-order-query";
-import { SecurityQuestion } from "../types/security-question";
-import { KYCFileType } from "../types/kyc-file-type";
-import { CountryOfOrigin } from "../types/country-of-origin";
-import { UserType } from "../types/user-type";
-import { UBOInput } from "../types/UBO-input";
-import { UBO } from "../types/UBO";
-import { UBOUpdate } from "../types/UBO-update";
-import { IdentityVerificationType } from "../types/IdentityVerificationType";
-import { BidInput } from "../types/bid-input";
-import { AddressVerification } from "../types/address-verification";
-import { BankAccountVerification } from "../types/bank-account-verification";
-import { Onboarding } from "../types/onboarding";
-import { Alert } from "../types/alert";
-import { AlertTriggerCondition } from "../types/alert-trigger-condition";
-import { Side } from "../types/side";
-import { AlertType } from "../types/alert-type";
-import { WebhookRegistration } from "../types/webhook-registration";
-import { WebhookType } from "../types/webhook-type";
-export declare class RioClient {
-    private axios;
-    constructor(axios: AxiosStatic | AxiosInstance);
-    getAddressVerification(cryptoAddressId: string): Promise<AddressVerification>;
-    getBankAccountVerification(bankAccountId: string): Promise<BankAccountVerification>;
-    getLiquidityAvailable(): Promise<{
-        buy: number;
-        sell: number;
-    }>;
-    exportOrders(page: number, startDate: Date, endDate: Date, query?: OrderQuery): Promise<Order[]>;
-    getOrders(page: number, limit?: number, query?: OrderQuery, includeOwnOrders?: boolean, startDate?: Date, endDate?: Date): Promise<Order[]>;
-    createAlert({ userId, type, priceTrigger, liquidityTrigger, destinationType, telegramDestination, }: {
-        userId: string;
-        type: AlertType;
-        priceTrigger?: {
-            country: Country;
-            condition: AlertTriggerCondition;
-            value: number;
-            side: Side;
-            fiat: Fiat;
-            crypto: Crypto;
-            cooldown?: number;
-            isRecurring?: boolean;
-        };
-        liquidityTrigger?: {
-            condition: AlertTriggerCondition;
-            value: number;
-            side: Side;
-            assetType?: "crypto" | "fiat";
-            asset?: Crypto | Fiat;
-            cooldown?: number;
-            isRecurring?: boolean;
-        };
-        destinationType: "telegram";
-        telegramDestination: {
-            chatId?: string;
-            username?: string;
-        };
-    }): Promise<{
-        code: string;
-    }>;
-    getAlerts(): Promise<Alert[]>;
-    getAlert(id: string): Promise<Alert>;
-    deleteAlert(id: string): Promise<void>;
-    updateOrder(id: string, update: {
-        notes: string;
-    }): Promise<Order>;
-    getChainedOrders(page: number, limit?: number, query?: ChainedOrderQuery): Promise<ChainedOrder[]>;
-    createQuote(input: QuoteInput): Promise<Quote>;
-    createChainedQuote(input: ChainedQuoteInput): Promise<ChainedQuote>;
-    getUsers(page: number, limit?: number, query?: UserQuery): Promise<User[]>;
-    getUBOS(page: number, limit?: number): Promise<UBO[]>;
-    updateUser(update: UserUpdate, userId?: string): Promise<User>;
-    requestOnboardingReview(country: Country, userId?: string): Promise<User>;
-    updateUBO(update: UBOUpdate, uboId?: string): Promise<UBO>;
-    uploadCOI(id: string, formData: FormData): Promise<User>;
-    uploadFile(id: string, country: CountryOfOrigin, fileType: KYCFileType, formData: FormData): Promise<User>;
-    uploadKYCReport(id: string, formData: FormData): Promise<User>;
-    createBid(input: BidInput): Promise<void>;
-    getBid(id: string): Promise<void>;
-    uploadCSF(id: string, formData: FormData): Promise<User>;
-    getRioSettings(): Promise<RioSettings>;
-    sendVerificationEmail(type: IdentityVerificationType, id: string, country: Country): Promise<void>;
-    sendUBOOnboardingEmail(email: string, associatedUserId: string, country: Country): Promise<void>;
-    sendBridgeOnboardingEmail(userId: string): Promise<void>;
-    getOnboardingRequirements(userType: UserType, country: Country, countryOfOrigin: CountryOfOrigin): Promise<{
-        textRequirements: ("personalId" | "taxId")[];
-        fileRequirements: KYCFileType[];
-    }>;
-    getUBOOnboardingRequirements(country: Country, countryOfOrigin: CountryOfOrigin): Promise<{
-        textRequirements: ("personalId" | "taxId")[];
-        fileRequirements: KYCFileType[];
-    }>;
-    createRioSettings(rioSettings: {
-        platformFee: number;
-    }): Promise<void>;
-    updateRioSettings(update: RioSettingsUpdate): Promise<void>;
-    confirmBankPayment(orderId: string, amountFiat?: number): Promise<any>;
-    createAPIKey(label: string): Promise<{
-        value: string;
-        label: string;
-    }>;
-    deleteBankAccount(id: string): Promise<void>;
-    deleteAddress(id: string): Promise<void>;
-    deleteAPIKey(id: string): Promise<void>;
-    confirmBankPayout(orderId: string): Promise<any>;
-    getUser(userId?: string): Promise<User>;
-    getUBO(id: string): Promise<UBO>;
-    createUser(user: UserInput): Promise<User>;
-    createUBO(user: UBOInput): Promise<UBO>;
-    uploadUBOFile(id: string, country: CountryOfOrigin, fileType: KYCFileType, formData: FormData): Promise<UBO>;
-    uploadProofOfAddress(id: string, formData: FormData): Promise<User>;
-    getBankPayment(orderId: string): Promise<BankPayment>;
-    verifyBankPayment(orderId: string): Promise<any>;
-    sendPhoneAuthCode(phoneNumber: string): Promise<{
-        hasAuthenticatorEnabled: boolean;
-    }>;
-    getAuth(id: string): Promise<Auth>;
-    getAuthWithoutId(): Promise<Auth>;
-    getAuths(userId?: string): Promise<Auth[]>;
-    deleteAuth(id: string): Promise<void>;
-    getSecurityQuestion(): Promise<SecurityQuestion>;
-    authHasSecurityQuestion(): Promise<Boolean>;
-    signout(): Promise<void>;
-    verifyCode(phoneNumber: string, code?: string, authenticatorCode?: string): Promise<{
-        id: string;
-    } | void>;
-    createFogbenderToken(): Promise<{
-        token: string;
-    }>;
-    createAuthenticatorSecret(): Promise<{
-        secret: string;
-    }>;
-    confirmAuthenticatorRegistration(authenticatorCode: string): Promise<void>;
-    signin(password: string): Promise<Auth>;
-    signup(password: string, securityQuestion: SecurityQuestion, securityAnswer: string): Promise<{
-        auth: Auth;
-        isAuthorizedPhoneNumberAuth: boolean;
-    }>;
-    refreshToken(): Promise<void>;
-    createOrder(order: OrderInput): Promise<Order>;
-    createChainedOrder(order: ChainedOrderInput): Promise<ChainedOrder>;
-    cancelOrder(id?: string): Promise<Order>;
-    cancelChainedOrder(id?: string): Promise<void>;
-    getOrder(id: string): Promise<Order>;
-    getChainedOrder(id: string): Promise<ChainedOrder>;
-    createBankPayout(oid: string, bankAccountId: string): Promise<BankPayout>;
-    getBankPayout(orderId: string): Promise<BankPayout>;
-    getBridgeOnboardingLinks(userId: string): Promise<{
-        tosLink: string;
-        kycLink: string;
-    }>;
-    getCryptoAddresses(page: number, limit?: number, query?: CryptoAddressQuery): Promise<CryptoAddress[]>;
-    startAddressVerification(addressId: string): Promise<void>;
-    completeAddressVerification(addressId: string, amount: Number): Promise<void>;
-    startBankAccountVerification(bankAccountId: string): Promise<void>;
-    completeBankAccountVerification(bankAccountId: string, amount: Number): Promise<void>;
-    getCryptoAddress(id: string): Promise<CryptoAddress>;
-    createCryptoAddress(address: string, crypto: Crypto, userId?: string, label?: string): Promise<CryptoAddress>;
-    createBridgePlaidLink(userId: string): Promise<string>;
-    createBridgeExternalAccount(userId: string, bankName: string, accountNumber: string, routingNumber: string, accountOwnerName: string, address: {
-        street1: string;
-        street2?: string;
-        city: string;
-        state: string;
-        postalCode: string;
-        country: CountryOfOrigin;
-    }): Promise<string>;
-    createBankAccount(userId: string, country: Country, fiat: Fiat, bankName: string, accountHolderName: string, accountNumber?: string, routingNumber?: string, CLABE?: string, CCI?: string, notes?: string, address?: {
-        street1: string;
-        street2?: string;
-        city: string;
-        state: string;
-        postalCode: string;
-        country: CountryOfOrigin;
-    }): Promise<BankAccount>;
-    updateBankAccount(id: string, data: {
-        notes?: string;
-    }): Promise<BankAccount>;
-    getFeesByVolume(): Promise<{
-        days: number;
-        fee: number;
-        volume: number;
-    }>;
-    getAggregateVolume(): Promise<{
-        volume: number;
-        revenue: number;
-    }>;
-    getTransactionLimits(userId: string): Promise<{
-        limit: number;
-        used: number;
-    }>;
-    getQuote(id: string): Promise<Quote>;
-    getChainedQuote(id: string): Promise<ChainedQuote>;
-    createVerificationLink(userId: string, firstName: string, lastName: string): Promise<string>;
-    getPaymentMethods(fiat: Fiat, country: Country): Promise<PaymentMethod[]>;
-    getBankAccounts(page: number, limit: number, query?: BankAccountQuery): Promise<BankAccount[]>;
-    getBankAccount(id: string): Promise<BankAccount>;
-    getSupportedPayoutMethods(fiat: Fiat, country: Country): Promise<PayoutMethod[]>;
-    createKushkiPayment(orderId: string, token: string): Promise<{
-        paymentId: string;
-    }>;
-    addAuthorizedPhoneNumber(phoneNumber: string, userId?: string): Promise<User>;
-    deleteAuthorizedPhoneNumber(phoneNumber: string, userId: string): Promise<User>;
-    createKushkiBankPayment(orderId: string): Promise<any>;
-    updateAuth(update: AuthUpdate, id: string): Promise<Auth>;
-    getInvoice(orderId: string): Promise<Invoice>;
-    createOnboardingByLink(userType: UserType, countryOfOperation: Country, brokerId?: string, referrerId?: string): Promise<{
-        id: string;
-        kycLink: string;
-    }>;
-    createUSOnboardingByLink({ userType, businessName, firstName, middleName, lastName, secondLastName, email, brokerId, referrerId, }: {
-        userType: UserType;
-        businessName?: string;
-        firstName?: string;
-        middleName?: string;
-        lastName?: string;
-        secondLastName?: string;
-        email: string;
-        brokerId?: string;
-        referrerId?: string;
-    }): Promise<{
-        id: string;
-        kycLink: string;
-        tosLink: string;
-    }>;
-    createIncrementalOnboardingByLink(userId: string, countryOfOperation: Country): Promise<{
-        id: string;
-        kycLink: string;
-    }>;
-    createIncrementalUSOnboardingByLink(userId: string): Promise<{
-        id: string;
-        kycLink: string;
-        tosLink: string;
-    }>;
-    getOnboarding(id: string): Promise<Onboarding>;
-    createWebhookRegistration({ userId, brokerId, type, url, }: {
-        userId?: string;
-        brokerId?: string;
-        type: WebhookType;
-        url: string;
-    }): Promise<{
-        id: string;
-        secret: string;
-    }>;
-    getWebhookRegistrations(page: number, query?: {
-        userId?: string;
-        brokerId?: string;
-    }): Promise<WebhookRegistration[]>;
-    getWebhookRegistration(id: string): Promise<WebhookRegistration>;
-    deleteWebhookRegistration(id: string): Promise<void>;
-}