From 8477c22bbf4b3e222453dc16845049c5404f35f4 Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 10:01:16 -0400 Subject: [PATCH 1/9] add jsdoc comments to instance methods --- packages/paypal-js/types/v6/index.d.ts | 52 ++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/packages/paypal-js/types/v6/index.d.ts b/packages/paypal-js/types/v6/index.d.ts index 0cd7bd91..c4f8c7da 100644 --- a/packages/paypal-js/types/v6/index.d.ts +++ b/packages/paypal-js/types/v6/index.d.ts @@ -7,6 +7,26 @@ import { } from "./components/find-eligible-methods"; export interface PayPalV6Namespace { + /** + * Creates an SDK instance with the specified components and configuration. + * + * This is an asynchronous method that initializes the PayPal SDK with the provided + * client token and components. The SDK is designed to be lightweight and modular, + * allowing you to load only the functionality you need. + * + * @param createInstanceOptions - Configuration options for creating the SDK instance + * @returns A promise that resolves to an SDK instance with methods based on the specified components + * + * @example + * ```typescript + * const sdkInstance = await window.paypal.createInstance({ + * clientToken: "your-client-token", + * components: ["paypal-payments"], + * locale: "en-US", + * pageType: "checkout" + * }); + * ``` + */ createInstance: ( createInstanceOptions: CreateInstanceOptions, ) => Promise>; @@ -81,9 +101,41 @@ export type SdkInstance = : unknown); export interface BaseInstance { + /** + * Checks eligibility for specific payment methods. + * + * This method verifies buyer and merchant eligibility by interacting with PayPal's + * public API to determine whether payment methods (such as PayPal or Venmo) can be used. + * Use this to conditionally render the appropriate payment buttons on your site. + * + * @param findEligibleMethodsOptions - Options for checking payment method eligibility + * @returns A promise that resolves to payment methods eligibility information + * + * @example + * ```typescript + * const paymentMethods = await sdkInstance.findEligibleMethods(); + * const isPayPalEligible = paymentMethods.isEligible("paypal"); + * if (isPayPalEligible) { + * // Render PayPal button + * } + * ``` + */ findEligibleMethods: ( findEligibleMethodsOptions: FindEligibleMethodsOptions, ) => Promise; + /** + * Updates the locale for the SDK instance. + * + * This method allows you to dynamically change the locale of the SDK instance + * after it has been initialized. The locale should be specified using a BCP-47 code. + * + * @param locale - The new locale to set, specified as a BCP-47 code (e.g., "en-US", "es-ES") + * + * @example + * ```typescript + * sdkInstance.updateLocale("es-ES"); + * ``` + */ updateLocale: (locale: string) => void; } From f6d881fdc47c008ccdb59b1db418ae34348f4a3c Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 10:39:43 -0400 Subject: [PATCH 2/9] add jsdoc comments to billing agreements --- .../paypal-legacy-billing-agreements.d.ts | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts index 516ac64d..614c5a22 100644 --- a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts @@ -42,7 +42,31 @@ export type PayPalLegacyBillingAgreementsSession = Omit< export interface PayPalLegacyBillingInstance { /** + * Creates a PayPal billing agreement session without requiring an immediate purchase. + * This legacy method allows merchants to set up recurring payment agreements with customers + * that can be used for future transactions. + * * @deprecated This method is legacy and should not be used for new implementations. + * Use the newer vault setup token approach with createPayPalSavePaymentSession instead. + * + * @param paymentSessionOptions - Configuration options for the billing agreement session + * @returns A PayPalLegacyBillingAgreementsSession object that can be used to start the billing agreement flow + * + * @example + * ```typescript + * const billingSession = sdkInstance.createPayPalBillingAgreementWithoutPurchase({ + * billingToken: 'your-billing-token', + * onApprove: (data) => { + * console.log('Billing agreement approved:', data); + * }, + * onCancel: () => { + * console.log('Billing agreement canceled'); + * }, + * onError: (data) => { + * console.error('Billing agreement error:', data); + * } + * }); + * ``` */ createPayPalBillingAgreementWithoutPurchase: ( paymentSessionOptions: PayPalLegacyBillingAgreementsSessionOptions, From 0dc4557eb366ced00b3d826c102633dc976b54ef Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 10:44:29 -0400 Subject: [PATCH 3/9] add jsdoc comments to paypal payments --- .../types/v6/components/paypal-payments.d.ts | 100 ++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/packages/paypal-js/types/v6/components/paypal-payments.d.ts b/packages/paypal-js/types/v6/components/paypal-payments.d.ts index 38c9e87c..fdf20fbf 100644 --- a/packages/paypal-js/types/v6/components/paypal-payments.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-payments.d.ts @@ -122,15 +122,115 @@ export type PayPalCreditOneTimePaymentSessionOptions = PayPalOneTimePaymentSessionOptions; export interface PayPalPaymentsInstance { + /** + * Creates a PayPal one-time payment session for processing single payments through PayPal. + * This method allows you to configure callback functions to handle different stages + * of the PayPal checkout process, including payment approval, shipping address changes, + * shipping option changes, cancelation, and errors. + * + * @param paymentSessionOptions - Configuration options for the PayPal payment session + * @returns A OneTimePaymentSession object that can be used to start the payment flow + * + * @example + * ```typescript + * const paypalSession = sdkInstance.createPayPalOneTimePaymentSession({ + * onApprove: (data) => { + * console.log('PayPal payment approved:', data); + * }, + * onShippingAddressChange: (data) => { + * console.log('Shipping address changed:', data); + * }, + * onShippingOptionsChange: (data) => { + * console.log('Shipping options changed:', data); + * }, + * onCancel: () => { + * console.log('PayPal payment canceled'); + * }, + * onError: (data) => { + * console.error('PayPal payment error:', data); + * } + * }); + * ``` + */ createPayPalOneTimePaymentSession: ( paymentSessionOptions: PayPalOneTimePaymentSessionOptions, ) => OneTimePaymentSession; + /** + * Creates a PayPal save payment session for storing payment methods for future use. + * This method allows you to set up vault payment sessions where customers can save + * their PayPal payment method for future transactions without re-entering details. + * + * @param paymentSessionOptions - Configuration options for the save payment session + * @returns A SavePaymentSession object that can be used to start the vault setup flow + * + * @example + * ```typescript + * const savePaymentSession = sdkInstance.createPayPalSavePaymentSession({ + * vaultSetupToken: 'your-vault-setup-token', + * onApprove: (data) => { + * console.log('Payment method saved:', data); + * }, + * onCancel: () => { + * console.log('Save payment canceled'); + * }, + * onError: (data) => { + * console.error('Save payment error:', data); + * } + * }); + * ``` + */ createPayPalSavePaymentSession: ( paymentSessionOptions: SavePaymentSessionOptions, ) => SavePaymentSession; + /** + * Creates a PayPal Pay Later one-time payment session for buy now, pay later transactions. + * This method enables customers to make purchases and pay for them over time through + * PayPal's Pay Later financing options. Available in supported countries. + * + * @param paymentSessionOptions - Configuration options for the Pay Later payment session + * @returns A OneTimePaymentSession object that can be used to start the Pay Later flow + * + * @example + * ```typescript + * const payLaterSession = sdkInstance.createPayLaterOneTimePaymentSession({ + * onApprove: (data) => { + * console.log('Pay Later payment approved:', data); + * }, + * onCancel: () => { + * console.log('Pay Later payment canceled'); + * }, + * onError: (data) => { + * console.error('Pay Later payment error:', data); + * } + * }); + * ``` + */ createPayLaterOneTimePaymentSession: ( paymentSessionOptions: PayLaterOneTimePaymentSessionOptions, ) => OneTimePaymentSession; + /** + * Creates a PayPal Credit one-time payment session for credit-based transactions. + * This method enables customers to make purchases using PayPal Credit, allowing them + * to pay over time with financing options. Available in supported countries. + * + * @param paymentSessionOptions - Configuration options for the PayPal Credit payment session + * @returns A OneTimePaymentSession object that can be used to start the PayPal Credit flow + * + * @example + * ```typescript + * const creditSession = sdkInstance.createPayPalCreditOneTimePaymentSession({ + * onApprove: (data) => { + * console.log('PayPal Credit payment approved:', data); + * }, + * onCancel: () => { + * console.log('PayPal Credit payment canceled'); + * }, + * onError: (data) => { + * console.error('PayPal Credit payment error:', data); + * } + * }); + * ``` + */ createPayPalCreditOneTimePaymentSession: ( paymentSessionOptions: PayPalCreditOneTimePaymentSessionOptions, ) => OneTimePaymentSession; From d651e6c52be34fee6401c0e7cbe606024e890b32 Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 10:47:03 -0400 Subject: [PATCH 4/9] add jsdoc comments to venmo payments --- .../types/v6/components/venmo-payments.d.ts | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/packages/paypal-js/types/v6/components/venmo-payments.d.ts b/packages/paypal-js/types/v6/components/venmo-payments.d.ts index d425aea0..6c4af2a9 100644 --- a/packages/paypal-js/types/v6/components/venmo-payments.d.ts +++ b/packages/paypal-js/types/v6/components/venmo-payments.d.ts @@ -27,6 +27,29 @@ export type VenmoOneTimePaymentSession = Omit & { }; export interface VenmoPaymentsInstance { + /** + * Creates a Venmo one-time payment session for processing payments through Venmo. + * This method allows you to configure callback functions to handle different stages + * of the Venmo checkout process, including payment approval, cancelation, and errors. + * + * @param paymentSessionOptions - Configuration options for the Venmo payment session + * @returns A VenmoOneTimePaymentSession object that can be used to start the payment flow + * + * @example + * ```typescript + * const venmoSession = sdkInstance.createVenmoOneTimePaymentSession({ + * onApprove: (data) => { + * console.log('Venmo payment approved:', data); + * }, + * onCancel: () => { + * console.log('Venmo payment canceled'); + * }, + * onError: (data) => { + * console.error('Venmo payment error:', data); + * } + * }); + * ``` + */ createVenmoOneTimePaymentSession: ( paymentSessionOptions: VenmoOneTimePaymentSessionOptions, ) => VenmoOneTimePaymentSession; From 159983267355905bc6e7c0e97bff5e821fe5a3bb Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 11:04:54 -0400 Subject: [PATCH 5/9] add changeset --- .changeset/smooth-dolphins-approve.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/smooth-dolphins-approve.md diff --git a/.changeset/smooth-dolphins-approve.md b/.changeset/smooth-dolphins-approve.md new file mode 100644 index 00000000..9106af37 --- /dev/null +++ b/.changeset/smooth-dolphins-approve.md @@ -0,0 +1,5 @@ +--- +"@paypal/paypal-js": patch +--- + +feat: add jsdoc comments to v6 public interface types From 75252ac4e285e7d4d2260571c551068e6c02df8b Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 12:06:59 -0400 Subject: [PATCH 6/9] add types to jsdoc comments --- .../paypal-legacy-billing-agreements.d.ts | 8 +++++--- .../types/v6/components/paypal-payments.d.ts | 16 ++++++++-------- .../types/v6/components/venmo-payments.d.ts | 4 ++-- packages/paypal-js/types/v6/index.d.ts | 11 ++++++----- 4 files changed, 21 insertions(+), 18 deletions(-) diff --git a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts index 614c5a22..66e83fbb 100644 --- a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts @@ -7,6 +7,8 @@ import { PresentationModeOptionsForPaymentHandler, } from "./base-component"; +import { PayPalPaymentsInstance } from "./paypal-payments.d"; + export type OnApproveDataBillingAgreements = { billingToken: string; payerId?: string; @@ -47,10 +49,10 @@ export interface PayPalLegacyBillingInstance { * that can be used for future transactions. * * @deprecated This method is legacy and should not be used for new implementations. - * Use the newer vault setup token approach with createPayPalSavePaymentSession instead. + * Use the newer vault setup token approach with {@link PayPalPaymentsInstance.createPayPalSavePaymentSession} instead. * - * @param paymentSessionOptions - Configuration options for the billing agreement session - * @returns A PayPalLegacyBillingAgreementsSession object that can be used to start the billing agreement flow + * @param {PayPalLegacyBillingAgreementsSessionOptions} paymentSessionOptions - Configuration options for the billing agreement session + * @returns {PayPalLegacyBillingAgreementsSession} - A session object that can be used to start the billing agreement flow * * @example * ```typescript diff --git a/packages/paypal-js/types/v6/components/paypal-payments.d.ts b/packages/paypal-js/types/v6/components/paypal-payments.d.ts index fdf20fbf..93e9dcf3 100644 --- a/packages/paypal-js/types/v6/components/paypal-payments.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-payments.d.ts @@ -128,8 +128,8 @@ export interface PayPalPaymentsInstance { * of the PayPal checkout process, including payment approval, shipping address changes, * shipping option changes, cancelation, and errors. * - * @param paymentSessionOptions - Configuration options for the PayPal payment session - * @returns A OneTimePaymentSession object that can be used to start the payment flow + * @param {PayPalOneTimePaymentSessionOptions} paymentSessionOptions - Configuration options for the PayPal payment session + * @returns {OneTimePaymentSession} - A session object that can be used to start the payment flow * * @example * ```typescript @@ -160,8 +160,8 @@ export interface PayPalPaymentsInstance { * This method allows you to set up vault payment sessions where customers can save * their PayPal payment method for future transactions without re-entering details. * - * @param paymentSessionOptions - Configuration options for the save payment session - * @returns A SavePaymentSession object that can be used to start the vault setup flow + * @param {SavePaymentSessionOptions} paymentSessionOptions - Configuration options for the save payment session + * @returns {SavePaymentSession} - A session object that can be used to start the vault setup flow * * @example * ```typescript @@ -187,8 +187,8 @@ export interface PayPalPaymentsInstance { * This method enables customers to make purchases and pay for them over time through * PayPal's Pay Later financing options. Available in supported countries. * - * @param paymentSessionOptions - Configuration options for the Pay Later payment session - * @returns A OneTimePaymentSession object that can be used to start the Pay Later flow + * @param {PayLaterOneTimePaymentSessionOptions} paymentSessionOptions - Configuration options for the Pay Later payment session + * @returns {OneTimePaymentSession} - A session object that can be used to start the Pay Later flow * * @example * ```typescript @@ -213,8 +213,8 @@ export interface PayPalPaymentsInstance { * This method enables customers to make purchases using PayPal Credit, allowing them * to pay over time with financing options. Available in supported countries. * - * @param paymentSessionOptions - Configuration options for the PayPal Credit payment session - * @returns A OneTimePaymentSession object that can be used to start the PayPal Credit flow + * @param {PayPalCreditOneTimePaymentSessionOptions} paymentSessionOptions - Configuration options for the PayPal Credit payment session + * @returns {OneTimePaymentSession} - A session object that can be used to start the PayPal Credit flow * * @example * ```typescript diff --git a/packages/paypal-js/types/v6/components/venmo-payments.d.ts b/packages/paypal-js/types/v6/components/venmo-payments.d.ts index 6c4af2a9..6d834642 100644 --- a/packages/paypal-js/types/v6/components/venmo-payments.d.ts +++ b/packages/paypal-js/types/v6/components/venmo-payments.d.ts @@ -32,8 +32,8 @@ export interface VenmoPaymentsInstance { * This method allows you to configure callback functions to handle different stages * of the Venmo checkout process, including payment approval, cancelation, and errors. * - * @param paymentSessionOptions - Configuration options for the Venmo payment session - * @returns A VenmoOneTimePaymentSession object that can be used to start the payment flow + * @param {VenmoOneTimePaymentSessionOptions} paymentSessionOptions - Configuration options for the Venmo payment session + * @returns {VenmoOneTimePaymentSession} - A session object that can be used to start the payment flow * * @example * ```typescript diff --git a/packages/paypal-js/types/v6/index.d.ts b/packages/paypal-js/types/v6/index.d.ts index c4f8c7da..b8dbeca8 100644 --- a/packages/paypal-js/types/v6/index.d.ts +++ b/packages/paypal-js/types/v6/index.d.ts @@ -14,8 +14,8 @@ export interface PayPalV6Namespace { * client token and components. The SDK is designed to be lightweight and modular, * allowing you to load only the functionality you need. * - * @param createInstanceOptions - Configuration options for creating the SDK instance - * @returns A promise that resolves to an SDK instance with methods based on the specified components + * @param {CreateInstanceOptions} createInstanceOptions - Configuration options for creating the SDK instance + * @returns {Promise>} - A promise that resolves to an SDK instance with methods based on the specified components * * @example * ```typescript @@ -108,8 +108,8 @@ export interface BaseInstance { * public API to determine whether payment methods (such as PayPal or Venmo) can be used. * Use this to conditionally render the appropriate payment buttons on your site. * - * @param findEligibleMethodsOptions - Options for checking payment method eligibility - * @returns A promise that resolves to payment methods eligibility information + * @param {FindEligibleMethodsOptions} findEligibleMethodsOptions - Options for checking payment method eligibility + * @returns {Promise} - A promise that resolves to payment methods eligibility information * * @example * ```typescript @@ -129,7 +129,8 @@ export interface BaseInstance { * This method allows you to dynamically change the locale of the SDK instance * after it has been initialized. The locale should be specified using a BCP-47 code. * - * @param locale - The new locale to set, specified as a BCP-47 code (e.g., "en-US", "es-ES") + * @param {string} locale - The new locale to set, specified as a BCP-47 code (e.g., "en-US", "es-ES") + * @returns {void} * * @example * ```typescript From 6b7dcc8fb359b345eef80e3154781d4b6533007d Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Thu, 2 Oct 2025 12:41:02 -0400 Subject: [PATCH 7/9] ignore eslint error --- .../types/v6/components/paypal-legacy-billing-agreements.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts index 66e83fbb..c1531a12 100644 --- a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts @@ -7,6 +7,7 @@ import { PresentationModeOptionsForPaymentHandler, } from "./base-component"; +// eslint-disable-next-line @typescript-eslint/no-unused-vars import { PayPalPaymentsInstance } from "./paypal-payments.d"; export type OnApproveDataBillingAgreements = { From b9f0713fbf8bd66a64e627bb5d41068597cb7711 Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Fri, 3 Oct 2025 16:40:55 -0400 Subject: [PATCH 8/9] add jsdoc comments to interfaces --- .../paypal-legacy-billing-agreements.d.ts | 35 +++++++++++++++++++ .../types/v6/components/paypal-payments.d.ts | 27 ++++++++++++++ .../types/v6/components/venmo-payments.d.ts | 10 ++++++ 3 files changed, 72 insertions(+) diff --git a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts index c1531a12..3dcd0ee1 100644 --- a/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-legacy-billing-agreements.d.ts @@ -43,6 +43,41 @@ export type PayPalLegacyBillingAgreementsSession = Omit< ) => Promise; }; +/** + * Interface for PayPal legacy billing agreement functionality. + * + * @deprecated This interface provides legacy billing agreement methods that should not be used for new implementations. + * Use the newer vault setup token approach with {@link PayPalPaymentsInstance.createPayPalSavePaymentSession} instead. + * + * @interface PayPalLegacyBillingInstance + * @description Provides methods for creating billing agreements without requiring an immediate purchase. + * This legacy interface allows merchants to set up recurring payment agreements with customers + * that can be used for future transactions. + * + * @example + * ```typescript + * // Legacy billing agreement setup (deprecated) + * const billingAgreementWithoutPurchaseSession = sdkInstance.createPayPalBillingAgreementWithoutPurchase({ + * billingToken: 'your-billing-token', + * onApprove: (data) => { + * console.log('Billing agreement approved:', data); + * }, + * onCancel: () => { + * console.log('Billing agreement canceled'); + * }, + * onError: (data) => { + * console.error('Billing agreement error:', data); + * } + * }); + * + * // Start the billing agreement flow + * await billingAgreementWithoutPurchaseSession.start({ + * mode: 'popup' + * }); + * ``` + * + * @see {@link PayPalPaymentsInstance.createPayPalSavePaymentSession} For the recommended modern approach + */ export interface PayPalLegacyBillingInstance { /** * Creates a PayPal billing agreement session without requiring an immediate purchase. diff --git a/packages/paypal-js/types/v6/components/paypal-payments.d.ts b/packages/paypal-js/types/v6/components/paypal-payments.d.ts index 93e9dcf3..2477cadf 100644 --- a/packages/paypal-js/types/v6/components/paypal-payments.d.ts +++ b/packages/paypal-js/types/v6/components/paypal-payments.d.ts @@ -121,6 +121,33 @@ export type PayLaterOneTimePaymentSessionOptions = export type PayPalCreditOneTimePaymentSessionOptions = PayPalOneTimePaymentSessionOptions; +/** + * PayPal Payments Instance interface for creating and managing different types of PayPal payment sessions. + * + * This interface provides methods to create various PayPal payment flows including: + * - One-time payments with standard PayPal + * - Save payment methods for future use (vaulting) + * - PayPal Pay Later financing options + * - PayPal Credit transactions + * + * Each method returns a payment session object that can be used to initiate the corresponding + * payment flow with different presentation modes (popup, modal, redirect, etc.). + * + * @interface PayPalPaymentsInstance + * + * @example + * ```typescript + * // Create a one-time payment session + * const paypalCheckout = sdkInstance.createPayPalOneTimePaymentSession({ + * onApprove: (data) => console.log('Payment approved:', data), + * onCancel: () => console.log('Payment canceled'), + * onError: (data) => console.error('Payment error:', data) + * }); + * + * // Start the payment flow + * await paypalCheckout.start({ mode: 'auto' }); + * ``` + */ export interface PayPalPaymentsInstance { /** * Creates a PayPal one-time payment session for processing single payments through PayPal. diff --git a/packages/paypal-js/types/v6/components/venmo-payments.d.ts b/packages/paypal-js/types/v6/components/venmo-payments.d.ts index 6d834642..09986ab5 100644 --- a/packages/paypal-js/types/v6/components/venmo-payments.d.ts +++ b/packages/paypal-js/types/v6/components/venmo-payments.d.ts @@ -26,6 +26,16 @@ export type VenmoOneTimePaymentSession = Omit & { ) => Promise; }; +/** + * Interface for managing Venmo payment operations within the PayPal SDK. + * This interface provides methods for creating and managing Venmo payment sessions, + * allowing merchants to integrate Venmo as a payment method in their applications. + * + * The {@link VenmoPaymentsInstance} enables seamless integration with Venmo's payment flow, + * providing a secure and user-friendly way to process payments through the Venmo platform. + * + * @interface VenmoPaymentsInstance + */ export interface VenmoPaymentsInstance { /** * Creates a Venmo one-time payment session for processing payments through Venmo. From 87cea4810f44a6e9880a41540b2dcd3f65bc6fb8 Mon Sep 17 00:00:00 2001 From: Nate Bierdeman Date: Mon, 6 Oct 2025 13:57:54 -0400 Subject: [PATCH 9/9] feedback --- packages/paypal-js/types/v6/index.d.ts | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/packages/paypal-js/types/v6/index.d.ts b/packages/paypal-js/types/v6/index.d.ts index b8dbeca8..f3fecef5 100644 --- a/packages/paypal-js/types/v6/index.d.ts +++ b/packages/paypal-js/types/v6/index.d.ts @@ -8,14 +8,13 @@ import { export interface PayPalV6Namespace { /** - * Creates an SDK instance with the specified components and configuration. + * Creates an SDK instance, which is the first step in an SDK integration. This instance serves as the base layer for all SDK components. * * This is an asynchronous method that initializes the PayPal SDK with the provided - * client token and components. The SDK is designed to be lightweight and modular, - * allowing you to load only the functionality you need. + * client token and components. * * @param {CreateInstanceOptions} createInstanceOptions - Configuration options for creating the SDK instance - * @returns {Promise>} - A promise that resolves to an SDK instance with methods based on the specified components + * @returns {Promise>} - A promise that resolves to an SDK instance with methods based on the specified components * * @example * ```typescript