@wix/auto_sdk_payments_saved-payment-methods 1.0.41 → 1.0.43

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

@@ -2,83 +2,88 @@ import { NonNullablePaths } from '@wix/sdk-types';
 
 interface SavedPaymentMethod {
     /**
-     * Unique identifier of a saved payment method.
+     * Saved payment method ID.
      * @format GUID
      * @readonly
      */
     _id?: string | null;
     /**
-     * Represents the current state of a saved payment method. Each time saved payment method is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
+     * Revision number, which increments by 1 each time the saved payment method is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the saved payment method.
      * @readonly
      */
     revision?: string | null;
     /**
-     * SavedPaymentMethod creation time.
+     * Date and time the saved payment method was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * SavedPaymentMethod last update time.
+     * Date and time the saved payment method was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Saved payment method owner's member ID.
+     * ID of the site member who owns this saved payment method.
      * @format GUID
      * @immutable
      */
     siteMemberId?: string | null;
     /**
-     * Defines whether this payment method is primary for the member. Member can only have at most one primary saved payment method.
+     * Whether this saved payment method is the primary one for the member. Each member can have at most one primary saved payment method. The primary method is selected by default during checkout.
      * @readonly
      */
     primary?: boolean;
     /** Payment method details. */
     paymentMethod?: PaymentMethod;
     /**
-     * Defines whether this payment method can be used by the merchant for making unscheduled payments.
-     * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
+     * Whether the merchant can use this payment method for unscheduled payments, such as manual charges.
+     * Even when set to `false`, the payment method can still be used for scheduled payments such as subscription renewals without the buyer being present.
      */
     merchantUseAllowed?: boolean | null;
     /**
-     * Saved payment method sensitive information.
+     * Saved payment method's sensitive information.
      * @readonly
      */
     sensitiveInfo?: SensitiveInfo;
-    /** Data Extensions */
+    /**
+     * Custom field data for the saved payment method object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
     extendedFields?: ExtendedFields;
 }
 interface CardInfo {
     /**
-     * Credit card's last 4 digits.
+     * Payment card's last 4 digits.
      * @minLength 4
      * @maxLength 4
      * @readonly
      */
     lastFourDigits?: string | null;
     /**
-     * Credit card's BIN (Bank Identification Number). It's first 4-6 digits of card's number.
+     * Payment card's BIN (Bank Identification Number). First 4-6 digits of the card number.
      * @minLength 4
      * @maxLength 6
      * @readonly
      */
     bin?: string | null;
     /**
-     * Credit card's expiration month.
+     * Payment card's expiration month.
      * @min 1
      * @max 12
      * @immutable
      */
     expirationMonth?: number | null;
     /**
-     * Credit card's expiration year.
+     * Payment card's expiration year.
      * @min 2000
      * @max 2099
      * @immutable
      */
     expirationYear?: number | null;
     /**
-     * Card holder's full name specified on the card.
+     * Cardholder's full name as it appears on the card.
      * @minLength 1
      * @maxLength 1000
      */
@@ -102,7 +107,7 @@ declare enum CardBrand {
 type CardBrandWithLiterals = CardBrand | 'UNKNOWN_CARD_BRAND' | 'AMEX' | 'DANKORT' | 'DINERS' | 'DISCOVER' | 'ISRACARD' | 'JCB' | 'MAESTRO' | 'MASTERCARD' | 'UNIONPAY' | 'VISA' | 'RUPAY';
 interface PaymentMethod {
     /**
-     * Legacy payment method type ID. Supported values are `creditCard`, `payPal`.
+     * Legacy payment method type ID. Supported values: `creditCard`, `payPal`.
      * @minLength 1
      * @maxLength 100
      * @immutable
@@ -122,16 +127,16 @@ interface PaymentMethod {
      * @immutable
      */
     paymentMethodBrandId?: string | null;
-    /** Details of credit card. */
+    /** Payment card details. */
     cardInfo?: CardInfo;
 }
 interface SensitiveInfo {
-    /** Sensitive details of credit card like card token. */
+    /** Payment card sensitive details. */
     cardSensitiveInfo?: CardSensitiveInfo;
 }
 interface CardSensitiveInfo {
     /**
-     * Persistent token of credit card tokenized by Wix.
+     * Persistent token of a payment card tokenized by Wix.
      * @format GUID
      */
     persistentToken?: string | null;
@@ -148,16 +153,16 @@ interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 interface UpsertSavedPaymentMethodRequest {
-    /** Saved payment method. */
+    /** Saved payment method to create or update. */
     savedPaymentMethod: SavedPaymentMethod;
     /**
-     * Temporary token of credit card tokenized by Wix. This token is used to create a persistent token
+     * Temporary token of a payment card tokenized by Wix. Used to create a persistent token for future transactions.
      * @format GUID
      */
     temporaryCardToken: string | null;
 }
 interface UpsertSavedPaymentMethodResponse {
-    /** Saved payment method. */
+    /** Created or updated saved payment method. */
     savedPaymentMethod?: SavedPaymentMethod;
 }
 interface GetSavedPaymentMethodRequest {
@@ -167,19 +172,19 @@ interface GetSavedPaymentMethodRequest {
      */
     savedPaymentMethodId: string;
     /**
-     * List of heeded fields that will be returned.
-     * You should have additional permission in order to get them as described in HidedFields documentation.
+     * Additional fields to return.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 declare enum RequestedFields {
+    /** Sensitive information such as payment card tokens. */
     SENSITIVE_INFO = "SENSITIVE_INFO"
 }
 /** @enumType */
 type RequestedFieldsWithLiterals = RequestedFields | 'SENSITIVE_INFO';
 interface GetSavedPaymentMethodResponse {
-    /** Saved payment method. */
+    /** Retrieved saved payment method. */
     savedPaymentMethod?: SavedPaymentMethod;
 }
 interface DeleteSavedPaymentMethodRequest {
@@ -193,34 +198,28 @@ interface DeleteSavedPaymentMethodResponse {
 }
 interface ListSavedPaymentMethodsRequest {
     /**
-     * Site member that owns saved payment methods.
-     * Pass `me` to list saved payment method of the current site member.
+     * ID of the site member whose saved payment methods to list. Pass `me` to list the current site member's saved payment methods.
      * @minLength 2
      * @maxLength 36
      */
     siteMemberId?: string | null;
     /**
-     * Payment method type id. Supported values are `creditCard`, `payPal`.
+     * Legacy payment method type ID. Supported values: `creditCard`, `payPal`.
      * @minLength 1
      * @maxLength 100
      */
     paymentMethodTypeId?: string | null;
-    /**
-     * Defines whether this payment method can be used by the merchant for making unscheduled payments.
-     * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
-     */
+    /** Whether to filter by saved payment methods that are allowed for unscheduled merchant-initiated payments. */
     merchantUseAllowed?: boolean | null;
     /**
-     * List of requested fields that will be returned.
-     * Supported values:
-     * SENSITIVE_INFO - Sensitive information of a SavedPaymentMethod like credit card tokens that's needed to process payments with it.
-     * In order to receive it you should have `PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO` permission
+     * Additional fields to return.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
     /**
-     * Paging for limit the response size.
-     * If no paging provider default response limit 100 will be used.
+     * Cursor paging parameters.
+     *
+     * Default: `100` results per page.
      */
     paging?: CursorPaging;
 }
@@ -242,7 +241,7 @@ interface CursorPaging {
 interface ListSavedPaymentMethodsResponse {
     /** List of saved payment methods. */
     savedPaymentMethods?: SavedPaymentMethod[];
-    /** Paging metadata. */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -562,10 +561,15 @@ interface SavedPaymentMethodUpdatedEnvelope {
  */
 declare function onSavedPaymentMethodUpdated(handler: (event: SavedPaymentMethodUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Creates a new SavedPaymentMethod or updates existing one if SavedPaymentMethod already exists for the same site member.
- * To check uniqueness SavedPaymentMethods are compared by credit card expiration year/month, last four digits and bin.
- * If sensitiveInfo.cardSensitiveInfo.temporaryToken was passed than service will eventually create a persi from it.
- * @param savedPaymentMethod - Saved payment method.
+ * Creates or updates a saved payment method.
+ *
+ * If a saved payment method with matching card details (expiration date, last four digits, and BIN) already exists for the same site member,
+ * the existing saved payment method is updated. Otherwise, a new saved payment method is created.
+ *
+ * Payment cards are currently supported. Support for other payment method types may vary and is subject to change.
+ *
+ * > **Note:** The system may limit the number of saved payment methods per site member.
+ * @param savedPaymentMethod - Saved payment method to create or update.
  * @public
  * @documentationMaturity preview
  * @requiredField options
@@ -582,33 +586,34 @@ declare function onSavedPaymentMethodUpdated(handler: (event: SavedPaymentMethod
 declare function upsertSavedPaymentMethod(savedPaymentMethod: NonNullablePaths<SavedPaymentMethod, `paymentMethod` | `paymentMethod.cardInfo.expirationMonth` | `paymentMethod.cardInfo.expirationYear` | `paymentMethod.typeId`, 4>, options: NonNullablePaths<UpsertSavedPaymentMethodOptions, `temporaryCardToken`, 2>): Promise<NonNullablePaths<UpsertSavedPaymentMethodResponse, `savedPaymentMethod.primary` | `savedPaymentMethod.paymentMethod.typeId` | `savedPaymentMethod.paymentMethod.paymentMethodTypeId`, 4>>;
 interface UpsertSavedPaymentMethodOptions {
     /**
-     * Temporary token of credit card tokenized by Wix. This token is used to create a persistent token
+     * Temporary token of a payment card tokenized by Wix. Used to create a persistent token for future transactions.
      * @format GUID
      */
     temporaryCardToken: string | null;
 }
 /**
- * Returns SavedPaymentMethod by ID.
+ * Retrieves a saved payment method by ID.
  * @param savedPaymentMethodId - Unique identifier of a saved payment method.
  * @public
  * @documentationMaturity preview
  * @requiredField savedPaymentMethodId
  * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
  * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO
- * @returns Saved payment method.
+ * @returns Retrieved saved payment method.
  * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.GetSavedPaymentMethod
  */
 declare function getSavedPaymentMethod(savedPaymentMethodId: string, options?: GetSavedPaymentMethodOptions): Promise<NonNullablePaths<SavedPaymentMethod, `primary` | `paymentMethod.typeId` | `paymentMethod.paymentMethodTypeId`, 3>>;
 interface GetSavedPaymentMethodOptions {
     /**
-     * List of heeded fields that will be returned.
-     * You should have additional permission in order to get them as described in HidedFields documentation.
+     * Additional fields to return.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * Deletes SavedPaymentMethod by ID.
+ * Deletes a saved payment method.
+ *
+ * If the deleted saved payment method was the primary one, the system automatically assigns another saved payment method as primary.
  * @param savedPaymentMethodId - Unique identifier of a saved payment method.
  * @public
  * @documentationMaturity preview
@@ -618,7 +623,7 @@ interface GetSavedPaymentMethodOptions {
  */
 declare function deleteSavedPaymentMethod(savedPaymentMethodId: string): Promise<void>;
 /**
- * Lists SavedPaymentMethods ordered by update date descending.
+ * Retrieves a list of saved payment methods, sorted by last updated date in descending order.
  * @public
  * @documentationMaturity preview
  * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
@@ -628,40 +633,38 @@ declare function deleteSavedPaymentMethod(savedPaymentMethodId: string): Promise
 declare function listSavedPaymentMethods(options?: ListSavedPaymentMethodsOptions): Promise<NonNullablePaths<ListSavedPaymentMethodsResponse, `savedPaymentMethods` | `savedPaymentMethods.${number}.primary` | `savedPaymentMethods.${number}.paymentMethod.typeId` | `savedPaymentMethods.${number}.paymentMethod.paymentMethodTypeId`, 5>>;
 interface ListSavedPaymentMethodsOptions {
     /**
-     * Site member that owns saved payment methods.
-     * Pass `me` to list saved payment method of the current site member.
+     * ID of the site member whose saved payment methods to list. Pass `me` to list the current site member's saved payment methods.
      * @minLength 2
      * @maxLength 36
      */
     siteMemberId?: string | null;
     /**
-     * Payment method type id. Supported values are `creditCard`, `payPal`.
+     * Legacy payment method type ID. Supported values: `creditCard`, `payPal`.
      * @minLength 1
      * @maxLength 100
      */
     paymentMethodTypeId?: string | null;
-    /**
-     * Defines whether this payment method can be used by the merchant for making unscheduled payments.
-     * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
-     */
+    /** Whether to filter by saved payment methods that are allowed for unscheduled merchant-initiated payments. */
     merchantUseAllowed?: boolean | null;
     /**
-     * List of requested fields that will be returned.
-     * Supported values:
-     * SENSITIVE_INFO - Sensitive information of a SavedPaymentMethod like credit card tokens that's needed to process payments with it.
-     * In order to receive it you should have `PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO` permission
+     * Additional fields to return.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
     /**
-     * Paging for limit the response size.
-     * If no paging provider default response limit 100 will be used.
+     * Cursor paging parameters.
+     *
+     * Default: `100` results per page.
      */
     paging?: CursorPaging;
 }
 /**
- * Updates SavedPaymentMethod. Only fields listed in field_mask are updated.
- * @param _id - Unique identifier of a saved payment method.
+ * Updates a saved payment method.
+ *
+ * Each time the saved payment method is updated, `revision` increments by 1.
+ * The current `revision` must be passed when updating the saved payment method.
+ * This ensures you're working with the latest saved payment method and prevents unintended overwrites.
+ * @param _id - Saved payment method ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -674,58 +677,62 @@ declare function updateSavedPaymentMethod(_id: string, options?: NonNullablePath
 interface UpdateSavedPaymentMethodOptions {
     savedPaymentMethod?: {
         /**
-         * Unique identifier of a saved payment method.
+         * Saved payment method ID.
          * @format GUID
          * @readonly
          */
         _id?: string | null;
         /**
-         * Represents the current state of a saved payment method. Each time saved payment method is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
+         * Revision number, which increments by 1 each time the saved payment method is updated.
+         * To prevent conflicting changes, the current revision must be passed when updating the saved payment method.
          * @readonly
          */
         revision?: string | null;
         /**
-         * SavedPaymentMethod creation time.
+         * Date and time the saved payment method was created.
          * @readonly
          */
         _createdDate?: Date | null;
         /**
-         * SavedPaymentMethod last update time.
+         * Date and time the saved payment method was last updated.
          * @readonly
          */
         _updatedDate?: Date | null;
         /**
-         * Saved payment method owner's member ID.
+         * ID of the site member who owns this saved payment method.
          * @format GUID
          * @immutable
          */
         siteMemberId?: string | null;
         /**
-         * Defines whether this payment method is primary for the member. Member can only have at most one primary saved payment method.
+         * Whether this saved payment method is the primary one for the member. Each member can have at most one primary saved payment method. The primary method is selected by default during checkout.
          * @readonly
          */
         primary?: boolean;
         /** Payment method details. */
         paymentMethod?: PaymentMethod;
         /**
-         * Defines whether this payment method can be used by the merchant for making unscheduled payments.
-         * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
+         * Whether the merchant can use this payment method for unscheduled payments, such as manual charges.
+         * Even when set to `false`, the payment method can still be used for scheduled payments such as subscription renewals without the buyer being present.
          */
         merchantUseAllowed?: boolean | null;
         /**
-         * Saved payment method sensitive information.
+         * Saved payment method's sensitive information.
          * @readonly
          */
         sensitiveInfo?: SensitiveInfo;
-        /** Data Extensions */
+        /**
+         * Custom field data for the saved payment method object.
+         *
+         * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+         */
         extendedFields?: ExtendedFields;
     };
 }
 /**
- * Marks SavedPaymentMethod as primary for site member who's the owner of this SavedPaymentMethod.
- * Primary SavedPaymentMethod is selected by default during the checkout.
- * For every site member there can be at most one primary SavedPaymentMethod,
- * so when one SavedPaymentMethod is marked as primary previous one is automatically unmarked.
+ * Marks a saved payment method as primary for the site member who owns it.
+ * A primary saved payment method is selected by default during checkout.
+ * Each site member can have at most one primary saved payment method, so marking one as primary automatically unmarks the previous one.
  * @param savedPaymentMethodId - Unique identifier of a saved payment method.
  * @public
  * @documentationMaturity preview

package/build/cjs/index.typings.js

@@ -245,7 +245,20 @@ function markSavedPaymentMethodPrimary(payload) {
         data: payload,
         host
       }),
-      params: (0, import_rest_modules.toURLSearchParams)(payload)
+      params: (0, import_rest_modules.toURLSearchParams)(payload),
+      fallback: [
+        {
+          method: "POST",
+          url: resolveWixPaymentsSavedPaymentMethodsV1SavedPaymentMethodServiceUrl(
+            {
+              protoPath: "/v1/saved-payment-methods/{savedPaymentMethodId}/mark-primary",
+              data: payload,
+              host
+            }
+          ),
+          data: payload
+        }
+      ]
     };
     return metadata;
   }