@cuenca-mx/cuenca-js 1.2.2 → 2.0.0-dev0

package/build/dts/client/client.d.ts

@@ -0,0 +1,86 @@
+export class Client {
+    constructor({ apiKey, apiSecret, language, phase, }?: {
+        apiKey: any;
+        apiSecret: any;
+        language?: string | undefined;
+        phase?: "sandbox" | undefined;
+    });
+    phase: "sandbox";
+    basicAuth: {
+        apiKey: any;
+        apiSecret: any;
+    };
+    jwtToken: Jwt | null;
+    _defaultHeaders: {
+        'Accept-Language': string;
+    };
+    _sessionHeaders: {};
+    _timeout: number;
+    _session: {
+        request: (config: any) => Promise<{
+            data: any;
+            status: any;
+            headers: any;
+        }>;
+    };
+    get session(): {
+        request: (config: any) => Promise<{
+            data: any;
+            status: any;
+            headers: any;
+        }>;
+    };
+    get origin(): string;
+    get authHeader(): string;
+    addHeadersToRequest(obj: any): {
+        eject: () => void;
+    };
+    deleteRequestHeader(header: any): {
+        eject: () => void;
+    };
+    configure({ apiKey, apiSecret, loginToken, phase, sessionId, useJwt, }: {
+        apiKey: any;
+        apiSecret: any;
+        loginToken: any;
+        phase: any;
+        sessionId: any;
+        useJwt?: boolean | undefined;
+    }): Promise<void>;
+    get({ endpoint, format, params, headers, responseType }: {
+        endpoint: any;
+        format: any;
+        params: any;
+        headers: any;
+        responseType: any;
+    }): Promise<any>;
+    post({ endpoint, data, multipart, headers, responseType }: {
+        endpoint: any;
+        data: any;
+        multipart: any;
+        headers: any;
+        responseType: any;
+    }): Promise<any>;
+    patch({ endpoint, data, headers }: {
+        endpoint: any;
+        data: any;
+        headers: any;
+    }): Promise<any>;
+    delete({ endpoint, data, headers }: {
+        endpoint: any;
+        data: any;
+        headers: any;
+    }): Promise<any>;
+    request({ endpoint, data, format, method, multipart, params, headers: extraHeaders, responseType, timeout, signal, }: {
+        endpoint: any;
+        data?: null | undefined;
+        format?: "application/json" | undefined;
+        method?: string | undefined;
+        multipart?: boolean | undefined;
+        params?: null | undefined;
+        headers?: null | undefined;
+        responseType: any;
+        timeout: any;
+        signal: any;
+    }): Promise<any>;
+}
+import { Jwt } from "..";

package/build/dts/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/build/dts/errors.d.ts

@@ -0,0 +1,25 @@
+export class CuencaException extends Error {
+    constructor(msg: any);
+}
+export class CuencaResponseException extends CuencaException {
+    constructor(data: any, status: any);
+    data: any;
+    status: any;
+}
+export class NoResultFound extends CuencaException {
+    constructor();
+}
+export class MultipleResultsFound extends CuencaException {
+    constructor();
+}
+export class MalformedJwtToken extends CuencaException {
+    constructor();
+}
+export class InvalidPassword extends CuencaException {
+    constructor();
+}
+export class ValidationError extends Error {
+    constructor(msg: any);
+}
+export class PaginationError extends CuencaException {
+}

package/build/dts/helpers/case.d.ts

@@ -0,0 +1,5 @@
+export type WireObject = Record<string, unknown>;
+export declare function camelize(value: WireObject): WireObject;
+export declare function camelize(value: unknown): unknown;
+export declare function snakeize(value: WireObject): WireObject;
+export declare function snakeize(value: unknown): unknown;

package/build/dts/helpers/data.d.ts

@@ -0,0 +1,3 @@
+export function dateToUTC(date: any): Date | null;
+export function coerceDates(obj: any, fields: any): any;
+export function coerceDatesWithDefaults(obj: any, fields: any): any;

package/build/dts/helpers/env.d.ts

@@ -0,0 +1,7 @@
+export namespace runtimeEnv {
+    export { isBrowser };
+    export { isNode };
+}
+declare const isBrowser: boolean;
+declare const isNode: boolean;
+export {};

package/build/dts/index.d.ts

@@ -0,0 +1,52 @@
+import { Client } from './client';
+import { AccountResource, AlertResource, ApiKeyResource, ArpcResource, BalanceEntryResource, BillPaymentResource, BridgeAccountResource, BridgeBankAccountResource, BridgeClabeResource, BridgeTransactionResource, CardActivationResource, CardResource, CardTransactionResource, CardValidationResource, CommissionResource, DepositResource, FileResource, FraudFundsTransferResource, KYCValidationsResource, LoginTokenResource, PartnerResource, PostalCodeResource, ReportResource, SavingResource, ServiceProviderResource, SessionResource, StatementResource, TransferResource, UserCredentialResource, UserLoginResource, UserReportResource, UserResource, UsersTosAgreementsResource, VerificationResource, WalletTransactionsResource, WhatsAppTransferResource } from './resources';
+interface CuencaOptions {
+    apiKey?: string;
+    apiSecret?: string;
+    language?: string;
+    phase?: string;
+}
+export declare class Cuenca {
+    client: Client;
+    accounts: AccountResource;
+    alerts: AlertResource;
+    apiKeys: ApiKeyResource;
+    arpc: ArpcResource;
+    balanceEntries: BalanceEntryResource;
+    billPayments: BillPaymentResource;
+    bridgeAccounts: BridgeAccountResource;
+    bridgeBankAccounts: BridgeBankAccountResource;
+    bridgeClabes: BridgeClabeResource;
+    bridgeKycValidations: KYCValidationsResource;
+    bridgeSessions: SessionResource;
+    bridgeTransactions: BridgeTransactionResource;
+    cardActivations: CardActivationResource;
+    cards: CardResource;
+    cardTransactions: CardTransactionResource;
+    cardValidations: CardValidationResource;
+    commissions: CommissionResource;
+    deposits: DepositResource;
+    files: FileResource;
+    fraudFundsTransfers: FraudFundsTransferResource;
+    kycValidations: KYCValidationsResource;
+    loginTokens: LoginTokenResource;
+    partners: PartnerResource;
+    postalCodes: PostalCodeResource;
+    reports: ReportResource;
+    savings: SavingResource;
+    serviceProviders: ServiceProviderResource;
+    sessions: SessionResource;
+    statements: StatementResource;
+    transfers: TransferResource;
+    userCredentials: UserCredentialResource;
+    userLogins: UserLoginResource;
+    users: UserResource;
+    userReports: UserReportResource;
+    usersTosAgreements: UsersTosAgreementsResource;
+    verifications: VerificationResource;
+    walletTransactions: WalletTransactionsResource;
+    whatsAppTransfers: WhatsAppTransferResource;
+    constructor({ apiKey, apiSecret, language, phase, }?: CuencaOptions);
+    withClient(client: Client): void;
+}
+export {};

package/build/dts/jwt.d.ts

@@ -0,0 +1,8 @@
+export class Jwt {
+    static getExpirationDate: (token: any) => Date;
+    static create: (client: any) => Promise<Jwt>;
+    constructor(expiresAt: any, token: any);
+    expiresAt: any;
+    token: any;
+    get isExpired(): boolean;
+}

package/build/dts/models/account.d.ts

@@ -0,0 +1,12 @@
+import { WireObject } from '../helpers/case';
+export interface Account {
+    accountNumber?: string;
+    createdAt?: Date | null;
+    id?: string;
+    institutionName?: string;
+    name?: string;
+    userId?: string;
+}
+export declare const Account: {
+    fromObject: (obj: WireObject) => Account;
+};

package/build/dts/models/alert.d.ts

@@ -0,0 +1,32 @@
+import { WireObject } from '../helpers/case';
+import { AlertLog } from '../types';
+export interface Alert {
+    accountNumber?: string;
+    actualPeriodCount?: number;
+    actualPeriodSum?: number;
+    agent?: string;
+    aggregationType?: string;
+    changeLog?: AlertLog[];
+    comments?: string;
+    committeeMeetingDate?: Date | null;
+    createdAt?: Date | null;
+    questionnaireId?: string;
+    description?: string;
+    hasQuestionnaire?: boolean;
+    id?: string;
+    institutionName?: string;
+    level?: string;
+    name?: string;
+    period?: string;
+    periodNumber?: number;
+    status?: string;
+    sourceType?: string;
+    transactionDate?: Date | null;
+    type?: string;
+    typeOfFilter?: string;
+    userId?: string;
+    updatedAt?: Date | null;
+}
+export declare const Alert: {
+    fromObject: (obj: WireObject) => Alert;
+};

package/build/dts/models/apiKey.d.ts

@@ -0,0 +1,13 @@
+import { WireObject } from '../helpers/case';
+export interface ApiKey {
+    createdAt?: Date | null;
+    deactivatedAt?: Date | null;
+    id?: string;
+    secret?: string;
+    userId?: string;
+    updatedAt?: Date | null;
+}
+export declare const ApiKey: {
+    fromObject: (obj: WireObject) => ApiKey;
+    isActive: (apiKey: ApiKey) => boolean;
+};

package/build/dts/models/arpc.d.ts

@@ -0,0 +1,10 @@
+import { WireObject } from '../helpers/case';
+export interface Arpc {
+    arpc?: string;
+    createdAt?: Date | null;
+    cardUri?: string;
+    isValidArqc?: boolean;
+}
+export declare const Arpc: {
+    fromObject: (obj: WireObject) => Arpc;
+};

package/build/dts/models/balanceEntry.d.ts

@@ -0,0 +1,15 @@
+import { WireObject } from '../helpers/case';
+export interface BalanceEntry {
+    amount?: number;
+    createdAt?: Date | null;
+    descriptor?: string;
+    entryType?: string;
+    fundingInstrumentUri?: string;
+    id?: string;
+    name?: string;
+    relatedTransactionUri?: string;
+    rollingBalance?: number;
+}
+export declare const BalanceEntry: {
+    fromObject: (obj: WireObject) => BalanceEntry;
+};

package/build/dts/models/baseUser.d.ts

@@ -0,0 +1,23 @@
+import { WireObject } from '../helpers/case';
+import { Address } from '../types';
+export interface BaseUser {
+    address?: Address;
+    clabe?: string;
+    emailAddress?: string;
+    id?: string;
+    level?: number;
+    meta?: WireObject;
+    nationality?: string;
+    platformId?: string;
+    phoneNumber?: string;
+    requiredLevel?: number;
+    rfc?: string;
+    status?: string;
+    createdAt?: Date | null;
+    updatedAt?: Date | null;
+    userType?: string;
+}
+export declare const BaseUser: {
+    fromObject: (obj: WireObject) => BaseUser;
+};
+export default BaseUser;

package/build/dts/models/billPayment.d.ts

@@ -0,0 +1,10 @@
+import { WireObject } from '../helpers/case';
+import { Transaction } from './transaction';
+export interface BillPayment extends Transaction {
+    accountNumber?: string;
+    id?: string;
+    providerUri?: string;
+}
+export declare const BillPayment: {
+    fromObject: (obj: WireObject) => BillPayment;
+};

package/build/dts/models/bridgeAccount.d.ts

@@ -0,0 +1,27 @@
+import { WireObject } from '../helpers/case';
+import { Address, KYCFile, TOSAgreements } from '../types';
+export interface BridgeAccount {
+    id?: string;
+    createdAt?: Date | null;
+    updatedAt?: Date | null;
+    names?: string;
+    firstSurname?: string;
+    secondSurname?: string;
+    dateOfBirth?: string;
+    countryOfBirth?: string;
+    rfc?: string;
+    curp?: string;
+    userId?: string;
+    gender?: string;
+    phoneNumber?: string;
+    emailAddress?: string;
+    clientClabe?: string;
+    govtId?: KYCFile;
+    proofOfAddress?: KYCFile;
+    status?: string;
+    termsOfService?: TOSAgreements;
+    address?: Address;
+}
+export declare const BridgeAccount: {
+    fromObject: (obj: WireObject) => BridgeAccount;
+};

package/build/dts/models/bridgeBankAccount.d.ts

@@ -0,0 +1,16 @@
+import { WireObject } from '../helpers/case';
+export interface BridgeBankAccount {
+    clabe?: string;
+    createdAt?: Date | null;
+    curp?: string;
+    error?: string;
+    firstName?: string;
+    id?: string;
+    names?: string;
+    rfc?: string;
+    secondSurname?: string;
+    status?: string;
+}
+export declare const BridgeBankAccount: {
+    fromObject: (obj: WireObject) => BridgeBankAccount;
+};

package/build/dts/models/bridgeClabe.d.ts

@@ -0,0 +1,12 @@
+import { WireObject } from '../helpers/case';
+export interface BridgeClabe {
+    account?: string | undefined;
+    clabe?: string | undefined;
+    currency?: string | undefined;
+    id?: string | undefined;
+    network?: string | undefined;
+    platformId?: string | undefined;
+}
+export declare const BridgeClabe: {
+    fromObject: (obj: WireObject) => BridgeClabe;
+};

package/build/dts/models/bridgeTransaction.d.ts

@@ -0,0 +1,32 @@
+import { WireObject } from '../helpers/case';
+export interface BridgeTransaction {
+    id?: string;
+    createdAt?: Date | null;
+    platformId?: string;
+    type?: string;
+    status?: string;
+    accountUri?: string;
+    quoteUri?: string;
+    currency?: string;
+    network?: string;
+    sourceWallet?: string;
+    destinationWallet?: string;
+    bankAccountUri?: string;
+    cuencaId?: string;
+    cuentaOrdenante?: string;
+    cuentaBeneficiario?: string;
+    nombreOrdenante?: string;
+    claveRastreo?: string;
+    rfcCurpOrdenante?: string;
+    concepto?: string;
+    referenciaNumerica?: number;
+    signature?: string;
+    trackingLink?: string;
+    fromCurrency?: string;
+    toCurrency?: string;
+    fromAmount?: number;
+    toAmount?: number;
+}
+export declare const BridgeTransaction: {
+    fromObject: (obj: WireObject) => BridgeTransaction;
+};

package/build/dts/models/card.d.ts

@@ -0,0 +1,19 @@
+import { WireObject } from '../helpers/case';
+export interface Card {
+    createdAt?: Date | null;
+    cvv2?: string;
+    expMonth?: number;
+    expYear?: number;
+    fundingType?: string;
+    id?: string;
+    issuer?: string;
+    number?: string;
+    pin?: string;
+    status?: string;
+    type?: string;
+    updatedAt?: Date | null;
+    userId?: string;
+}
+export declare const Card: {
+    fromObject: (obj: WireObject) => Card;
+};

package/build/dts/models/cardActivation.d.ts

@@ -0,0 +1,12 @@
+import { WireObject } from '../helpers/case';
+export interface CardActivation {
+    cardUri?: string;
+    createdAt?: Date | null;
+    id?: string;
+    ipAddress?: string;
+    success?: boolean;
+    userId?: string;
+}
+export declare const CardActivation: {
+    fromObject: (obj: WireObject) => CardActivation;
+};

package/build/dts/models/cardTransaction.d.ts

@@ -0,0 +1,15 @@
+import { WireObject } from '../helpers/case';
+import { Transaction } from './transaction';
+export interface CardTransaction extends Transaction {
+    cardErrorType?: string;
+    cardLastFour?: string;
+    cardType?: string;
+    cardUri?: string;
+    metadata?: WireObject;
+    network?: string;
+    relatedCardTransactionsUris?: unknown[];
+    type?: string;
+}
+export declare const CardTransaction: {
+    fromObject: (obj: WireObject) => CardTransaction;
+};

package/build/dts/models/cardValidation.d.ts

@@ -0,0 +1,19 @@
+import { WireObject } from '../helpers/case';
+export interface CardValidation {
+    cardStatus?: string;
+    cardType?: string;
+    cardUri?: string;
+    createdAt?: Date | null;
+    isExpired?: boolean;
+    isPinAttemptsExceeded?: boolean;
+    isValidCvv?: boolean;
+    isValidCvv2?: boolean;
+    isValidExpDate?: boolean;
+    isValidIcvv?: boolean;
+    isValidPinBlock?: boolean;
+    userId?: string;
+}
+export declare const CardValidation: {
+    fromObject: (obj: WireObject) => CardValidation;
+    isActive: (validation: CardValidation) => boolean;
+};

package/build/dts/models/commission.d.ts

@@ -0,0 +1,9 @@
+import { WireObject } from '../helpers/case';
+import { Transaction } from './transaction';
+export interface Commission extends Transaction {
+    relatedTransactionUri?: string;
+    type?: string;
+}
+export declare const Commission: {
+    fromObject: (obj: WireObject) => Commission;
+};

package/build/dts/models/deposit.d.ts

@@ -0,0 +1,11 @@
+import { WireObject } from '../helpers/case';
+import { Transaction } from './transaction';
+export interface Deposit extends Transaction {
+    id?: string;
+    network?: string;
+    sourceUri?: string;
+    trackingKey?: string;
+}
+export declare const Deposit: {
+    fromObject: (obj: WireObject) => Deposit;
+};

package/build/dts/models/file.d.ts

@@ -0,0 +1,10 @@
+import { WireObject } from '../helpers/case';
+export interface File {
+    extension?: string;
+    type?: string;
+    url?: string;
+    userId?: string;
+}
+export declare const File: {
+    fromObject: (obj: WireObject) => File;
+};

package/build/dts/models/fraudFundsTransfer.d.ts

@@ -0,0 +1,9 @@
+import { WireObject } from '../helpers/case';
+export interface FraudFundsTransfer {
+    transactionId?: string | null;
+    amount?: number | null;
+    claveRastreo?: string | null;
+}
+export declare const FraudFundsTransfer: {
+    fromObject: (obj: WireObject) => FraudFundsTransfer;
+};

package/build/dts/models/index.d.ts

@@ -0,0 +1,38 @@
+export { Account } from './account';
+export { Alert } from './alert';
+export { ApiKey } from './apiKey';
+export { Arpc } from './arpc';
+export { BalanceEntry } from './balanceEntry';
+export { BillPayment } from './billPayment';
+export { BridgeAccount } from './bridgeAccount';
+export { BridgeBankAccount } from './bridgeBankAccount';
+export { BridgeClabe } from './bridgeClabe';
+export { BridgeTransaction } from './bridgeTransaction';
+export { Card } from './card';
+export { CardActivation } from './cardActivation';
+export { CardTransaction } from './cardTransaction';
+export { CardValidation } from './cardValidation';
+export { Commission } from './commission';
+export { Deposit } from './deposit';
+export { File } from './file';
+export { FraudFundsTransfer } from './fraudFundsTransfer';
+export { KYCValidations } from './kycValidations';
+export { LoginToken } from './loginToken';
+export { Partner } from './partner';
+export { PostalCode } from './postalCode';
+export { Saving } from './saving';
+export { ServiceProvider } from './serviceProvider';
+export { Session } from './session';
+export { Statement } from './statement';
+export type { Transaction } from './transaction';
+export { TransactionalProfile } from './transactionalProfile';
+export { Transfer } from './transfer';
+export { User } from './user';
+export { UserCredential } from './userCredential';
+export { UserLogin } from './userLogin';
+export { UserReport } from './userReport';
+export { UserTosAgreement } from './userTosAgreement';
+export { Verification } from './verification';
+export type { Wallet } from './wallet';
+export { WalletTransaction } from './walletTransaction';
+export { WhatsAppTransfer } from './whatsAppTransfer';

package/build/dts/models/kycValidations.d.ts

@@ -0,0 +1,22 @@
+import { WireObject } from '../helpers/case';
+export interface KYCValidations {
+    id?: string;
+    createdAt?: Date | null;
+    updatedAt?: Date | null;
+    deactivatedAt?: Date | null;
+    platformId?: string;
+    filesUri?: unknown[];
+    userId?: string;
+    verificationId?: string;
+    identityId?: string;
+    govtIdStatus?: string;
+    proofOfAddressStatus?: string;
+    proofOfLifeStatus?: string;
+    sourceType?: string;
+    flowId?: string;
+    status?: string;
+    providerUrl?: string;
+}
+export declare const KYCValidations: {
+    fromObject: (obj: WireObject) => KYCValidations;
+};

package/build/dts/models/loginToken.d.ts

@@ -0,0 +1,7 @@
+import { WireObject } from '../helpers/case';
+export interface LoginToken {
+    id?: string | undefined;
+}
+export declare const LoginToken: {
+    fromObject: (obj: WireObject) => LoginToken;
+};

package/build/dts/models/partner.d.ts

@@ -0,0 +1,25 @@
+import { WireObject } from '../helpers/case';
+import { Audit, BusinessDetails, ExternalAccount, LegalRepresentatives, License, ShareholderMoral, VulnerableActivity } from '../types';
+import { BaseUser } from './baseUser';
+import { TransactionalProfile } from './transactionalProfile';
+export interface Partner extends BaseUser {
+    audit?: Audit;
+    businessModel?: WireObject;
+    businessName?: string;
+    businessDetails?: BusinessDetails;
+    documentationUrl?: string;
+    incorporationDate?: Date | null;
+    externalAccount?: ExternalAccount;
+    folio?: string;
+    legalName?: string;
+    license?: License;
+    shareholders?: ShareholderMoral[];
+    legalRepresentatives?: LegalRepresentatives[];
+    transactionalProfile?: TransactionalProfile;
+    userId?: string;
+    vulnerableActivity?: VulnerableActivity;
+    webSite?: string;
+}
+export declare const Partner: {
+    fromObject: (obj: WireObject) => Partner;
+};

package/build/dts/models/postalCode.d.ts

@@ -0,0 +1,14 @@
+import { WireObject } from '../helpers/case';
+export interface PostalCode {
+    id?: string;
+    postalCode?: string;
+    colonia?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    createdAt?: Date | null;
+    updatedAt?: Date | null;
+}
+export declare const PostalCode: {
+    fromObject: (obj: WireObject) => PostalCode;
+};

package/build/dts/models/saving.d.ts

@@ -0,0 +1,11 @@
+import { WireObject } from '../helpers/case';
+import { Wallet } from './wallet';
+export interface Saving extends Wallet {
+    category?: string;
+    goalAmount?: number;
+    goalDate?: Date | null;
+    name?: string;
+}
+export declare const Saving: {
+    fromObject: (obj: WireObject) => Saving;
+};

package/build/dts/models/serviceProvider.d.ts

@@ -0,0 +1,10 @@
+import { WireObject } from '../helpers/case';
+export interface ServiceProvider {
+    categories?: string[];
+    id?: string;
+    name?: string;
+    providerKey?: string;
+}
+export declare const ServiceProvider: {
+    fromObject: (obj: WireObject) => ServiceProvider;
+};