@yuno-payments/dashboard-api-mfe 2.5.0 → 2.7.0

package/build/types/data-report/data-report.d.ts

@@ -0,0 +1,70 @@
+export declare namespace DataReport {
+    export enum InsightsVolumeMetricsV2Path {
+        REFUNDS_AND_CHARGEBACKS = "refunds-and-chargebacks",
+        APPROVED_PAYMENTS = "approved-payments",
+        PAYMENT_METHODS = "payment-methods",
+        PROVIDERS = "providers",
+        COUNTRIES = "countries",
+        UNIQUE_CUSTOMER_PAYMENTS = "unique-customer-payments",
+        TOTAL_PAYMENTS = "total-payments",
+        CARD_TYPES = "card-types",
+        CARD_BRANDS = "card-brands",
+        ISSUERS = "issuers"
+    }
+    export interface SmartRouting {
+        version: string;
+        code_integration: string;
+        Conditions: {
+            minutes: number;
+            approvalRate: {
+                SUCCEEDED: number;
+                REJECTED: number;
+                ERROR: number;
+            };
+            cost: number;
+        }[];
+    }
+    export enum OverviewMetricType {
+        GENERAL = "volume-and-total-payments",
+        LATENCY = "provider-latency",
+        STATUS = "status",
+        SUBSCRIPTIONS = "subscriptions"
+    }
+    interface MetadataField {
+        field: string;
+        formatType: 'TEXT' | 'NUMBER';
+        type: string;
+        values: string | string[];
+    }
+    interface MetadataFieldFilter {
+        key: string;
+        conditional: string;
+        values: string | string[];
+    }
+    export interface InsightMetricParams {
+        [a: string]: string | boolean | number | string[] | MetadataField[] | undefined;
+        account_code?: string;
+        connection_name?: string;
+        stored_credentials_usage?: string;
+        metadata?: MetadataField[];
+    }
+    export interface InsightMetricBody {
+        account_codes?: string[];
+        account_code?: string[];
+        connection_name?: string[];
+        metadata_filters?: MetadataFieldFilter[];
+        metadata?: MetadataField[];
+    }
+    export interface InsightExportParams {
+        type?: string;
+        code?: string;
+    }
+    export interface InsightsHomeMetrics {
+        account_codes?: string[];
+        organization_code?: string;
+        currency_code?: string;
+        timezone?: string;
+        isLiveMode?: boolean;
+    }
+    export {};
+}

package/build/types/data-report/fraud.types.d.ts

@@ -0,0 +1,166 @@
+export interface InsightsFraudParams {
+    start_date: string;
+    end_date: string;
+    periodicity: string;
+    provider_id: string;
+    payment_method_type: string;
+    currency_code: string;
+    timezone: string;
+    source: string;
+    new_version: boolean;
+    payment_statuses: string;
+    card_brand: string;
+}
+export interface InsightsFraudBody {
+    account_codes: string[];
+    connection_name: string[];
+}
+export interface PeriodicityRecord {
+    [key: string]: number;
+}
+export interface TotalTimeline {
+    total: number;
+    timeline: PeriodicityRecord;
+}
+interface BaseTotalsItem {
+    total_rate: number;
+    total_amount: number;
+    total_count_tx: number;
+}
+interface BaseTimelineItem {
+    periodicity: string;
+    rate: number;
+}
+interface BaseTransactionTimelineItem {
+    periodicity: string;
+    count_tx: number;
+    conversion_rate: number;
+    amount: number;
+}
+export interface FraudScreeningVolume {
+    total_conversion_rate: number;
+    insight_fraud_total_conversion_rate_periodicity: PeriodicityRecord;
+}
+export interface FraudScreeningCount {
+    total_count_tx: number;
+    insight_fraud_count_tx_periodicity: PeriodicityRecord;
+}
+export interface InsightsFraudScreeningResumeResponse {
+    total_volume: FraudScreeningVolume;
+    succeeded_volume: FraudScreeningVolume;
+    not_succeeded_volume: FraudScreeningVolume;
+    total_count_tx: FraudScreeningCount;
+    succeeded_count_tx: FraudScreeningCount;
+    not_succeeded_count_tx: FraudScreeningCount;
+}
+export interface InsightsFraudConversionRateResponse {
+    total_conversion_rate: number;
+    insight_fraud_total_conversion_rate_and_evolution: PeriodicityRecord;
+}
+export interface Fraud3dsVolume {
+    total_conversion_rate: number;
+    insight_three_ds_total_conversion_rate_periodicity: PeriodicityRecord;
+}
+export interface Fraud3dsCount {
+    total_count_tx: number;
+    insight_three_ds_count_tx_periodicity: PeriodicityRecord;
+}
+export interface Insights3dsResumeResponse {
+    total_volume: Fraud3dsVolume;
+    succeeded_volume: Fraud3dsVolume;
+    not_succeeded_volume: Fraud3dsVolume;
+    total_count_tx: Fraud3dsCount;
+    succeeded_count_tx: Fraud3dsCount;
+    not_succeeded_count_tx: Fraud3dsCount;
+}
+export interface Insights3dsConversionRate {
+    total_conversion_rate: number;
+    insight_fraud_total_conversion_rate_and_evolution: PeriodicityRecord;
+}
+export interface Insights3dsDeclineReasons {
+    totals: (BaseTotalsItem & {
+        decline_reason: string;
+    })[];
+    timeline: (BaseTimelineItem & {
+        decline_reason: string;
+    })[];
+}
+export interface Insights3dsFrictionlessVsChallenge {
+    frictionless: {
+        total_count_tx: number;
+        total_conversion_rate: number;
+        total_amount: number;
+        timeline: BaseTransactionTimelineItem[];
+    };
+    challenge: {
+        total_count_tx: number;
+        total_conversion_rate: number;
+        total_amount: number;
+        timeline: BaseTransactionTimelineItem[];
+    };
+}
+export interface ChargebacksVolume {
+    total_conversion_rate: number;
+    insight_chargebacks_total_conversion_rate_periodicity: PeriodicityRecord;
+}
+export interface ChargebacksCount {
+    total_count_tx: number;
+    insight_chargebacks_count_tx_periodicity: PeriodicityRecord;
+}
+export interface InsightsChargebacksResumeResponse {
+    total_volume: ChargebacksVolume;
+    succeeded_volume: ChargebacksVolume;
+    not_succeeded_volume: ChargebacksVolume;
+    total_count_tx: ChargebacksCount;
+    succeeded_count_tx: ChargebacksCount;
+    not_succeeded_count_tx: ChargebacksCount;
+}
+export interface InsightsChargebacksTotalRateAndEvolution {
+    total_chargeback_rate: number;
+    chargeback_rate_periodicity: PeriodicityRecord;
+}
+export interface InsightsChargebacksWinRate {
+    total_win_rate: number;
+    insight_cbk_win_rates: PeriodicityRecord;
+}
+export interface InsightsChargebacksDisputed {
+    total_disputed: number;
+    insight_cbk_disputed: PeriodicityRecord;
+}
+export interface InsightsChargebacksStatusDistribution {
+    totals: (BaseTotalsItem & {
+        status: string;
+    })[];
+    timeline: (BaseTimelineItem & {
+        status: string;
+    })[];
+}
+export interface InsightsChargebacksByProviderAndCardBrand {
+    totals: (BaseTotalsItem & {
+        provider_and_brand: string;
+    })[];
+    timeline: (BaseTimelineItem & {
+        provider_and_brand: string;
+    })[];
+}
+export interface InsightsChargebacksByReason {
+    totals: (BaseTotalsItem & {
+        reason: string;
+    })[];
+    timeline: (BaseTimelineItem & {
+        reason: string;
+    })[];
+}
+export interface InsightsChargebacksByCardBrand {
+    insight_card_conversion_by_brand_distribution: {
+        periodicity: string;
+        card_brand: string;
+        total_payments: number;
+        total_amount: number;
+        total_amount_chargeback: number;
+        total_payments_succeeded: number;
+        total_chargeback: number;
+        chargeback_rate: number;
+    }[];
+}
+export {};

package/build/types/data-report/index.d.ts

@@ -0,0 +1,3 @@
+export * from './data-report';
+export * from './fraud.types';
+export * from './conversion-rate.types';

package/build/types/developer/developer.d.ts

@@ -0,0 +1,13 @@
+import { Organization } from '../organization';
+export declare namespace Developer {
+    interface DeveloperCredentials extends Organization.Credentials {
+        'x-account-code': string;
+    }
+}
+export interface IKeyRoll {
+    payload: {
+        expiration_in: string;
+    };
+    code: string;
+    password: string;
+}

package/build/types/developer/index.d.ts

@@ -0,0 +1 @@
+export * from './developer';

package/build/types/feature-flags/intex.d.ts

@@ -0,0 +1,13 @@
+export declare namespace FeatureFlags {
+    interface Request {
+        account_code: string;
+        organization_code: string;
+        name: string;
+        [key: string]: string;
+    }
+    interface RequestAll {
+        account_code: string;
+        organization_code: string;
+        email: string;
+    }
+}

package/build/types/field-visibility/field-visibility.d.ts

@@ -0,0 +1,6 @@
+export declare namespace FieldVisibility {
+    interface ScopedHiddenFields {
+        scope: string;
+        fields: string[];
+    }
+}

package/build/types/field-visibility/index.d.ts

@@ -0,0 +1 @@
+export * from './field-visibility';

package/build/types/fraud-screening/fraud-screening.d.ts

@@ -0,0 +1,109 @@
+export declare namespace FraudScreening {
+    interface BlackList {
+        account_code: string;
+        organization_code: string;
+        code: string;
+        name: string;
+        type: string;
+        created_at: string;
+        updated_at: string;
+        deleted_at: string;
+        elements_amount: number;
+        elements: elementBlacklist[];
+    }
+    interface BlocklistData {
+        total_pages: number;
+        total_records: number;
+        blacklists: BlackList[];
+    }
+    interface Allowlist {
+        account_code: string;
+        organization_code: string;
+        code: string;
+        name: string;
+        type: string;
+        created_at: string;
+        updated_at: string;
+        deleted_at: string;
+        allowed_payments?: number;
+        status?: string | boolean;
+        elements_amount: number;
+        elements: elementBlacklist[];
+    }
+    interface elementBlacklist {
+        element: string;
+    }
+    interface BlackListPayload {
+        type?: string;
+        name?: string;
+        page?: number;
+        code?: string;
+        size?: number | string;
+        account_codes?: string[];
+        account?: string;
+        active?: boolean | string;
+    }
+    interface PostBlockList {
+        account_codes: string[];
+        name: string;
+        page?: number;
+        size?: number;
+    }
+    interface ListItem {
+        first_value: string;
+        second_value: string;
+    }
+    interface BlackListItemsPayload {
+        blacklist_code: string;
+        expiration_days: number;
+        items: string[] | ListItem[];
+    }
+    interface EditBlackListPayload {
+        blacklist_code?: string;
+        code?: string;
+        name?: string;
+        status?: string;
+    }
+    interface DeleteBlackList {
+        account_code: string;
+        black_list_code: string;
+        item?: string;
+    }
+    interface DeleteBlockListItem {
+        account_code: string;
+        blocklist_code: string;
+        blocklist_item_id: string;
+    }
+    interface DeleteAllowListItem {
+        account_code: string;
+        allowlist_code: string;
+        allowlist_item_id: string;
+    }
+    interface ValidateBlockListItems {
+        account_code: string;
+        blocklist_code: string;
+        file_items_values?: string;
+        items_values?: string[];
+    }
+    interface ValidateAllowListItems {
+        account_code: string;
+        allowlist_code: string;
+        file_items_values?: string;
+        items_values?: string[];
+    }
+    interface BlockListSummary {
+        id: number;
+        account_code: string;
+        organization_code: string;
+        code: string;
+        name: string;
+        type: string;
+        created_at: string;
+        updated_at: string;
+        deleted_at: string | null;
+        elements_amount: number;
+        unique_elements_amount: number;
+        active: boolean;
+        blocked_payments: number;
+    }
+}

package/build/types/fraud-screening/index.d.ts

@@ -0,0 +1 @@
+export * from './fraud-screening';

package/build/types/index.d.ts

@@ -0,0 +1,42 @@
+export * from './accounts';
+export * from './chartgpt';
+export * from './payment';
+export * from './operation-transaction';
+export * from './organization';
+export * from './developer';
+export * from './connection';
+export * from './integration-requests';
+export * from './webhook';
+export * from './user';
+export * from './country';
+export * from './checkout';
+export * from './reports';
+export * from './notifications';
+export * from './smart-routing';
+export * from './routing-monitors';
+export * from './team';
+export * from './data-report';
+export * from './batch-refunds';
+export * from './reconciliation';
+export * from './fraud-screening';
+export * from './organization-settings';
+export * from './velocity-rules';
+export * from './payouts';
+export * from './audit';
+export * from './payment-links';
+export * from './saml-config';
+export * from './s3-client';
+export * from './mfa';
+export * from './translation';
+export * from './ai';
+export * from './smart-recovery';
+export * from './template-reporting';
+export * from './organization-config';
+export * from './onboarding';
+export * from './recipients';
+export * from './installments';
+export * from './concierge';
+export * from './playground';
+export * from './field-visibility';
+export * from './certificates';
+export * from './domains';

package/build/types/installments/index.d.ts

@@ -0,0 +1 @@
+export * from './installments';

package/build/types/installments/installments.d.ts

@@ -0,0 +1,129 @@
+export declare namespace Installments {
+    interface GetInstallmentsPlansParams {
+        account_id?: string | string[];
+        country_code?: string | string[];
+        brand?: string | string[];
+        name?: string;
+        merchant_reference?: string;
+        issuer?: string | string[];
+        bin?: string | string[];
+        start_date?: string;
+        end_date?: string;
+        page?: number;
+        size?: number;
+    }
+    interface FinancialCost {
+        type: 'CFT' | 'TEA' | string;
+        rate: number;
+    }
+    interface InstallmentAmount {
+        currency: string;
+        value: string;
+        total_value: string;
+    }
+    interface InstallmentPlanItem {
+        id?: string;
+        installment: number;
+        rate: number | null;
+        provider_id?: string;
+        amount?: InstallmentAmount;
+        type?: string;
+        financial_costs?: FinancialCost[];
+    }
+    interface PlanAmount {
+        currency: string;
+        min_value: string;
+        max_value: string;
+    }
+    interface Availability {
+        start_at?: string;
+        finish_at?: string;
+    }
+    interface InstallmentsPlan {
+        id?: string;
+        code: string;
+        name: string;
+        account_id: string[];
+        merchant_reference?: string;
+        installments_plan: InstallmentPlanItem[];
+        country_code: string;
+        amount: PlanAmount;
+        availability?: Availability;
+        types_list?: string[] | null;
+        payment_method_type?: string;
+        created_at?: string;
+        updated_at?: string;
+    }
+    type GetInstallmentsPlansResponse = InstallmentsPlan[];
+    interface CreateInstallmentsPlanRequest {
+        name: string;
+        merchant_reference?: string;
+        country_code: string;
+        amount?: PlanAmount;
+        installments_plan?: InstallmentPlanItem[];
+        availability?: Availability;
+        payment_method_type?: string;
+    }
+    interface CreateInstallmentsPlanResponse extends InstallmentsPlan {
+    }
+    interface UpdateInstallmentsPlanRequest {
+        name?: string;
+        merchant_reference?: string;
+        amount?: PlanAmount;
+        installments_plan?: InstallmentPlanItem[];
+        availability?: Availability;
+        payment_method_type?: string;
+    }
+    interface UpdateInstallmentsPlanResponse extends InstallmentsPlan {
+    }
+    interface DeleteInstallmentsPlanResponse {
+        deleted?: boolean;
+        message?: string;
+    }
+    interface SearchInstallmentsPlansRequest {
+        account_ids?: string[];
+        country_code?: string[];
+        brand?: string[];
+        name?: string;
+        merchant_reference?: string;
+        issuer?: string;
+        bin?: string;
+        start_date?: string;
+        end_date?: string;
+        page?: number;
+        size?: number;
+    }
+    interface SearchInstallmentsPlansResponse {
+        data: InstallmentsPlan[];
+        total: number;
+        page: number;
+        size: number;
+    }
+    interface BulkCreateInstallmentsPlansRequest {
+        account_ids: string[];
+        name: string;
+        source?: string;
+        merchant_reference?: string;
+        country_code: string;
+        amount?: PlanAmount;
+        installments_plan?: InstallmentPlanItem[];
+        availability?: Availability;
+        payment_method_type?: string;
+    }
+    interface BulkCreateInstallmentsPlansResponse {
+        created: InstallmentsPlan[];
+        errors?: string[];
+    }
+    interface BulkDeleteInstallmentsPlansRequest {
+        codes: string[];
+    }
+    interface BulkDeleteError {
+        code: string;
+        error_code: string;
+        message?: string;
+    }
+    interface BulkDeleteInstallmentsPlansResponse {
+        deleted: string[];
+        errors?: BulkDeleteError[];
+    }
+}

package/build/types/integration-requests/index.d.ts

@@ -0,0 +1 @@
+export * from './integration-request';

package/build/types/integration-requests/integration-request.d.ts

@@ -0,0 +1,26 @@
+export declare namespace IntegrationRequest {
+    /**
+     * Body sent to `POST /dashboard-bff/api/integration-requests`.
+     *
+     * The BFF marshals this into the encrypted `request` field of the
+     * `integrations-request-ms` row; `email` and `organization_code` come from
+     * the authenticated session, never from this body.
+     */
+    interface CreateIntegrationRequestPayload {
+        provider_name: string;
+        credentials: string;
+        country: string;
+        accounts: string[];
+    }
+    /**
+     * Response shape forwarded by the BFF from the MS `POST /api/v1/integration-requests`.
+     * `request` is decrypted on read.
+     */
+    interface IntegrationRequestResponse {
+        code: string;
+        organization_code: string;
+        email: string;
+        request: string;
+        created_at: string;
+    }
+}

package/build/types/mfa/index.d.ts

@@ -0,0 +1 @@
+export * from './mfa';

package/build/types/mfa/mfa.d.ts

@@ -0,0 +1,10 @@
+export declare namespace MFA {
+    type MFAStatus = 'ACTIVE' | 'PENDING' | 'INACTIVE';
+    interface MFAStatusResponse {
+        status: MFAStatus;
+    }
+    interface WorkOsMfaStatus {
+        mfa_active: boolean;
+        factor_id: string | null;
+    }
+}

package/build/types/notifications/index.d.ts

@@ -0,0 +1 @@
+export * from './notifications';

package/build/types/notifications/notifications.d.ts

@@ -0,0 +1,39 @@
+export declare namespace Notifications {
+    export interface ICreateNotificationsPayload {
+        account_code: string;
+        notification_type: string;
+        status: string;
+        customer_code: string;
+        payload: IPayload;
+    }
+    export interface IPayload {
+        text: string;
+        notification_id: string;
+    }
+    export type NotificationsResponse = {
+        updated_at: string;
+        type_notification: 'NOTIFICATION' | 'REPORTS';
+    }[];
+    export interface NotificationsBodyResponse {
+        data: NotificationsResponse;
+        content: INotificationsResponse[];
+        code?: string | number;
+    }
+    export interface INotificationsResponse {
+        notifications: INotification[];
+        notifications_not_checked: number;
+    }
+    interface INotification {
+        code: string;
+        account_code: string;
+        notification_type: string;
+        status: string;
+        customer_code: string;
+        is_checked: boolean;
+        created_at: string;
+        updated_at: string;
+    }
+    export interface IEmpty {
+    }
+    export {};
+}

package/build/types/onboarding/index.d.ts

@@ -0,0 +1 @@
+export * from './onboarding';

package/build/types/onboarding/onboarding.d.ts

@@ -0,0 +1,7 @@
+export declare namespace Onboarding {
+    interface OnboardingStatus {
+        has_connection: boolean;
+        has_routing: boolean;
+        has_checkout_active: boolean;
+    }
+}

package/build/types/operation-transaction/index.d.ts

@@ -0,0 +1 @@
+export * from './operation-transaction';