@yuno-payments/sdk-web-types 4.1.0 → 4.2.0

package/dist/global.d.ts

@@ -87,6 +87,10 @@ declare enum StatusEnrollment {
     ERROR = "ERROR",
     UNENROLLED = "UNENROLLED"
 }
+type ExternalProviderId = {
+    provider_id: string;
+    session_id: string;
+};
 
 type ApiClientPaymentArgs = {
     checkout_session?: string;
@@ -129,6 +133,7 @@ type ContinueEnrollmentArgs = {
         type: string;
         card?: ApiClientCard;
         customer?: Customer;
+        customer_payer?: Customer;
     };
 };
 type ContinueEnrollmentReturn = {
@@ -164,6 +169,304 @@ type ExecuteFraudCheckReturn<TStatus = 'success' | 'error'> = TStatus extends 's
 };
 type ExecuteFraudCheck = (args: ExecuteFraudCheckArgs) => Promise<ExecuteFraudCheckReturn>;
 
+declare namespace C2PHeadless {
+    interface PaymentResponse {
+        id: string;
+        status: string;
+        sub_status: string;
+        merchant_order_id: string;
+        description: string;
+        created_at: string;
+        updated_at: string;
+        payment_method_icon?: string;
+        payment_method_name?: string;
+        transactions: {
+            id: string;
+            category: string;
+            status: string;
+            payment_method_type: string;
+            created_at: string;
+            updated_at: string;
+            provider: unknown;
+            amount: {
+                currency: string;
+                value: number;
+            };
+        };
+        enrollment?: {
+            customer_session: string;
+        };
+        has_fraud_screening?: boolean;
+    }
+    type ClickToPayArgs = {
+        checkoutSession: string;
+        language: string;
+        countryCode: string;
+        deviceFingerprints?: ExternalProviderId[];
+        recognitionToken?: string;
+        isGoldenFlow?: boolean;
+        dpaLocale?: string;
+    };
+    type OnResultArgs = {
+        isRegistered: boolean;
+    };
+    type RenderEmailFormOptions = {
+        onResult: (args: OnResultArgs) => void;
+        onError: (error: unknown) => void;
+        onCancel: () => void;
+        onSkipC2p?: () => void;
+    };
+    type RenderReturn = {
+        destroy: () => void;
+    };
+    interface MaskedCard {
+        srcDigitalCardId: string;
+        panBin: string;
+        panLastFour: string;
+        tokenLastFour?: string;
+        digitalCardData: {
+            descriptorName: string;
+            artUri: string;
+            isCoBranded: boolean;
+            status: string;
+        };
+        digitalCardFeatures: unknown[];
+        panExpirationMonth: string;
+        panExpirationYear: string;
+        paymentCardDescriptor: string;
+        paymentCardType: string;
+        maskedBillingAddress: Record<string, string>;
+        cardholderFirstName: string;
+        cardholderLastName: string;
+        cardholderFullName: string;
+    }
+    interface MobileNumber {
+        countryCode: string;
+        phoneNumber: string;
+    }
+    type UserExistsOptions = {
+        email?: string;
+        mobileNumber?: MobileNumber;
+        lookupPriority?: 'EMAIL' | 'MOBILE_NUMBER';
+    };
+    type RenderOtpFormFnOptions = {
+        onResult: (args: OnResultArgs) => void;
+        onError: (args: OnErrorArgs) => void;
+        onCancel: () => void;
+        onNotMyEmail: () => void;
+        onLoading: (args: OnLoadingArgs) => void;
+        onSkipC2p?: () => void;
+    };
+    type OriginError = 'INIT_PROCESS' | 'RESEND_CODE' | 'VALIDATE_CODE' | 'RENDER_OTP_FORM' | 'TEMPORARY_USER_BLOCKED';
+    type OnLoadingArgs = {
+        isLoading: boolean;
+    };
+    type OnErrorArgs = {
+        error: unknown;
+        origin: OriginError;
+    };
+    interface CardFrontend {
+        number: string;
+        expirationMonth: number;
+        expirationYear: number;
+        securityCode: string;
+        holderName: string;
+        type?: string | null;
+        brand: string;
+    }
+    interface CustomerFrontend {
+        firstName?: string | null;
+        lastName?: string | null;
+        email?: string | null;
+        deviceFingerprint?: string | null;
+        document?: {
+            documentNumber?: string | null;
+            documentType?: string | null;
+        } | null;
+        phone?: {
+            countryCode?: string | null;
+            number?: string | null;
+        } | null;
+        billingAddress?: {
+            addressLine1?: string | null;
+            addressLine2?: string | null;
+            city?: string | null;
+            country?: string | null;
+            state?: string | null;
+            zipCode?: string | null;
+            neighborhood?: string | null;
+        } | null;
+        shippingAddress?: {
+            addressLine1?: string | null;
+            addressLine2?: string | null;
+            city?: string | null;
+            country?: string | null;
+            state?: string | null;
+            zipCode?: string | null;
+        } | null;
+        browserInfo?: Partial<{
+            acceptBrowser: string | null;
+            acceptContent: string | null;
+            acceptHeader: string | null;
+            colorDepth: string | null;
+            javascriptEnabled: boolean | null;
+            language: string | null;
+            screenHeight: string | null;
+            screenWidth: string | null;
+            userAgent: string | null;
+            javaEnabled: boolean | null;
+            browserTimeDifference: string | null;
+        }> | null;
+        merchantCustomerId?: string | null;
+        geolocation?: {
+            latitude: string;
+            longitude: string;
+        } | null;
+    }
+    interface InstallmentFrontend {
+        id: string;
+        value: number;
+        installmentSelectedId?: string | null;
+        amount?: {
+            currency: string;
+            value: string;
+            totalValue: string;
+        };
+        type?: string;
+    }
+    type OnPaymentResultArgs = {
+        payment: PaymentResponse;
+        isAdditionalStepRequired: boolean;
+    };
+    interface CheckoutReturn {
+        checkoutActionCode: string;
+        checkoutResponse: string;
+        headers: {
+            'merchant-transaction-id': string;
+            'x-src-cx-flow-id': string;
+        };
+        network: string;
+        idToken: string;
+        checkoutResponseData: {
+            srcCorrelationId: string;
+            srciTransactionId: string;
+            maskedCard: {
+                srcDigitalCardId: string;
+                panBin: string;
+                panLastFour: string;
+                digitalCardData: {
+                    status: string;
+                    artUri: string;
+                };
+                panExpirationMonth: string;
+                panExpirationYear: string;
+                paymentCardDescriptor: string;
+                paymentCardType: string;
+                serviceId: string;
+                dateOfCardCreated: string;
+                dateOfCardLastUsed: string;
+            };
+            maskedConsumer: {
+                srcConsumerId: string;
+                maskedConsumerIdentity: {
+                    identityProvider: string;
+                    identityType: string;
+                    maskedIdentityValue: string;
+                };
+                maskedEmailAddress: string;
+                maskedMobileNumber: {
+                    countryCode: string;
+                    phoneNumber: string;
+                };
+                countryCode: string;
+                languageCode: string;
+                status: string;
+                maskedFullName: string;
+                dateConsumerAdded: string;
+                dateConsumerLastUsed: string;
+            };
+            customOutputData: {
+                authorizations: {
+                    type: string;
+                    authorization: string;
+                }[];
+            };
+            assuranceData: {
+                cardVerificationEntity: string;
+                cardVerificationMethod: string;
+                cardVerificationResults: string;
+            };
+        };
+        recognitionToken?: string;
+    }
+    type CreatePaymentWithNewCardOptions = {
+        card: CardFrontend;
+        customer?: Partial<CustomerFrontend>;
+        saveCardInYuno?: boolean;
+        c2pOptions: {
+            skipC2p: boolean;
+            rememberMeInBrowser: boolean;
+        };
+        installment?: InstallmentFrontend;
+        onError: (args: OnErrorArgs) => void;
+        onPaymentResult: (args: OnPaymentResultArgs) => void;
+        onEnrollmentIncomplete: (result: CheckoutReturn) => void;
+        onLoading: ({ isLoading }: {
+            isLoading: boolean;
+        }) => void;
+    };
+    type CreatePaymentWithExistingCardOptions = {
+        maskedCard: MaskedCard;
+        customer?: Partial<CustomerFrontend>;
+        installment?: InstallmentFrontend;
+        card?: {
+            securityCode: string;
+        };
+        onError: (args: OnErrorArgs) => void;
+        onPaymentResult: (args: OnPaymentResultArgs) => void;
+        onVerificationIncomplete: (result: CheckoutReturn) => void;
+        onLoading: ({ isLoading }: {
+            isLoading: boolean;
+        }) => void;
+    };
+    type OnChangeRememberMeArgs = {
+        value: boolean;
+    };
+    type OnChangeSaveCardArgs = {
+        value: boolean;
+    };
+    type OnBrandNotAllowedArgs = {
+        attemptedBrand: string;
+        supportedBrands: string[];
+    };
+    type RenderConsentCheckboxOptions = {
+        elementSelector: string;
+        brand: string;
+        onChangeRememberMe: (args: OnChangeRememberMeArgs) => void;
+        onChangeSaveCard: (args: OnChangeSaveCardArgs) => void;
+        onBrandNotAllowed: (args: OnBrandNotAllowedArgs) => void;
+        onError: (error: unknown) => void;
+    };
+    type ReturnRenderConsentCheckbox = {
+        destroy: () => void;
+        changeBrand: (brand: string) => void;
+    };
+    interface YunoC2P {
+        renderEmailForm: (args: RenderEmailFormOptions) => Promise<RenderReturn>;
+        isUserAuthenticated: () => Promise<{
+            isUserAuthenticated: boolean;
+            cardList: MaskedCard[];
+        }>;
+        userExists: (args?: UserExistsOptions) => Promise<boolean>;
+        getC2PInstance: () => Promise<unknown>;
+        renderOtpForm: (args: RenderOtpFormFnOptions) => Promise<RenderReturn>;
+        createPaymentWithNewCard: (args: CreatePaymentWithNewCardOptions) => Promise<void>;
+        createPaymentWithExistingCard: (args: CreatePaymentWithExistingCardOptions) => Promise<void>;
+        renderConsentCheckbox: (args: RenderConsentCheckboxOptions) => Promise<ReturnRenderConsentCheckbox>;
+    }
+    type ClickToPayFn = (args: ClickToPayArgs) => Promise<YunoC2P>;
+}
+
 type CookieKey = 'deviceId';
 type CookieConfig = {
     name: string;
@@ -607,6 +910,7 @@ interface YunoInstance {
     apiClientPayment: ApiClientPayment;
     apiClientEnroll: ApiClientEnroll;
     executeFraudCheck: ExecuteFraudCheck;
+    clickToPay: C2PHeadless.ClickToPayFn;
 }
 interface Yuno {
     initialize(publicApiKey: string, applicationSession?: string, options?: InitializeOptions): Promise<YunoInstance>;

package/dist/index.d.ts

@@ -87,6 +87,10 @@ declare enum StatusEnrollment {
     ERROR = "ERROR",
     UNENROLLED = "UNENROLLED"
 }
+type ExternalProviderId = {
+    provider_id: string;
+    session_id: string;
+};
 
 type ApiClientPaymentArgs = {
     checkout_session?: string;
@@ -129,6 +133,7 @@ type ContinueEnrollmentArgs = {
         type: string;
         card?: ApiClientCard;
         customer?: Customer;
+        customer_payer?: Customer;
     };
 };
 type ContinueEnrollmentReturn = {
@@ -164,6 +169,304 @@ type ExecuteFraudCheckReturn<TStatus = 'success' | 'error'> = TStatus extends 's
 };
 type ExecuteFraudCheck = (args: ExecuteFraudCheckArgs) => Promise<ExecuteFraudCheckReturn>;
 
+declare namespace C2PHeadless {
+    interface PaymentResponse {
+        id: string;
+        status: string;
+        sub_status: string;
+        merchant_order_id: string;
+        description: string;
+        created_at: string;
+        updated_at: string;
+        payment_method_icon?: string;
+        payment_method_name?: string;
+        transactions: {
+            id: string;
+            category: string;
+            status: string;
+            payment_method_type: string;
+            created_at: string;
+            updated_at: string;
+            provider: unknown;
+            amount: {
+                currency: string;
+                value: number;
+            };
+        };
+        enrollment?: {
+            customer_session: string;
+        };
+        has_fraud_screening?: boolean;
+    }
+    type ClickToPayArgs = {
+        checkoutSession: string;
+        language: string;
+        countryCode: string;
+        deviceFingerprints?: ExternalProviderId[];
+        recognitionToken?: string;
+        isGoldenFlow?: boolean;
+        dpaLocale?: string;
+    };
+    type OnResultArgs = {
+        isRegistered: boolean;
+    };
+    type RenderEmailFormOptions = {
+        onResult: (args: OnResultArgs) => void;
+        onError: (error: unknown) => void;
+        onCancel: () => void;
+        onSkipC2p?: () => void;
+    };
+    type RenderReturn = {
+        destroy: () => void;
+    };
+    interface MaskedCard {
+        srcDigitalCardId: string;
+        panBin: string;
+        panLastFour: string;
+        tokenLastFour?: string;
+        digitalCardData: {
+            descriptorName: string;
+            artUri: string;
+            isCoBranded: boolean;
+            status: string;
+        };
+        digitalCardFeatures: unknown[];
+        panExpirationMonth: string;
+        panExpirationYear: string;
+        paymentCardDescriptor: string;
+        paymentCardType: string;
+        maskedBillingAddress: Record<string, string>;
+        cardholderFirstName: string;
+        cardholderLastName: string;
+        cardholderFullName: string;
+    }
+    interface MobileNumber {
+        countryCode: string;
+        phoneNumber: string;
+    }
+    type UserExistsOptions = {
+        email?: string;
+        mobileNumber?: MobileNumber;
+        lookupPriority?: 'EMAIL' | 'MOBILE_NUMBER';
+    };
+    type RenderOtpFormFnOptions = {
+        onResult: (args: OnResultArgs) => void;
+        onError: (args: OnErrorArgs) => void;
+        onCancel: () => void;
+        onNotMyEmail: () => void;
+        onLoading: (args: OnLoadingArgs) => void;
+        onSkipC2p?: () => void;
+    };
+    type OriginError = 'INIT_PROCESS' | 'RESEND_CODE' | 'VALIDATE_CODE' | 'RENDER_OTP_FORM' | 'TEMPORARY_USER_BLOCKED';
+    type OnLoadingArgs = {
+        isLoading: boolean;
+    };
+    type OnErrorArgs = {
+        error: unknown;
+        origin: OriginError;
+    };
+    interface CardFrontend {
+        number: string;
+        expirationMonth: number;
+        expirationYear: number;
+        securityCode: string;
+        holderName: string;
+        type?: string | null;
+        brand: string;
+    }
+    interface CustomerFrontend {
+        firstName?: string | null;
+        lastName?: string | null;
+        email?: string | null;
+        deviceFingerprint?: string | null;
+        document?: {
+            documentNumber?: string | null;
+            documentType?: string | null;
+        } | null;
+        phone?: {
+            countryCode?: string | null;
+            number?: string | null;
+        } | null;
+        billingAddress?: {
+            addressLine1?: string | null;
+            addressLine2?: string | null;
+            city?: string | null;
+            country?: string | null;
+            state?: string | null;
+            zipCode?: string | null;
+            neighborhood?: string | null;
+        } | null;
+        shippingAddress?: {
+            addressLine1?: string | null;
+            addressLine2?: string | null;
+            city?: string | null;
+            country?: string | null;
+            state?: string | null;
+            zipCode?: string | null;
+        } | null;
+        browserInfo?: Partial<{
+            acceptBrowser: string | null;
+            acceptContent: string | null;
+            acceptHeader: string | null;
+            colorDepth: string | null;
+            javascriptEnabled: boolean | null;
+            language: string | null;
+            screenHeight: string | null;
+            screenWidth: string | null;
+            userAgent: string | null;
+            javaEnabled: boolean | null;
+            browserTimeDifference: string | null;
+        }> | null;
+        merchantCustomerId?: string | null;
+        geolocation?: {
+            latitude: string;
+            longitude: string;
+        } | null;
+    }
+    interface InstallmentFrontend {
+        id: string;
+        value: number;
+        installmentSelectedId?: string | null;
+        amount?: {
+            currency: string;
+            value: string;
+            totalValue: string;
+        };
+        type?: string;
+    }
+    type OnPaymentResultArgs = {
+        payment: PaymentResponse;
+        isAdditionalStepRequired: boolean;
+    };
+    interface CheckoutReturn {
+        checkoutActionCode: string;
+        checkoutResponse: string;
+        headers: {
+            'merchant-transaction-id': string;
+            'x-src-cx-flow-id': string;
+        };
+        network: string;
+        idToken: string;
+        checkoutResponseData: {
+            srcCorrelationId: string;
+            srciTransactionId: string;
+            maskedCard: {
+                srcDigitalCardId: string;
+                panBin: string;
+                panLastFour: string;
+                digitalCardData: {
+                    status: string;
+                    artUri: string;
+                };
+                panExpirationMonth: string;
+                panExpirationYear: string;
+                paymentCardDescriptor: string;
+                paymentCardType: string;
+                serviceId: string;
+                dateOfCardCreated: string;
+                dateOfCardLastUsed: string;
+            };
+            maskedConsumer: {
+                srcConsumerId: string;
+                maskedConsumerIdentity: {
+                    identityProvider: string;
+                    identityType: string;
+                    maskedIdentityValue: string;
+                };
+                maskedEmailAddress: string;
+                maskedMobileNumber: {
+                    countryCode: string;
+                    phoneNumber: string;
+                };
+                countryCode: string;
+                languageCode: string;
+                status: string;
+                maskedFullName: string;
+                dateConsumerAdded: string;
+                dateConsumerLastUsed: string;
+            };
+            customOutputData: {
+                authorizations: {
+                    type: string;
+                    authorization: string;
+                }[];
+            };
+            assuranceData: {
+                cardVerificationEntity: string;
+                cardVerificationMethod: string;
+                cardVerificationResults: string;
+            };
+        };
+        recognitionToken?: string;
+    }
+    type CreatePaymentWithNewCardOptions = {
+        card: CardFrontend;
+        customer?: Partial<CustomerFrontend>;
+        saveCardInYuno?: boolean;
+        c2pOptions: {
+            skipC2p: boolean;
+            rememberMeInBrowser: boolean;
+        };
+        installment?: InstallmentFrontend;
+        onError: (args: OnErrorArgs) => void;
+        onPaymentResult: (args: OnPaymentResultArgs) => void;
+        onEnrollmentIncomplete: (result: CheckoutReturn) => void;
+        onLoading: ({ isLoading }: {
+            isLoading: boolean;
+        }) => void;
+    };
+    type CreatePaymentWithExistingCardOptions = {
+        maskedCard: MaskedCard;
+        customer?: Partial<CustomerFrontend>;
+        installment?: InstallmentFrontend;
+        card?: {
+            securityCode: string;
+        };
+        onError: (args: OnErrorArgs) => void;
+        onPaymentResult: (args: OnPaymentResultArgs) => void;
+        onVerificationIncomplete: (result: CheckoutReturn) => void;
+        onLoading: ({ isLoading }: {
+            isLoading: boolean;
+        }) => void;
+    };
+    type OnChangeRememberMeArgs = {
+        value: boolean;
+    };
+    type OnChangeSaveCardArgs = {
+        value: boolean;
+    };
+    type OnBrandNotAllowedArgs = {
+        attemptedBrand: string;
+        supportedBrands: string[];
+    };
+    type RenderConsentCheckboxOptions = {
+        elementSelector: string;
+        brand: string;
+        onChangeRememberMe: (args: OnChangeRememberMeArgs) => void;
+        onChangeSaveCard: (args: OnChangeSaveCardArgs) => void;
+        onBrandNotAllowed: (args: OnBrandNotAllowedArgs) => void;
+        onError: (error: unknown) => void;
+    };
+    type ReturnRenderConsentCheckbox = {
+        destroy: () => void;
+        changeBrand: (brand: string) => void;
+    };
+    interface YunoC2P {
+        renderEmailForm: (args: RenderEmailFormOptions) => Promise<RenderReturn>;
+        isUserAuthenticated: () => Promise<{
+            isUserAuthenticated: boolean;
+            cardList: MaskedCard[];
+        }>;
+        userExists: (args?: UserExistsOptions) => Promise<boolean>;
+        getC2PInstance: () => Promise<unknown>;
+        renderOtpForm: (args: RenderOtpFormFnOptions) => Promise<RenderReturn>;
+        createPaymentWithNewCard: (args: CreatePaymentWithNewCardOptions) => Promise<void>;
+        createPaymentWithExistingCard: (args: CreatePaymentWithExistingCardOptions) => Promise<void>;
+        renderConsentCheckbox: (args: RenderConsentCheckboxOptions) => Promise<ReturnRenderConsentCheckbox>;
+    }
+    type ClickToPayFn = (args: ClickToPayArgs) => Promise<YunoC2P>;
+}
+
 type CookieKey = 'deviceId';
 type CookieConfig = {
     name: string;
@@ -607,9 +910,10 @@ interface YunoInstance {
     apiClientPayment: ApiClientPayment;
     apiClientEnroll: ApiClientEnroll;
     executeFraudCheck: ExecuteFraudCheck;
+    clickToPay: C2PHeadless.ClickToPayFn;
 }
 interface Yuno {
     initialize(publicApiKey: string, applicationSession?: string, options?: InitializeOptions): Promise<YunoInstance>;
 }
 
-export { type ButtonTextCard, type CardConfig, type ContinuePaymentArgs, type ContinuePaymentResponse, type CreateArgsSF, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type StartSeamlessCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };
+export { type ButtonTextCard, C2PHeadless, type CardConfig, type ContinuePaymentArgs, type ContinuePaymentResponse, type CreateArgsSF, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type StartSeamlessCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuno-payments/sdk-web-types",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "types": "dist/index.d.ts",
   "type": "module",
   "publishConfig": {