@yuno-payments/dashboard-api-mfe 0.42.10 → 0.42.15-recipients-beta.1

package/build/cjs/types/api/api.d.ts

@@ -506,14 +506,14 @@ export declare class Api extends HttpClient {
     postCreateRuleMultiAccount<T>(payload: any, accountCode: any): Promise<AxiosResponse<T, any>>;
     postEditRule<T>(payload: any, ruleId: any, accountCode: any): Promise<AxiosResponse<T, any>>;
     postApiKeysRoll<T>(payload: any, keyCode: any, password: any): Promise<AxiosResponse<T, any>>;
-    patchApiKeysEditNote<T>(payload: any, keyCode: any): Promise<AxiosResponse<T, any>>;
+    patchApiKeysEditNote<T>(payload: any, keyCode: any, password: any): Promise<AxiosResponse<T, any>>;
     getCustomizedApiKeysMembers<T>(): Promise<AxiosResponse<T, any>>;
     getCustomizedApiKeysAccounts<T>(): Promise<AxiosResponse<T, any>>;
     postCreateCustomizedApiKeys<T>(payload: any): Promise<AxiosResponse<T, any>>;
     pathCreateCustomizedApiKeys<T>(payload: any, code: any): Promise<AxiosResponse<T, any>>;
     postCustomizedApiKeys<T>(accountCodes: string[]): Promise<AxiosResponse<T, any>>;
     getCustomizedApiKeysProducts<T>(): Promise<AxiosResponse<T, any>>;
-    getCustomizedApiKeysToken<T>(code: any, password: any): Promise<AxiosResponse<T, any>>;
+    getCustomizedApiKeysToken<T>(code: string, password?: string, otp?: string, mfaToken?: string): Promise<AxiosResponse<T, any>>;
     validatePasswordStatus<T>(): Promise<AxiosResponse<T, any, {}>>;
     deleteCustomizedApiKeys<T>(code: any): Promise<AxiosResponse<T, any>>;
     postCreateInsightsReport<T>(payload: any): Promise<AxiosResponse<T, any>>;
@@ -569,5 +569,22 @@ export declare class Api extends HttpClient {
     }): Promise<AxiosResponse<T, any>>;
     getCommunicationsFilters<T>(): Promise<AxiosResponse<T, any>>;
     getCommunicationDetails<T>(communicationId: string, accountCode: string): Promise<AxiosResponse<T, any>>;
+    getRecipients<T>(organizationCode: string, params: {
+        account_ids?: string;
+        countries?: string;
+        national_entities?: string;
+        entity_types?: string;
+        start_date?: string;
+        end_date?: string;
+        search_type?: string;
+        search_value?: string;
+        page?: number;
+        page_size?: number;
+        sort_by?: string;
+        sort_order?: string;
+    }): Promise<AxiosResponse<T, any>>;
+    getRecipientById<T>(organizationCode: string, recipientId: string): Promise<AxiosResponse<T, any>>;
+    getOnboardingDetail<T>(organizationCode: string, recipientId: string, onboardingId: string): Promise<AxiosResponse<T, any>>;
+    getOnboardingTimeline<T>(organizationCode: string, onboardingId: string): Promise<AxiosResponse<T, any>>;
 }
 export {};

package/build/cjs/types/queries/index.d.ts

@@ -31,3 +31,4 @@ export * from './smart-recovery';
 export * from './network-tokens';
 export * from './template-reporting';
 export * from './organization-config';
+export * from './recipients';

package/build/cjs/types/queries/recipients/index.d.ts

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

package/build/cjs/types/queries/recipients/recipients.query.d.ts

@@ -0,0 +1,8 @@
+import { AxiosError } from 'axios';
+import { UseQueryResult } from '@tanstack/react-query';
+import { Recipients, GetRecipientsParams, GetRecipientByIdParams, GetOnboardingDetailParams, GetOnboardingTimelineParams } from '../../types/recipients';
+import { BFFErrorResponse } from '../../mutations';
+export declare function useGetRecipients(organizationCode: string, params: GetRecipientsParams, enabled?: boolean): UseQueryResult<Recipients.RecipientListResponse, AxiosError<BFFErrorResponse>>;
+export declare function useGetRecipientById(organizationCode: string, params: GetRecipientByIdParams, enabled?: boolean): UseQueryResult<Recipients.RecipientDetail, AxiosError<BFFErrorResponse>>;
+export declare function useGetOnboardingDetail(organizationCode: string, params: GetOnboardingDetailParams, enabled?: boolean): UseQueryResult<Recipients.OnboardingDetail, AxiosError<BFFErrorResponse>>;
+export declare function useGetOnboardingTimeline(organizationCode: string, params: GetOnboardingTimelineParams, enabled?: boolean): UseQueryResult<Recipients.OnboardingTimeline, AxiosError<BFFErrorResponse>>;

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

@@ -31,3 +31,4 @@ export * from './ai';
 export * from './smart-recovery';
 export * from './template-reporting';
 export * from './organization-config';
+export * from './recipients';

package/build/cjs/types/types/recipients/index.d.ts

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

package/build/cjs/types/types/recipients/recipients.d.ts

@@ -0,0 +1,216 @@
+export declare namespace Recipients {
+    interface Document {
+        number: string | null;
+        type: string | null;
+    }
+    interface Phone {
+        country_code: string | null;
+        number: string | null;
+    }
+    interface Address {
+        address_line_1: string | null;
+        address_line_2: string | null;
+        country: string | null;
+        city: string | null;
+        state: string | null;
+        zip_code: string | null;
+    }
+    interface Bank {
+        code: string | null;
+        branch: string | null;
+        branch_digit: string | null;
+        account: string | null;
+        account_digit: string | null;
+        account_type: string | null;
+        routing: string | null;
+        country: string | null;
+        currency: string | null;
+        payout_schedule?: string | null;
+    }
+    interface WithdrawalMethod {
+        bank: Bank | null;
+    }
+    interface Documentation {
+        file_name: string;
+        content_type: string;
+        content_category: string;
+        content: string | null;
+    }
+    interface OnboardingSummary {
+        id: string;
+        provider_id: string;
+        status: string;
+        created_at: string;
+    }
+    interface RecipientListItem {
+        id: string;
+        merchant_recipient_id: string | null;
+        national_entity: string;
+        entity_type: string | null;
+        country: string;
+        first_name: string | null;
+        last_name: string | null;
+        legal_name: string | null;
+        email: string | null;
+        account_id: string;
+        date_of_birth: string | null;
+        website: string | null;
+        industry: string | null;
+        merchant_category_code: string | null;
+        created_at: string;
+        updated_at: string;
+    }
+    interface Pagination {
+        page: number;
+        page_size: number;
+        total_items: number;
+        total_pages: number;
+        has_next: boolean;
+        has_previous: boolean;
+    }
+    interface RecipientListResponse {
+        data: RecipientListItem[];
+        pagination: Pagination;
+    }
+    interface RecipientDetail {
+        id: string;
+        merchant_recipient_id: string | null;
+        national_entity: string;
+        entity_type: string | null;
+        country: string;
+        first_name: string | null;
+        last_name: string | null;
+        legal_name: string | null;
+        email: string | null;
+        account_id: string;
+        created_at: string;
+        updated_at: string;
+        document: Document | null;
+        phone: Phone | null;
+        address: Address | null;
+        withdrawal_method: WithdrawalMethod | null;
+        documentation: Documentation[];
+        onboardings: OnboardingSummary[];
+    }
+    interface OnboardingProvider {
+        id: string | null;
+        connection_id: string | null;
+        redirect_url: string | null;
+        recipient_id: string | null;
+        recipient_additional_id: string | null;
+        onboarding_url: string | null;
+        legal_entity: string | null;
+        balance_account_id: string | null;
+        recipient_type: string | null;
+        raw_notification: string | null;
+        raw_response: string | null;
+        response_code: string | null;
+        response_message: string | null;
+    }
+    interface LegalRepresentativeDocument {
+        type: string | null;
+        number: string | null;
+    }
+    interface LegalRepresentative {
+        first_name: string | null;
+        last_name: string | null;
+        email: string | null;
+        document: LegalRepresentativeDocument | null;
+        phone: Phone | null;
+        address: Address | null;
+        date_of_birth: string | null;
+    }
+    interface Requirement {
+        field: string | null;
+        message: string | null;
+        status: string | null;
+    }
+    interface CapabilityRequirement {
+        provider_response_code: string | null;
+        provider_response_message: string | null;
+        provider_response_field: string | null;
+        message: string | null;
+        status: string | null;
+    }
+    interface Capability {
+        status: string | null;
+        requirements: CapabilityRequirement[];
+    }
+    interface Capabilities {
+        payouts: Capability | null;
+        send_transfers: Capability | null;
+        receive_transfers: Capability | null;
+        payments: Capability | null;
+    }
+    interface TermsOfService {
+        acceptance: boolean | null;
+        date: string | null;
+        ip: string | null;
+    }
+    interface Metadata {
+        key: string;
+        value: string;
+    }
+    interface OnboardingDetail {
+        id: string;
+        type: string;
+        workflow: string;
+        description: string | null;
+        status: string;
+        response_message: string | null;
+        callback_url: string | null;
+        provider: OnboardingProvider | null;
+        documentation: Documentation[];
+        legal_representatives: LegalRepresentative[];
+        withdrawal_methods: WithdrawalMethod | null;
+        requirements: Requirement[];
+        capabilities: Capabilities | null;
+        terms_of_service: TermsOfService | null;
+        metadata: Metadata[];
+        created_at: string;
+        updated_at: string;
+        expires_at: string | null;
+    }
+    interface TimelineEventData {
+        provider_id?: string | null;
+        provider_status?: string | null;
+        provider_response_code?: string | null;
+        provider_response_message?: string | null;
+        provider_recipient_id?: string | null;
+        provider_redirect_url?: string | null;
+        requirements?: Requirement[];
+        capabilities?: Capabilities | null;
+        change_type?: string | null;
+    }
+    interface TimelineEvent {
+        timestamp: string;
+        event_type: string;
+        status: string | null;
+        event_data: TimelineEventData | null;
+    }
+    type OnboardingTimeline = TimelineEvent[];
+}
+export interface GetRecipientsParams {
+    account_ids?: string;
+    countries?: string;
+    national_entities?: string;
+    entity_types?: string;
+    start_date?: string;
+    end_date?: string;
+    search_type?: string;
+    search_value?: string;
+    page?: number;
+    page_size?: number;
+    sort_by?: string;
+    sort_order?: string;
+}
+export interface GetRecipientByIdParams {
+    recipient_id: string;
+}
+export interface GetOnboardingDetailParams {
+    recipient_id: string;
+    onboarding_id: string;
+}
+export interface GetOnboardingTimelineParams {
+    onboarding_id: string;
+}