@tap-payments/auth-jsconnect 2.11.15-development → 2.11.17-development

package/build/@types/app.d.ts

@@ -0,0 +1,796 @@
+/// <reference types="react" />
+import { PaymentProvider, SDKNotification, SettingAsyncData } from './config';
+import { LanguageMode, DialogEdgeFormat } from './theme';
+export interface CountryCode {
+    created: number;
+    updated: number;
+    countryId: string;
+    name: {
+        created: number;
+        updated: number;
+        textId: string;
+        arabic: string;
+        english: string;
+        french: string;
+        spanish: string;
+        russian: string;
+        chinese: string;
+    };
+    iso2: string;
+    iso3: string;
+    numeric: number;
+    continent: string;
+    capital: string;
+    geoNameId: string;
+    idd_prefix: number;
+    logo: string;
+    digits: number;
+    supported_by_tap: boolean;
+    min_digits: number;
+    max_digits: number;
+}
+export interface City {
+    id: string;
+    country: string;
+    name: {
+        id: string;
+        en: string;
+        ar: string;
+    };
+    state: string;
+    un_locode: string;
+    coordinates: {
+        longitude: string;
+    };
+}
+export interface BusinessCountry {
+    name: string;
+    code: string;
+}
+export interface ScreenStepNavigation {
+    name: string;
+    next: string | string[];
+    prev: string | string[];
+    order: number;
+}
+export interface FeatureScreenStep {
+    element: React.MemoExoticComponent<any> | React.ComponentType<any>;
+    name: string;
+}
+export declare enum SocialMediaTypes {
+    WEB = "sales_channel_1AGV4422123Ymmu7oe10p573",
+    INSTAGRAM = "instagram",
+    TWITTER = "twitter",
+    SOCIAL = "social media",
+    PHYSICAL_STORE = "physical store",
+    CALL_CENTER = "call center",
+    APP = "mobile app",
+    APPLE_STORE = "apple store",
+    PLAY_STORE = "play store"
+}
+export interface CustomerLocation {
+    id: string;
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+}
+export interface ExpectedCustomer extends CustomerLocation {
+}
+export interface ExpectedSaleRange {
+    id: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    sub?: Array<{
+        id: string;
+        name: {
+            ar: string;
+            en: string;
+        };
+    }>;
+}
+export declare enum BusinessType {
+    CR = "company",
+    FL = "freelancer"
+}
+export declare enum LicenseType {
+    CR = "commercial_registration",
+    FL = "freelance"
+}
+export interface License {
+    legal_name: {
+        ar: string;
+        en: string;
+    };
+    license: {
+        number: string;
+        additional_info?: {
+            unified_number?: string;
+        };
+        expiry_date?: string;
+        issuing_date?: string;
+        type?: string;
+    };
+    type: string;
+}
+export interface EntityLicense extends License {
+    id: string;
+}
+export interface EntityLicenseAuth extends EntityLicense {
+    business_id: string;
+    country: string;
+}
+export interface Activity {
+    id: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+}
+export interface SubSaleChannel {
+    id: string;
+    code: string;
+    name?: {
+        ar: string;
+        en: string;
+    };
+    address?: string;
+    logo?: string;
+}
+export interface SaleChannel extends SubSaleChannel {
+    sub?: Array<SubSaleChannel>;
+}
+export interface SourceOfIncome {
+    id: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+}
+export interface Occupation {
+    id: string;
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    section_code?: string;
+    sub?: Array<{
+        id: string;
+        code: string;
+        name: {
+            ar: string;
+            en: string;
+        };
+        part_code: string;
+    }>;
+}
+export interface TeamSize {
+    id: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+}
+export interface Terms {
+    term: string;
+    agree: boolean;
+    agreed_at: number;
+}
+export interface MonthlyIncome extends SourceOfIncome {
+    range: {
+        ar: string;
+        en: string;
+    };
+}
+export interface Segment {
+    id: string;
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+}
+export interface AppInfo {
+    name: string;
+    identifier?: string;
+    version?: string;
+}
+interface LibCallbacks {
+    onFlowCompleted: (data: Record<string, any>) => void;
+    onError: (err: any) => void;
+    onStepCompleted?: (name: string, data: Record<string, any>) => void;
+    onReady?: () => void;
+    onSettingFetched?: (data: SettingAsyncData) => void;
+    onClose?: () => void;
+    onStepStarted?: (name: string) => void;
+    onBoardButtonClick?: (data: Record<string, any>) => void;
+    onCreated?: (res: Record<string, any>) => void;
+    onBoardCompleted?: () => void;
+    onMaturityChanged?: (maturity: 'full' | 'express') => Promise<void>;
+    onSwitchToBoard?: (boardId: string, authId: string) => void;
+}
+export interface LibConfig extends LibCallbacks {
+    publicKey: string;
+    open: boolean;
+    merchantDomain: string;
+    language: LanguageMode;
+    appInfo: AppInfo;
+    businessCountryCode?: string;
+    scope: string;
+    showBoard?: boolean;
+    platforms?: Array<string>;
+    dialogEdgeFormat?: DialogEdgeFormat;
+    paymentProvider?: PaymentProvider;
+    features?: {
+        poweredBy?: boolean;
+        merchantLogo?: boolean;
+        switchLanguage?: boolean;
+        overlay?: boolean;
+        loaderOverlay?: boolean;
+        tapTextLogo?: boolean;
+        closeButton?: boolean;
+        disableNafath?: boolean;
+        disablePaci?: boolean;
+        dialogStartTransition?: 'left' | 'right' | 'up' | 'down';
+        dialogEndTransition?: 'left' | 'right' | 'up' | 'down';
+    };
+    postURL?: string;
+    redirectUrl?: string;
+    data?: Array<string>;
+    mode?: 'popup' | 'page' | 'content';
+    notification?: SDKNotification;
+    boardMaturity?: boolean;
+    settingData?: SettingAsyncData;
+    region?: string;
+}
+export interface OSDetails {
+    name: string;
+    version: string;
+}
+export interface DeviceDetails {
+    name: string;
+    type: string;
+    brand: string;
+    model: string;
+    os: OSDetails;
+}
+export interface BrowserDetails {
+    name: string;
+    version: string;
+    user_agent: string;
+    browser_id: string;
+}
+export interface Connection {
+    ip: string;
+    mac: string;
+    latitude?: number;
+    longitude?: number;
+}
+export interface Entry {
+    name: string;
+    interface: string;
+    type: string;
+    version: string;
+}
+export interface DeviceInfo {
+    source: 'browser' | 'app';
+    device: DeviceDetails;
+    browser: BrowserDetails;
+    app: AppInfo & {
+        language?: string;
+    };
+    connection: Connection;
+    entry?: Entry;
+}
+export interface LocalProps {
+    [country: string]: {
+        ar: {
+            translation: {
+                [key: string]: string;
+            };
+        };
+        en: {
+            translation: {
+                [key: string]: string;
+            };
+        };
+    };
+}
+export declare type BrandInfo = {
+    segment?: {
+        type: {
+            id: string;
+        };
+        team: {
+            id: string;
+        };
+        location_type: {
+            id: string;
+        };
+        profit_type: {
+            id: string;
+        };
+        tech_type: {
+            id: string;
+        };
+    };
+    id: string;
+    business_id: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    channel_services: SaleChannel[];
+};
+export declare enum FlowsTypes {
+    CONNECT_EXPRESS = "connect_express",
+    CONNECT = "connect",
+    AUTH = "auth",
+    BANK = "bank",
+    BUSINESS = "business",
+    INDIVIDUAL = "individual",
+    PASSWORD = "password",
+    TAX = "tax",
+    ENTITY = "entity",
+    OTP = "otp",
+    BRAND = "brand",
+    BOARD = "board",
+    kyc = "kyc",
+    TERMINAL = "terminal"
+}
+export declare type FlowInfo = {
+    name: string;
+    status: string;
+    url: string;
+};
+export declare enum AuthForType {
+    MOBILE = "mobile",
+    EMAIL = "email",
+    NATIONAL_ID = "national_id",
+    NATIONAL_ID_MISSED = "national_id_missed"
+}
+export declare enum AuthForScreen {
+    INDIVIDUAL = "individual",
+    DOB = "dob",
+    MOBILE_OWNERSHIP = "mobile_ownership"
+}
+export declare enum AuthTypeNumber {
+    EMAIL_OTP = 5,
+    MOBILE_OTP = 2,
+    PASSWORD = 1,
+    MIGRATION = 10,
+    RESET_PASSWORD = 7,
+    PASSCODE = 11
+}
+export declare enum MigrationStatus {
+    IN_PROGRESS = "IN_PROGRESS",
+    MIGRATED = "MIGRATED",
+    FAILED = "FAILED"
+}
+export declare enum AddressFormateType {
+    SELECT = "select",
+    NUMBER = "number",
+    TEXT = "text"
+}
+export declare type AddressFormat = {
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    required: boolean;
+    retrieve_uri?: string;
+    sort: number;
+    type: AddressFormateType;
+};
+export declare type AddressType = {
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+};
+export declare type AddressProps = {
+    format: AddressFormat[];
+    type: AddressType;
+};
+export declare enum FieldType {
+    EDITABLE = "editable",
+    NON_EDITABLE = "noneditable"
+}
+export interface TermsProps {
+    term: string;
+    agree: boolean;
+}
+export declare enum IndividualGender {
+    MALE = "m",
+    FEMALE = "f"
+}
+export declare enum IndividualType {
+    USER = "user",
+    SHARE_HOLDER = "shareholder",
+    BOARD_MEMBER = "board_member",
+    CUSTOMER = "customer",
+    BUYER = "buyer"
+}
+export declare enum DocumentPurpose {
+    CR = "commercial_registration",
+    ARTICLE_ASSOCIATION = "article_of_association",
+    BANK_STATEMENT = "bank_statement",
+    BANK_CERTIFICATE = "bank_certificate",
+    IDENTITY_DOCUMENT = "identity_document",
+    CUSTOMER_SIGNATURE = "customer_signature",
+    TAX_DOCUMENT = "tax_document_user_upload",
+    BRAND_LOGO = "business_logo"
+}
+export declare type FileDetails = {
+    created: string;
+    id: string;
+    object: string;
+    purpose: string;
+    size: string;
+    title: string;
+    type: string;
+    docId?: string;
+};
+export declare enum VerificationStatus {
+    VERIFIED = "verified",
+    ENTERED = "entered",
+    NOT_ENTERED = "not_entered"
+}
+export declare type BankDataStatus = {
+    iban: FieldType;
+    account_number: FieldType;
+    swift_code: FieldType;
+    bank_name: FieldType;
+    beneficiary_name: FieldType;
+    bank_statement_file_id: FieldType;
+    is_acknowledged: FieldType;
+};
+export declare type EntityDataStatus = {
+    type: FieldType;
+    'license.status': FieldType;
+    'license.provider': FieldType;
+    'license.type': FieldType;
+    'license.number': FieldType;
+    'license.additional_info': FieldType;
+    'license.issuing_date': FieldType;
+    'license.expiry_date': FieldType;
+    'capital.paid': FieldType;
+    'capital.subscribed': FieldType;
+    'capital.announced': FieldType;
+    'capital.shares.count': FieldType;
+    'capital.shares.value': FieldType;
+    activities: FieldType;
+    documents: FieldType;
+    location: FieldType;
+    'legal_name.en': FieldType;
+    'legal_name.ar': FieldType;
+    country: FieldType;
+    not_for_profit: FieldType;
+    is_vat_acknowledged: FieldType;
+    tax_number: FieldType;
+    opened_by: FieldType;
+    signed_by: FieldType;
+    settlement_by: FieldType;
+    billing_address: FieldType;
+    AOA_file_id: FieldType;
+};
+export declare type IndividualDataStatus = {
+    status: FieldType;
+    'name.en': FieldType;
+    'name.ar': FieldType;
+    'contact.email': FieldType;
+    'contact.phone.number': FieldType;
+    'contact.phone.country_code': FieldType;
+    nationality: FieldType;
+    'birth.date': FieldType;
+    'birth.city': FieldType;
+    'birth.country': FieldType;
+    'identification.id': FieldType;
+    'identification.type': FieldType;
+    'identification.expiry': FieldType;
+    'identification.issuer_country': FieldType;
+    role: FieldType;
+    relation: FieldType;
+    occupation: FieldType;
+    is_authorized: FieldType;
+    address: FieldType;
+    source_of_income: FieldType;
+    monthly_income: FieldType;
+    is_relative_PEP: FieldType;
+    is_influencer: FieldType;
+    gender: FieldType;
+};
+export declare type BrandDataStatus = {
+    status: FieldType;
+    'name.en': FieldType;
+    'name.ar': FieldType;
+    'operations.business_start_date': FieldType;
+    'operations.sales_range': FieldType;
+    'operations.customer_base': FieldType;
+    'operations.customer_base_location': FieldType;
+    terms: FieldType;
+    'segment.type': FieldType;
+    'segment.teams': FieldType;
+    'segment.sale': FieldType;
+    'segment.location_type': FieldType;
+    'segment.profit_type': FieldType;
+    'segment.tech_type': FieldType;
+    activities: FieldType;
+    channel_services: FieldType;
+    logo: FieldType;
+};
+export interface MerchantInfo {
+    id: string;
+    api_version: string;
+    live_mode: boolean;
+    object: string;
+    name: string;
+    country_code: string;
+    logo: string;
+    background: {
+        url: string;
+    };
+    sdk_settings: {
+        status_display_duration: number;
+        otp_resend_interval: number;
+        otp_resend_attempts: number;
+    };
+    key_type: string;
+    permissions: string[];
+    permission: {
+        card_wallet: boolean;
+        threeDSecure: boolean;
+        pci_dss: boolean;
+    };
+}
+export interface ActivityParams {
+    id: string;
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    created: string;
+    isic_code: string;
+    branch_code: string;
+    old_activity_id: string;
+}
+export interface ActivityDivision {
+    id: string;
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    created: string;
+    section_code: string;
+    activities?: Array<ActivityParams>;
+}
+export interface ActivitiesIsIc {
+    id: string;
+    code: string;
+    name: {
+        ar: string;
+        en: string;
+    };
+    created: string;
+    divisions?: Array<ActivityDivision>;
+}
+export declare type BankDataVerification = {
+    account_number: string;
+    bank_name: string;
+    bank_statement_file_id: string;
+    beneficiary_name: string;
+    document: string;
+    iban: string;
+    is_acknowledged: string;
+    swift_code: string;
+};
+export declare type BrandDataVerification = {
+    logo: string;
+    'name.en': string;
+    'name.ar': string;
+    'name.textId': string;
+    'name.zh': string;
+    'operations.business_start_date': string;
+    'operations.customer_base': string;
+    'operations.customer_base_location': string;
+    'operations.sales_range': string;
+    'segment.sale': string;
+    'segment.teams': string;
+    'segment.type': string;
+    'segment.location_type': string;
+    'segment.profit_type': string;
+    'segment.tech_type': string;
+    terms: string;
+};
+export declare type EntityDataVerification = {
+    AOA_file_id: string;
+    billing_address: string;
+    'capital.announced': string;
+    'capital.paid': string;
+    'capital.shares.count': string;
+    'capital.shares.value': string;
+    'capital.subscribed': string;
+    country: string;
+    is_licensed: string;
+    is_vat_acknowledged: string;
+    'legal_name.ar': string;
+    'legal_name.en': string;
+    'license.additional_info': string;
+    'license.expiry_date': string;
+    'license.issuing_date': string;
+    'license.number': string;
+    'license.provider': string;
+    'license.status': string;
+    'license.type': string;
+    location: string;
+    not_for_profit: string;
+    settlement_by: string;
+    tax_number: string;
+    taxable: string;
+    type: string;
+};
+export declare type IndividualDataVerification = {
+    'birth.city': string;
+    'birth.country': string;
+    'birth.date': string;
+    'contact.email': string;
+    'contact.phone.country_code': string;
+    'contact.phone.number': string;
+    employer_city: string;
+    employer_country: string;
+    employer_name: string;
+    gender: string;
+    'identification.expiry': string;
+    'identification.id': string;
+    'identification.issuer_country': string;
+    'identification.type': string;
+    is_authorized: string;
+    is_influencer: string;
+    is_relative_PEP: string;
+    'name.en': string;
+    'name.ar': string;
+    nationality: string;
+    occupation: string;
+    relation: string;
+    status: string;
+};
+export interface CommonDataLayer {
+    event: string;
+}
+export interface DataLayer extends CommonDataLayer {
+    event_category: string;
+    event_action: string;
+    event_label?: string;
+    event_value?: number | string;
+    event_noninteraction?: number;
+}
+export interface CountryTrackingData extends CommonDataLayer {
+    website_country?: string;
+}
+export interface LeadIdentificationData extends CommonDataLayer {
+    lead_ID?: string;
+}
+export interface EventPageTrackingData extends CommonDataLayer {
+    title?: string;
+}
+export interface PageTrackingData {
+    title?: string;
+    connect_flow?: string;
+}
+export declare type VerifyExpressTokenParams = {
+    public_key: string;
+    post: {
+        url: string;
+    };
+    lead_id: string;
+};
+export declare enum MerchantStatus {
+    DISABLED = "disabled",
+    ENABLED = "enabled"
+}
+export interface AuthMerchantInfo {
+    id: string;
+    status: string;
+    created: number;
+    display_name: string;
+    business_id: string;
+    business_entity_id: string;
+    brand_id: string;
+    wallet_id: string;
+    base_currency: string;
+    charge_currenices: string[];
+    country: string;
+    is_acceptance_allowed: boolean;
+    is_payout_allowed: boolean;
+    legacy_id: string;
+    marketplace: boolean;
+    post: {
+        url: string;
+    };
+    metadata: {
+        MerchantRefrenceId: string;
+    };
+    terminal_id: string;
+    acceptance_status: string;
+    payout_status: string;
+    board_id: string;
+    board_info_id: string;
+}
+export interface AuthTerminalInfo {
+    id: string;
+    object: string;
+    live_mode: boolean;
+    api_version: string;
+    feature_version: string;
+    name: TerminalName;
+    merchant: TerminalMerchant;
+    authorizes: TerminalAuthorizes;
+    charges: TerminalAuthorizes;
+    refunds: TerminalAuthorizes;
+    wallet: TerminalWallet;
+    virtual: boolean;
+    operator: TerminalOperator;
+    acceptance_status: string;
+    data_status: TerminalDataStatus;
+    data_verification: TerminalDataStatus;
+    data_state: string;
+    brand: TerminalWallet;
+}
+interface TerminalDataStatus {
+    name: TerminalName;
+    charge_last_transaction: string;
+    charge_flag: string;
+    authorize_last_transaction: string;
+    refund_last_transaction: string;
+    acceptance_status: string;
+}
+interface TerminalName {
+    ar: string;
+    en: string;
+}
+interface TerminalWallet {
+    id: string;
+}
+interface TerminalOperator {
+    id: string;
+    is_merchant: boolean;
+}
+interface TerminalMerchant {
+    id: string;
+    base_currency: string;
+    country: string;
+}
+interface TerminalAuthorizes {
+    status: string;
+    status_message: string;
+}
+export declare type CountryInfo = {
+    id: number;
+    label: string;
+    country: {
+        id: number;
+        name_en: string;
+        name_ar: string;
+        iso2: string;
+        iso3: string;
+        idd_prefix: string;
+        logo: string;
+        min_digits: number;
+        max_digits: number;
+    };
+};
+export declare type BusinessCountryInfo = {
+    id: number;
+    title: string;
+    title_ar: string;
+    countries: Array<CountryInfo>;
+};
+export {};