@wix/auto_sdk_payments_disputes 1.0.35 → 1.0.37

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

@@ -1,54 +1,61 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
-/** Dispute. A dispute occurs when an account owner contacts their PSP or bank to contest a payment to you for a number of possible reasons. */
+/**
+ * A dispute occurs when a customer contacts their payment service provider (PSP) or bank to contest a payment for reasons such as fraud, service issues, or billing errors.
+ *
+ * Disputes follow a structured lifecycle from creation through resolution.
+ * Merchants can either accept liability or defend with evidence, depending on the available actions and due dates.
+ * The dispute's channel (internal vs external) affects processing timelines and available options.
+ */
 interface Dispute {
     /**
-     * Dispute ID
+     * Dispute ID..
      * @format GUID
      * @immutable
      */
     _id?: string;
     /**
-     * Charge ID
+     * ID of the charge that is being disputed.
      * @format GUID
      * @immutable
      */
     chargeId?: string;
     /**
-     * Provider Dispute ID
+     * Unique identifier assigned by the payment service provider for this dispute.
      * @format GUID
      * @immutable
      */
     providerDisputeId?: string;
     /**
-     * Dispute stage
+     * Stage of the dispute process.
      * @readonly
      */
     stage?: DisputeStageWithLiterals;
     /**
-     * Dispute reason
+     * Reason why the customer initiated the dispute.
      * @readonly
      */
     reason?: DisputeReasonWithLiterals;
     /**
-     * Dispute currency. Should be the same as the charge currency.
+     * Three-letter currency code in @ISO-4217 alphabetic format. Matches the currency of the disputed charge.
      * @immutable
      * @format CURRENCY
      */
     currencyCode?: string | null;
     /**
-     * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
+     * Disputed amount in the currency's main units. For example, `"12.95"` for $12.95.
      * @immutable
      * @decimalValue options { gt:0, maxScale:8 }
      */
     amount?: string | null;
     /**
-     * Dispute status based on provider dispute status
+     * Current status of the dispute, indicating what action is required and who needs to take it.
      * @readonly
      */
     status?: DisputeStatusWithLiterals;
     /**
-     * Seller protection helps protect sellers from financial loss on eligible transactions due to unauthorized payments or claims that items were not received
+     * Level of seller protection coverage for this dispute.
+     * Seller protection helps protect merchants from financial loss on eligible transactions due to unauthorized payments or claims that items were not received.
      * @readonly
      */
     sellerProtection?: SellerProtectionWithLiterals;
@@ -59,55 +66,57 @@ interface Dispute {
      */
     channel?: DisputeChannelWithLiterals;
     /**
-     * The latest date and time until which the dispute can remain in its current status
+     * The latest date and time until which the dispute can remain in its current status.
      * @readonly
      */
     dueDate?: Date | null;
     /**
-     * Network reason code
+     * Network reason code provided by the card network or issuing bank that initiated the dispute.
      * @minLength 1
      * @maxLength 64
      */
     networkReasonCode?: string | null;
     /**
-     * True if dispute is defendable
+     * Whether the dispute can be defended with evidence.
      * @readonly
      */
     defendable?: boolean | null;
     /**
-     * True if it is an auto dispute
+     * Whether the dispute was automatically defended by the payment processor.
      * @readonly
      */
     autoDefended?: boolean | null;
     /**
-     * The dispute defended date
+     * Date and time when the dispute was defended.
      * @readonly
      */
     defendedDate?: Date | null;
     /**
-     * The dispute acceptance date
+     * Date and time when the dispute was accepted.
      * @readonly
      */
     acceptedDate?: Date | null;
     /**
-     * The actions that can be perform with the dispute
+     * Actions that can be performed on the dispute.
+     * Each action has a specific due date by which it must be completed.
+     * Available actions depend on the dispute's current status and stage.
      * @readonly
      * @maxSize 20
      */
     actions?: DisputeAction[];
     /**
-     * The dispute created date
+     * Date and time the dispute was created.
      * @readonly
      * @immutable
      */
     _createdDate?: Date | null;
     /**
-     * The dispute updated date
+     * Date and time the dispute was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Revision number, which increments by 1 each time the Dispute is updated.
+     * Revision number, which increments by 1 each time the dispute is updated. To prevent conflicting changes, the current revision must be passed when updating the dispute. Ignored when creating a dispute.
      * @readonly
      */
     revision?: string | null;
@@ -118,91 +127,97 @@ interface Dispute {
 }
 declare enum DisputeStage {
     UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
-    /** Chargeback */
+    /** Formal dispute filed through the card network or issuing bank. */
     CHARGEBACK = "CHARGEBACK",
-    /** Inquiry (Request for Information) */
+    /** Initial inquiry from the cardholder requesting information about the charge. */
     INQUIRY = "INQUIRY"
 }
 /** @enumType */
 type DisputeStageWithLiterals = DisputeStage | 'UNKNOWN_DISPUTE_STAGE' | 'CHARGEBACK' | 'INQUIRY';
 declare enum DisputeReason {
-    /** Unknown reason */
+    /** Unknown dispute reason. */
     UNKNOWN_DISPUTE_REASON = "UNKNOWN_DISPUTE_REASON",
-    /** Fraud card */
+    /** Fraudulent use of a physical card. */
     FRAUD_CARD_PRESENT = "FRAUD_CARD_PRESENT",
-    /** Card absent */
+    /** Fraudulent use without the physical card present. */
     FRAUD_CARD_ABSENT = "FRAUD_CARD_ABSENT",
-    /** DUPLICATE */
+    /** Duplicate charge processing. */
     DUPLICATE_PROCESSING = "DUPLICATE_PROCESSING",
-    /** Service not provided */
+    /** Services or goods were not provided as promised. */
     SERVICES_NOT_PROVIDED = "SERVICES_NOT_PROVIDED",
-    /** Canceled Recurring */
+    /** Recurring payment that should have been canceled. */
     CANCELED_RECURRING = "CANCELED_RECURRING",
-    /** Item not as describe */
+    /** Item received was not as described. */
     NOT_AS_DESCRIBED = "NOT_AS_DESCRIBED",
-    /** Counterfeit */
+    /** Item received was counterfeit. */
     COUNTERFEIT = "COUNTERFEIT",
-    /** Misrepresentation */
+    /** Merchant misrepresented the transaction. */
     MISREPRESENTATION = "MISREPRESENTATION",
-    /** Canceled */
+    /** Transaction was canceled but still charged. */
     CANCELED = "CANCELED",
-    /** Other reason */
+    /** Other dispute reason not covered by specific categories. */
     OTHER = "OTHER"
 }
 /** @enumType */
 type DisputeReasonWithLiterals = DisputeReason | 'UNKNOWN_DISPUTE_REASON' | 'FRAUD_CARD_PRESENT' | 'FRAUD_CARD_ABSENT' | 'DUPLICATE_PROCESSING' | 'SERVICES_NOT_PROVIDED' | 'CANCELED_RECURRING' | 'NOT_AS_DESCRIBED' | 'COUNTERFEIT' | 'MISREPRESENTATION' | 'CANCELED' | 'OTHER';
 declare enum DisputeStatus {
-    /** Unknown status */
+    /** Unknown dispute status. */
     UNKNOWN_DISPUTE_STATUS = "UNKNOWN_DISPUTE_STATUS",
-    /** Waiting for some merchant action */
+    /** Merchant action required to proceed with the dispute. */
     WAITING_MERCHANT = "WAITING_MERCHANT",
-    /** Dispute is under review by PSP or Bank */
+    /** Dispute is being reviewed by the payment service provider or bank. */
     UNDER_REVIEW = "UNDER_REVIEW",
-    /** Waiting for some buyer action */
+    /** Buyer action required to proceed with the dispute. */
     WAITING_BUYER = "WAITING_BUYER",
-    /** Dispute won */
+    /** Dispute was resolved in favor of the merchant. */
     WON = "WON",
-    /** Dispute lost */
+    /** Dispute was resolved in favor of the customer. */
     LOST = "LOST",
-    /** Evidence were submitted and are being processed on provider side */
+    /**
+     * Evidence has been submitted and is being processed by the payment provider.
+     * **Deprecated:** This field will be removed in a future version.
+     */
     PROCESSING_EVIDENCE_SUBMISSION = "PROCESSING_EVIDENCE_SUBMISSION",
-    /** The dispute was accepted and the acceptance is being processed on provider side */
+    /**
+     * Dispute acceptance is being processed by the payment provider.
+     * **Deprecated:** This field will be removed in a future version.
+     */
     PROCESSING_ACCEPTANCE = "PROCESSING_ACCEPTANCE"
 }
 /** @enumType */
 type DisputeStatusWithLiterals = DisputeStatus | 'UNKNOWN_DISPUTE_STATUS' | 'WAITING_MERCHANT' | 'UNDER_REVIEW' | 'WAITING_BUYER' | 'WON' | 'LOST' | 'PROCESSING_EVIDENCE_SUBMISSION' | 'PROCESSING_ACCEPTANCE';
 declare enum SellerProtection {
     UNKNOWN_SELLER_PROTECTION = "UNKNOWN_SELLER_PROTECTION",
-    /** Not Eligible */
+    /** Transaction is not eligible for seller protection. */
     NOT_ELIGIBLE = "NOT_ELIGIBLE",
-    /** Eligible */
+    /** Transaction is eligible for basic seller protection. */
     ELIGIBLE = "ELIGIBLE",
-    /** Extended seller protection */
+    /** Transaction is eligible for extended seller protection coverage. */
     EXTENDED = "EXTENDED"
 }
 /** @enumType */
 type SellerProtectionWithLiterals = SellerProtection | 'UNKNOWN_SELLER_PROTECTION' | 'NOT_ELIGIBLE' | 'ELIGIBLE' | 'EXTENDED';
 declare enum DisputeChannel {
     UNKNOWN_DISPUTE_CHANNEL = "UNKNOWN_DISPUTE_CHANNEL",
-    /** Internal, the dispute is reviewed by PSP */
+    /** Dispute is processed internally by the payment service provider. */
     INTERNAL = "INTERNAL",
-    /** External, the dispute is reviewed by bank (or other financial institution) */
+    /** Dispute is processed externally through the card network or issuing bank. */
     EXTERNAL = "EXTERNAL"
 }
 /** @enumType */
 type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | 'INTERNAL' | 'EXTERNAL';
 interface DisputeAction {
-    /** Dispute Action type */
+    /** Type of action that can be performed. */
     type?: DisputeActionTypeWithLiterals;
-    /** The latest date and time until which the action can be performed */
+    /** Latest date and time by which this action must be completed. */
     dueDate?: Date | null;
 }
 declare enum DisputeActionType {
-    /** Unknown dispute status */
+    /** Unknown dispute action type. */
     UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
-    /** Accept dispute */
+    /** Accept liability for the dispute. */
     ACCEPT = "ACCEPT",
-    /** Defend evidence */
+    /** Defend the dispute by submitting evidence. */
     DEFEND = "DEFEND"
 }
 /** @enumType */
@@ -255,12 +270,13 @@ interface TagList {
      */
     tagIds?: string[];
 }
+/** Triggered when tags are assigned to or unassigned from a dispute. */
 interface TagsModified {
-    /** Updated Dispute. */
+    /** Updated dispute. */
     dispute?: Dispute;
-    /** Tags that were assigned to the Dispute. */
+    /** Tags that were assigned to the dispute. */
     assignedTags?: Tags;
-    /** Tags that were unassigned from the Dispute. */
+    /** Tags that were unassigned from the dispute. */
     unassignedTags?: Tags;
 }
 interface InternalCreateDisputeManuallyRequest {
@@ -496,17 +512,20 @@ declare enum WebhookIdentityType {
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
 interface GetDisputeRequest {
     /**
-     * ID of the Dispute to retrieve.
+     * ID of the dispute to retrieve.
      * @format GUID
      */
     disputeId: string;
 }
 interface GetDisputeResponse {
-    /** The requested Dispute. */
+    /** The requested dispute. */
     dispute?: Dispute;
 }
 interface QueryDisputesRequest {
-    /** WQL expression. */
+    /**
+     * WQL expression for filtering and sorting disputes.
+     * Supported properties: `id`, `createdDate`, `updatedDate`
+     */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -564,9 +583,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryDisputesResponse {
-    /** List of Disputes. */
+    /** List of disputes matching the query criteria. */
     disputes?: Dispute[];
-    /** Paging metadata */
+    /** Paging metadata for cursor-based pagination. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -596,24 +615,24 @@ interface Cursors {
 }
 interface AcceptDisputeRequest {
     /**
-     * Dispute ID
+     * ID of the dispute to accept.
      * @format GUID
      */
     disputeId: string;
 }
 interface AcceptDisputeResponse {
-    /** Dispute */
+    /** Updated dispute after acceptance. */
     dispute?: Dispute;
 }
 interface DefendDisputeRequest {
     /**
-     * Dispute ID
+     * ID of the dispute to defend.
      * @format GUID
      */
     disputeId: string;
 }
 interface DefendDisputeResponse {
-    /** Dispute */
+    /** Updated dispute after initiating defense. */
     dispute?: Dispute;
 }
 interface SubmitDisputeEvidenceRequest {
@@ -704,25 +723,25 @@ interface ChangeDisputeStatusManuallyResponse {
 }
 interface BulkUpdateDisputeTagsRequest {
     /**
-     * List of NileProtoTagsEntities that their tags will update.
+     * List of dispute IDs to update tags for.
      * @minSize 1
      * @maxSize 100
      * @format GUID
      */
     ids: string[];
-    /** List of Tags to assign */
+    /** Tags to assign to the disputes. */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /** Tags to remove from the disputes. */
     unassignTags?: Tags;
 }
 interface BulkUpdateDisputeTagsResponse {
     /**
-     * Results
+     * Results of the bulk tag update operation.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkUpdateDisputeTagsResult[];
-    /** Metadata regarding the bulk update operation */
+    /** Metadata about the bulk operation. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface ItemMetadata {
@@ -747,7 +766,7 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkUpdateDisputeTagsResult {
-    /** Metadata regarding the specific single update operation */
+    /** Metadata for the individual dispute update. */
     itemMetadata?: ItemMetadata;
 }
 interface BulkActionMetadata {
@@ -759,16 +778,16 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface BulkUpdateDisputeTagsByFilterRequest {
-    /** Filter */
+    /** Filter criteria for selecting disputes to update. */
     filter: Record<string, any> | null;
-    /** List of Tags to assign */
+    /** Tags to assign to the filtered disputes. */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /** Tags to remove from the filtered disputes. */
     unassignTags?: Tags;
 }
 interface BulkUpdateDisputeTagsByFilterResponse {
     /**
-     * Pass this ID to Get Async Job
+     * Job ID for tracking the asynchronous bulk update operation.
      * @format GUID
      */
     jobId?: string;
@@ -856,18 +875,19 @@ interface DisputeUpdatedEnvelope {
  */
 declare function onDisputeUpdated(handler: (event: DisputeUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Get Dispute by ID
- * @param disputeId - ID of the Dispute to retrieve.
+ * Retrieves a dispute by ID.
+ * @param disputeId - ID of the dispute to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeId
  * @permissionId PAYMENTS.DISPUTE_READ
- * @returns The requested Dispute.
+ * @returns The requested dispute.
  * @fqn wix.payments.disputes.v1.DisputeService.GetDispute
  */
 declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.privateTags.tagIds`, 4>>;
 /**
- * Retrieves a list of Disputes
+ * Retrieves a list of disputes based on query parameters.
+ * Use this method to filter and sort disputes by various criteria such as status, creation date, or amount.
  * @public
  * @documentationMaturity preview
  * @permissionId PAYMENTS.DISPUTE_READ
@@ -952,8 +972,9 @@ interface DisputesQueryBuilder {
     find: () => Promise<DisputesQueryResult>;
 }
 /**
- * Accept Dispute
- * @param disputeId - Dispute ID
+ * Accepts liability for a dispute, indicating the merchant agrees with the customer's claim.
+ * This action resolves the dispute in favor of the customer.
+ * @param disputeId - ID of the dispute to accept.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeId
@@ -962,9 +983,10 @@ interface DisputesQueryBuilder {
  */
 declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<AcceptDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
 /**
- * Defend Dispute
- * To add (create) dispute evidence see the [Dispute Evidence Document API] (https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/create-dispute-evidence-document)
- * @param disputeId - Dispute ID
+ * Initiates the defense process for a dispute by submitting it for review.
+ * To add evidence documents, use the Dispute [Dispute Evidence Document API] (https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/create-dispute-evidence-document) before calling this method.
+ * Evidence must be submitted separately as this endpoint only triggers the defense process.
+ * @param disputeId - ID of the dispute to defend.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeId
@@ -973,9 +995,9 @@ declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<Acce
  */
 declare function defendDispute(disputeId: string): Promise<NonNullablePaths<DefendDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
 /**
- * Synchronously update tags on multiple Disputes, by list of Disputes ids
- * A tag that appears both in the list of assign and unassign tags, will be assigned
- * @param ids - List of NileProtoTagsEntities that their tags will update.
+ * Updates tags on multiple disputes simultaneously using a list of dispute IDs.
+ * If a tag appears in both assign and unassign lists, it will be assigned.
+ * @param ids - List of dispute IDs to update tags for.
  * @public
  * @documentationMaturity preview
  * @requiredField ids
@@ -986,16 +1008,15 @@ declare function bulkUpdateDisputeTags(ids: string[], options?: BulkUpdateDisput
     __applicationErrorsType?: BulkUpdateDisputeTagsApplicationErrors;
 }>;
 interface BulkUpdateDisputeTagsOptions {
-    /** List of Tags to assign */
+    /** Tags to assign to the disputes. */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /** Tags to remove from the disputes. */
     unassignTags?: Tags;
 }
 /**
- * Asynchronously update tags on multiple Disputes, by provided filter
- * An empty filter will update all Disputes
- * A tag that appears both in the list of assign and unassign tags, will be assigned
- * @param filter - Filter
+ * Asynchronously updates tags on multiple disputes based on filter criteria.
+ * Returns a job ID that can be used to track the operation status. If a tag appears in both assign and unassign lists, it will be assigned.
+ * @param filter - Filter criteria for selecting disputes to update.
  * @public
  * @documentationMaturity preview
  * @requiredField filter
@@ -1006,9 +1027,9 @@ declare function bulkUpdateDisputeTagsByFilter(filter: Record<string, any>, opti
     __applicationErrorsType?: BulkUpdateDisputeTagsByFilterApplicationErrors;
 }>;
 interface BulkUpdateDisputeTagsByFilterOptions {
-    /** List of Tags to assign */
+    /** Tags to assign to the filtered disputes. */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /** Tags to remove from the filtered disputes. */
     unassignTags?: Tags;
 }
 

package/build/internal/cjs/index.typings.js

@@ -59,6 +59,9 @@ function getDispute(payload) {
       method: "GET",
       methodFqn: "wix.payments.disputes.v1.DisputeService.GetDispute",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
         protoPath: "/v1/disputes/{disputeId}",
         data: payload,
@@ -90,6 +93,9 @@ function queryDisputes(payload) {
       method: "GET",
       methodFqn: "wix.payments.disputes.v1.DisputeService.QueryDisputes",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
         protoPath: "/v1/disputes/query",
         data: payload,
@@ -132,6 +138,9 @@ function acceptDispute(payload) {
       method: "POST",
       methodFqn: "wix.payments.disputes.v1.DisputeService.AcceptDispute",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
         protoPath: "/v1/disputes/{disputeId}/accept",
         data: payload,
@@ -163,6 +172,9 @@ function defendDispute(payload) {
       method: "POST",
       methodFqn: "wix.payments.disputes.v1.DisputeService.DefendDispute",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
         protoPath: "/v1/disputes/{disputeId}/defend",
         data: payload,
@@ -194,6 +206,9 @@ function bulkUpdateDisputeTags(payload) {
       method: "POST",
       methodFqn: "wix.payments.disputes.v1.DisputeService.BulkUpdateDisputeTags",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
         protoPath: "/v1/bulk/disputes/update-tags",
         data: payload,
@@ -212,6 +227,9 @@ function bulkUpdateDisputeTagsByFilter(payload) {
       method: "POST",
       methodFqn: "wix.payments.disputes.v1.DisputeService.BulkUpdateDisputeTagsByFilter",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
         protoPath: "/v1/bulk/disputes/update-tags-by-filter",
         data: payload,