@wix/auto_sdk_payments_saved-payment-methods 1.0.6 → 1.0.7

package/build/{internal/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal-B6MQtNCZ.d.ts → cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.d.ts}

@@ -1,4 +1,5 @@
-interface SavedPaymentMethod {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface SavedPaymentMethod {
     /**
      * Unique identifier of a saved payment method.
      * @format GUID
@@ -46,7 +47,7 @@ interface SavedPaymentMethod {
     /** Data Extensions */
     extendedFields?: ExtendedFields;
 }
-interface CardInfo {
+export interface CardInfo {
     /**
      * Credit card's last 4 digits.
      * @minLength 4
@@ -82,7 +83,7 @@ interface CardInfo {
      */
     cardholderName?: string | null;
 }
-declare enum CardBrand {
+export declare enum CardBrand {
     UNKNOWN_CARD_BRAND = "UNKNOWN_CARD_BRAND",
     AMEX = "AMEX",
     DANKORT = "DANKORT",
@@ -96,7 +97,7 @@ declare enum CardBrand {
     VISA = "VISA",
     RUPAY = "RUPAY"
 }
-interface PaymentMethod {
+export interface PaymentMethod {
     /**
      * Legacy payment method type ID. Supported values are `creditCard`, `payPal`.
      * @minLength 1
@@ -121,18 +122,18 @@ interface PaymentMethod {
     /** Details of credit card. */
     cardInfo?: CardInfo;
 }
-interface SensitiveInfo {
+export interface SensitiveInfo {
     /** Sensitive details of credit card like card token. */
     cardSensitiveInfo?: CardSensitiveInfo;
 }
-interface CardSensitiveInfo {
+export interface CardSensitiveInfo {
     /**
      * Persistent token of credit card tokenized by Wix.
      * @format GUID
      */
     persistentToken?: string | null;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -143,7 +144,7 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface UpsertSavedPaymentMethodRequest {
+export interface UpsertSavedPaymentMethodRequest {
     /** Saved payment method. */
     savedPaymentMethod: SavedPaymentMethod;
     /**
@@ -152,11 +153,11 @@ interface UpsertSavedPaymentMethodRequest {
      */
     temporaryCardToken: string | null;
 }
-interface UpsertSavedPaymentMethodResponse {
+export interface UpsertSavedPaymentMethodResponse {
     /** Saved payment method. */
     savedPaymentMethod?: SavedPaymentMethod;
 }
-interface GetSavedPaymentMethodRequest {
+export interface GetSavedPaymentMethodRequest {
     /**
      * Unique identifier of a saved payment method.
      * @format GUID
@@ -169,25 +170,25 @@ interface GetSavedPaymentMethodRequest {
      */
     fields?: RequestedFields[];
 }
-declare enum RequestedFields {
+export declare enum RequestedFields {
     /** Default value. This value is unused. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     SENSITIVE_INFO = "SENSITIVE_INFO"
 }
-interface GetSavedPaymentMethodResponse {
+export interface GetSavedPaymentMethodResponse {
     /** Saved payment method. */
     savedPaymentMethod?: SavedPaymentMethod;
 }
-interface DeleteSavedPaymentMethodRequest {
+export interface DeleteSavedPaymentMethodRequest {
     /**
      * Unique identifier of a saved payment method.
      * @format GUID
      */
     savedPaymentMethodId: string;
 }
-interface DeleteSavedPaymentMethodResponse {
+export interface DeleteSavedPaymentMethodResponse {
 }
-interface ListSavedPaymentMethodsRequest {
+export interface ListSavedPaymentMethodsRequest {
     /**
      * Site member that owns saved payment methods.
      * Pass `me` to list saved payment method of the current site member.
@@ -220,7 +221,7 @@ interface ListSavedPaymentMethodsRequest {
      */
     paging?: CursorPaging;
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -235,13 +236,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface ListSavedPaymentMethodsResponse {
+export interface ListSavedPaymentMethodsResponse {
     /** List of saved payment methods. */
     savedPaymentMethods?: SavedPaymentMethod[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -254,7 +255,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -266,24 +267,24 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface UpdateSavedPaymentMethodRequest {
+export interface UpdateSavedPaymentMethodRequest {
     /** Saved payment method to update. */
     savedPaymentMethod?: SavedPaymentMethod;
 }
-interface UpdateSavedPaymentMethodResponse {
+export interface UpdateSavedPaymentMethodResponse {
     /** Updated saved payment method. */
     savedPaymentMethod?: SavedPaymentMethod;
 }
-interface MarkSavedPaymentMethodPrimaryRequest {
+export interface MarkSavedPaymentMethodPrimaryRequest {
     /**
      * Unique identifier of a saved payment method.
      * @format GUID
      */
     savedPaymentMethodId: string;
 }
-interface MarkSavedPaymentMethodPrimaryResponse {
+export interface MarkSavedPaymentMethodPrimaryResponse {
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -326,19 +327,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+export interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -346,14 +347,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -369,7 +370,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -394,7 +395,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -416,14 +417,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface FindSavedCreditCardRequest {
+export interface FindSavedCreditCardRequest {
     /**
      * temporary card token
      * @format GUID
@@ -447,14 +448,14 @@ interface FindSavedCreditCardRequest {
      */
     expirationYear?: number;
 }
-interface FindSavedCreditCardResponse {
+export interface FindSavedCreditCardResponse {
     /**
      * saved payment method id
      * @format GUID
      */
     savedPaymentMethodId?: string | null;
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -468,7 +469,7 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface EventMetadata extends BaseEventMetadata {
+export interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -506,25 +507,82 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface SavedPaymentMethodCreatedEnvelope {
+export interface SavedPaymentMethodCreatedEnvelope {
     entity: SavedPaymentMethod;
     metadata: EventMetadata;
 }
-interface SavedPaymentMethodDeletedEnvelope {
+/** @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
+ * @webhook
+ * @eventType wix.payments.saved_payment_methods.v1.saved_payment_method_created
+ * @serviceIdentifier wix.payments.saved_payment_methods.v1.SavedPaymentMethodService
+ * @slug created
+ * @documentationMaturity preview
+ */
+export declare function onSavedPaymentMethodCreated(handler: (event: SavedPaymentMethodCreatedEnvelope) => void | Promise<void>): void;
+export interface SavedPaymentMethodDeletedEnvelope {
     metadata: EventMetadata;
 }
-interface SavedPaymentMethodUpdatedEnvelope {
+/** @webhook
+ * @eventType wix.payments.saved_payment_methods.v1.saved_payment_method_deleted
+ * @serviceIdentifier wix.payments.saved_payment_methods.v1.SavedPaymentMethodService
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+export declare function onSavedPaymentMethodDeleted(handler: (event: SavedPaymentMethodDeletedEnvelope) => void | Promise<void>): void;
+export interface SavedPaymentMethodUpdatedEnvelope {
     entity: SavedPaymentMethod;
     metadata: EventMetadata;
 }
-interface UpsertSavedPaymentMethodOptions {
+/** @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
+ * @webhook
+ * @eventType wix.payments.saved_payment_methods.v1.saved_payment_method_updated
+ * @serviceIdentifier wix.payments.saved_payment_methods.v1.SavedPaymentMethodService
+ * @slug updated
+ * @documentationMaturity preview
+ */
+export declare function onSavedPaymentMethodUpdated(handler: (event: SavedPaymentMethodUpdatedEnvelope) => void | Promise<void>): void;
+type SavedPaymentMethodNonNullablePaths = `primary` | `paymentMethod.typeId` | `paymentMethod.paymentMethodTypeId`;
+/**
+ * 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.temporaryCardToken
+ * @requiredField savedPaymentMethod
+ * @requiredField savedPaymentMethod.paymentMethod
+ * @requiredField savedPaymentMethod.paymentMethod.cardInfo.expirationMonth
+ * @requiredField savedPaymentMethod.paymentMethod.cardInfo.expirationYear
+ * @requiredField savedPaymentMethod.paymentMethod.typeId
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_UPSERT
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_UPSERT_WITH_MEMBER_ID
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.UpsertSavedPaymentMethod
+ */
+export declare function upsertSavedPaymentMethod(savedPaymentMethod: NonNullablePaths<SavedPaymentMethod, `paymentMethod` | `paymentMethod.cardInfo.expirationMonth` | `paymentMethod.cardInfo.expirationYear` | `paymentMethod.typeId`>, options: NonNullablePaths<UpsertSavedPaymentMethodOptions, `temporaryCardToken`>): Promise<NonNullablePaths<UpsertSavedPaymentMethodResponse, {
+    [P in SavedPaymentMethodNonNullablePaths]: `savedPaymentMethod.${P}`;
+}[SavedPaymentMethodNonNullablePaths]>>;
+export interface UpsertSavedPaymentMethodOptions {
     /**
      * Temporary token of credit card tokenized by Wix. This token is used to create a persistent token
      * @format GUID
      */
     temporaryCardToken: string | null;
 }
-interface GetSavedPaymentMethodOptions {
+/**
+ * Returns SavedPaymentMethod 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.
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.GetSavedPaymentMethod
+ */
+export declare function getSavedPaymentMethod(savedPaymentMethodId: string, options?: GetSavedPaymentMethodOptions): Promise<NonNullablePaths<SavedPaymentMethod, SavedPaymentMethodNonNullablePaths>>;
+export 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.
@@ -532,7 +590,28 @@ interface GetSavedPaymentMethodOptions {
      */
     fields?: RequestedFields[];
 }
-interface ListSavedPaymentMethodsOptions {
+/**
+ * Deletes SavedPaymentMethod by ID.
+ * @param savedPaymentMethodId - Unique identifier of a saved payment method.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField savedPaymentMethodId
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_DELETE
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.DeleteSavedPaymentMethod
+ */
+export declare function deleteSavedPaymentMethod(savedPaymentMethodId: string): Promise<void>;
+/**
+ * Lists SavedPaymentMethods ordered by update date descending.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.ListSavedPaymentMethods
+ */
+export declare function listSavedPaymentMethods(options?: ListSavedPaymentMethodsOptions): Promise<NonNullablePaths<ListSavedPaymentMethodsResponse, {
+    [P in SavedPaymentMethodNonNullablePaths]: `savedPaymentMethods.${number}.${P}`;
+}[SavedPaymentMethodNonNullablePaths]>>;
+export interface ListSavedPaymentMethodsOptions {
     /**
      * Site member that owns saved payment methods.
      * Pass `me` to list saved payment method of the current site member.
@@ -565,7 +644,19 @@ interface ListSavedPaymentMethodsOptions {
      */
     paging?: CursorPaging;
 }
-interface UpdateSavedPaymentMethodOptions {
+/**
+ * Updates SavedPaymentMethod. Only fields listed in field_mask are updated.
+ * @param _id - Unique identifier of a saved payment method.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.savedPaymentMethod.revision
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_UPDATE
+ * @returns Updated saved payment method.
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.UpdateSavedPaymentMethod
+ */
+export declare function updateSavedPaymentMethod(_id: string, options?: NonNullablePaths<UpdateSavedPaymentMethodOptions, `savedPaymentMethod.revision`>): Promise<NonNullablePaths<SavedPaymentMethod, SavedPaymentMethodNonNullablePaths>>;
+export interface UpdateSavedPaymentMethodOptions {
     savedPaymentMethod: {
         /**
          * Unique identifier of a saved payment method.
@@ -615,5 +706,17 @@ interface UpdateSavedPaymentMethodOptions {
         extendedFields?: ExtendedFields;
     };
 }
-
-export { type ActionEvent as A, type BaseEventMetadata as B, CardBrand as C, type DeleteSavedPaymentMethodRequest as D, type ExtendedFields as E, type FindSavedCreditCardRequest as F, type GetSavedPaymentMethodOptions as G, type EventMetadata as H, type IdentificationData as I, type SavedPaymentMethodCreatedEnvelope as J, type SavedPaymentMethodDeletedEnvelope as K, type ListSavedPaymentMethodsOptions as L, type MarkSavedPaymentMethodPrimaryRequest as M, type SavedPaymentMethodUpdatedEnvelope as N, type PaymentMethod as P, RequestedFields as R, type SavedPaymentMethod as S, type UpsertSavedPaymentMethodOptions as U, WebhookIdentityType as W, type UpsertSavedPaymentMethodResponse as a, type ListSavedPaymentMethodsResponse as b, type UpdateSavedPaymentMethodOptions as c, type CardInfo as d, type SensitiveInfo as e, type CardSensitiveInfo as f, type UpsertSavedPaymentMethodRequest as g, type GetSavedPaymentMethodRequest as h, type GetSavedPaymentMethodResponse as i, type DeleteSavedPaymentMethodResponse as j, type ListSavedPaymentMethodsRequest as k, type CursorPaging as l, type CursorPagingMetadata as m, type Cursors as n, type UpdateSavedPaymentMethodRequest as o, type UpdateSavedPaymentMethodResponse as p, type MarkSavedPaymentMethodPrimaryResponse as q, type DomainEvent as r, type DomainEventBodyOneOf as s, type EntityCreatedEvent as t, type RestoreInfo as u, type EntityUpdatedEvent as v, type EntityDeletedEvent as w, type MessageEnvelope as x, type IdentificationDataIdOneOf as y, type FindSavedCreditCardResponse as z };
+/**
+ * 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.
+ * @param savedPaymentMethodId - Unique identifier of a saved payment method.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField savedPaymentMethodId
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_MARK_PRIMARY
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.MarkSavedPaymentMethodPrimary
+ */
+export declare function markSavedPaymentMethodPrimary(savedPaymentMethodId: string): Promise<void>;
+export {};