@yuno-payments/dashboard-api-mfe 1.10.6 → 1.10.8

package/build/lib/http-client/http-client.d.ts

@@ -0,0 +1,175 @@
+import { Axios } from './axios';
+import { AxiosRequestConfig, AxiosResponse, AxiosError, CancelTokenSource } from 'axios';
+/**
+ * Serializes parameters for URL query string with proper encoding
+ * and handling of arrays without duplication
+ * @param params - Object with parameters to serialize
+ * @returns URL encoded query string
+ */
+export declare const serializeParams: (params: Record<string, any>) => string;
+/**
+ * @class Api Class is a fancy es6 wrapper class for axios.
+ *
+ * @param {import("axios").AxiosRequestConfig} config - axios Request Config.
+ * @link [AxiosRequestConfig](https://github.com/axios/axios#request-config)
+ */
+export declare class HttpClient extends Axios {
+    private token;
+    private cancelToken;
+    /**
+     * Creates an instance of api.
+     * @param {import("axios").AxiosRequestConfig} conf
+     */
+    constructor(conf: AxiosRequestConfig);
+    /**
+     * Gets Token.
+     *
+     * @returns {string} token.
+     * @memberof Api
+     */
+    getToken(): string;
+    /**
+     * Sets Token.
+     *
+     * @param {string} token - token.
+     * @memberof Api
+     */
+    setToken(token: string): void;
+    /**
+     * Get Uri
+     *
+     * @param {import("axios").AxiosRequestConfig} [config]
+     * @returns {string}
+     * @memberof Api
+     */
+    getUri(config?: AxiosRequestConfig): string;
+    getCancelTokenSource(): CancelTokenSource;
+    /**
+     * Generic request.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP axios response payload.
+     * @memberof Api
+     *
+     * @example
+     * api.request({
+     *   method: "GET|POST|DELETE|PUT|PATCH"
+     *   baseUrl: "http://www.domain.com",
+     *   url: "/api/v1/users",
+     *   headers: {
+     *     "Content-Type": "application/json"
+     *  }
+     * }).then((response: AxiosResponse<User>) => response.data)
+     *
+     */
+    request<T, R = AxiosResponse<T>>(config: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP GET method, used to fetch data `statusCode`: 200.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} HTTP `axios` response payload.
+     * @memberof Api
+     */
+    get<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP OPTIONS method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} HTTP `axios` response payload.
+     * @memberof Api
+     */
+    options<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP DELETE method, `statusCode`: 204 No Content.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    delete<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP HEAD method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    head<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP POST method `statusCode`: 201 Created.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template B - `BODY`: body request object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {B} data - payload to be send as the `request body`,
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    post<T, B, R = AxiosResponse<T>>(url: string, data?: B, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP PUT method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template B - `BODY`: body request object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {B} data - payload to be send as the `request body`,
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    put<T, B, R = AxiosResponse<T>>(url: string, data?: B, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP PATCH method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template B - `BODY`: body request object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {B} data - payload to be send as the `request body`,
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    patch<T, B, R = AxiosResponse<T>>(url: string, data?: B, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     *
+     * @template T - type.
+     * @param {import("axios").AxiosResponse<T>} response - axios response.
+     * @returns {T} - expected object.
+     * @memberof Api
+     */
+    success<T>(response: AxiosResponse<T>): T;
+    /**
+     *
+     *
+     * @template T type.
+     * @param {AxiosError<T>} error
+     * @memberof Api
+     */
+    error<T>(error: AxiosError<T>): void;
+}

package/build/lib/http-client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './http-client';
+export * from './api.config';

package/build/msw/browser.d.ts

@@ -0,0 +1 @@
+export declare const worker: import("msw/browser").SetupWorker;

package/build/msw/handlers/api-logs.d.ts

@@ -0,0 +1 @@
+export declare const apiLogsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/index.d.ts

@@ -0,0 +1 @@
+export declare const handlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/insights.d.ts

@@ -0,0 +1 @@
+export declare const insightsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/installments.d.ts

@@ -0,0 +1 @@
+export declare const installmentsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/organizations.d.ts

@@ -0,0 +1 @@
+export declare const organizationsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/payments.d.ts

@@ -0,0 +1 @@
+export declare const paymentsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/reconciliation-insights.d.ts

@@ -0,0 +1 @@
+export declare const reconciliationInsightsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/handlers/webhooks.d.ts

@@ -0,0 +1 @@
+export declare const webhooksHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/index.d.ts

@@ -0,0 +1 @@
+export declare function enableMocking(): Promise<void>;

package/build/msw/mocks/api-logs/api-logs-v3.mock.d.ts

@@ -0,0 +1,2 @@
+import { Audit } from '../../../types';
+export declare const apiLogsV3Mock: Audit.ApiLogsV3Response;

package/build/msw/mocks/insights/conversion-rate/overview-fraud-3ds.mock.d.ts

@@ -0,0 +1,14 @@
+export declare const conversionRateOverviewFraud3dsMock: {
+    fraud: {
+        conversion_rate_fraud_transactions: number;
+        conversion_fraud_transactions_periodicity: null;
+    };
+    '3ds': {
+        conversion_rate_card_transactions3ds: number;
+        conversion_rate_card_transactions3ds_periodicity: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+};

package/build/msw/mocks/insights/conversion-rate/overview.mock.d.ts

@@ -0,0 +1,34 @@
+export declare const conversionRateOverviewMock: {
+    total: {
+        total_conversion_rate: number;
+        insight_payment_total_conversion_rate_periodicity: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+    cards: {
+        cards_approvals_rate: number;
+        insight_payment_total_conversion_rate_periodicity_for_card: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+    apms: {
+        apms_conversion_rate: number;
+        insight_payment_total_conversion_rate_periodicity_for_apm: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+    cards_without_insufficient_funds: {
+        without_insufficient_funds_conversion_rate: number;
+        insight_conversion_rate_without_insufficient_funds: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+};

package/build/msw/mocks/insights/overview/overview-metrics.mock.d.ts

@@ -0,0 +1,9 @@
+export declare enum OverviewMetricType {
+    GENERAL = "volume-and-total-payments",
+    LATENCY = "provider-latency",
+    STATUS = "status",
+    SUBSCRIPTIONS = "subscriptions"
+}
+export declare const oldOverviewMetricsHandler: import("msw/lib/core/handlers/HttpHandler").HttpHandler;
+export declare const newOverviewMetricsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];
+export declare const overviewMetricsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/msw/mocks/insights/overview/overview.mock.d.ts

@@ -0,0 +1,139 @@
+export declare const OVERVIEW_MOCK: {
+    sales_volume_metric_group: {
+        distribution: {
+            key: string;
+            total: number;
+        }[];
+        total: number;
+        average: number;
+    };
+    total_payments: {
+        distribution: {
+            key: string;
+            total: number;
+        }[];
+        total: number;
+        average: number;
+    };
+    average_ticket: {
+        distribution: {
+            key: string;
+            total: number;
+            min_ticket: number;
+            max_ticket: number;
+        }[];
+        total: number;
+        min_ticket: number;
+        max_ticket: number;
+    };
+    conversion_rate: null;
+    total_payments_and_conversion_rate: {
+        payments: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        conversion_rate: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+    };
+    quantity_status_distribution: ({
+        SUCCEEDED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        DECLINED?: undefined;
+    } | {
+        DECLINED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        SUCCEEDED?: undefined;
+    })[];
+    volume_successful_payments: number;
+    volume_successful_payments_by_periodicity: {
+        key: string;
+        total: number;
+    }[];
+    quantity_successful_payments: number;
+    quantity_successful_payments_by_periodicity: {
+        key: string;
+        total: number;
+    }[];
+    average_provider_latency: ({
+        PAYMENTEZ: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        NUVEI?: undefined;
+        WOMPI?: undefined;
+    } | {
+        NUVEI: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        PAYMENTEZ?: undefined;
+        WOMPI?: undefined;
+    } | {
+        WOMPI: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        PAYMENTEZ?: undefined;
+        NUVEI?: undefined;
+    })[];
+    total_subscriptions_and_conversion_rate: {
+        subscriptions: {
+            distribution: null;
+            total: number;
+        };
+        subscriptions_succeeded: {
+            distribution: null;
+            total: number;
+        };
+        conversion_rate: {
+            distribution: null;
+            total: number;
+        };
+    };
+    total_status_distribution: ({
+        SUCCEEDED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        DECLINED?: undefined;
+    } | {
+        DECLINED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        SUCCEEDED?: undefined;
+    })[];
+};

package/build/msw/mocks/installments/installments.mock.d.ts

@@ -0,0 +1,8 @@
+import { Installments } from '../../../types';
+export declare const installmentsPlansMock: Installments.GetInstallmentsPlansResponse;
+export declare const createInstallmentsPlanMock: Installments.CreateInstallmentsPlanResponse;
+export declare const updateInstallmentsPlanMock: Installments.UpdateInstallmentsPlanResponse;
+export declare const deleteInstallmentsPlanMock: Installments.DeleteInstallmentsPlanResponse;
+export declare const searchInstallmentsPlansMock: Installments.SearchInstallmentsPlansResponse;
+export declare const bulkCreateInstallmentsPlansMock: Installments.BulkCreateInstallmentsPlansResponse;
+export declare const bulkDeleteInstallmentsPlansMock: Installments.BulkDeleteInstallmentsPlansResponse;

package/build/msw/mocks/payments/payments.mock.d.ts

@@ -0,0 +1,92 @@
+export declare const paymentsMock: {
+    content: ({
+        test_credential: boolean;
+        organization_code: string;
+        account_code: string;
+        id: number;
+        code: string;
+        order_id: string;
+        status: string;
+        sub_status: string;
+        amount_value: number;
+        currency_code: string;
+        created_at: string;
+        updated_at: string;
+        captured: number;
+        refunded: number;
+        country: string;
+        customer_code: string;
+        description: string;
+        subscription_id: string;
+        condition_set_id: number;
+        payment_type: string;
+        transaction_payment: {
+            code: string;
+            provider_id: string;
+            payment_method_type: string;
+            parent_payment_method_type: null;
+        }[];
+        customer_payer: {
+            customer_payer_id: number;
+            payment_id: number;
+            document_number: string;
+            email: string;
+        }[];
+        card_transaction: {
+            card_transaction_id: number;
+            transaction_id: number;
+            three_ds_electronic_commerce_indicator: null;
+            three_ds_transaction_id: null;
+            bin: string;
+            brand: string;
+            installments: number;
+            network_token: null;
+        }[];
+        bnpl_transaction: never[];
+    } | {
+        organization_code: string;
+        account_code: string;
+        id: number;
+        code: string;
+        order_id: string;
+        status: string;
+        sub_status: string;
+        amount_value: number;
+        currency_code: string;
+        created_at: string;
+        updated_at: string;
+        captured: number;
+        refunded: number;
+        country: string;
+        customer_code: string;
+        description: string;
+        subscription_id: string;
+        condition_set_id: number;
+        payment_type: string;
+        transaction_payment: {
+            code: string;
+            provider_id: string;
+            payment_method_type: string;
+            parent_payment_method_type: null;
+        }[];
+        customer_payer: {
+            customer_payer_id: number;
+            payment_id: number;
+            document_number: string;
+            email: string;
+        }[];
+        card_transaction: {
+            card_transaction_id: number;
+            transaction_id: number;
+            three_ds_electronic_commerce_indicator: null;
+            three_ds_transaction_id: null;
+            bin: string;
+            brand: string;
+            installments: number;
+            network_token: null;
+        }[];
+        bnpl_transaction: never[];
+        test_credential?: undefined;
+    })[];
+    last_page: boolean;
+};