@wix/auto_sdk_payments_disputes 1.0.41 → 1.0.43

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

@@ -1,15 +1,9 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
-/**
- * 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.
- */
+/** A dispute is a customer-initiated challenge of a payment through their payment service provider (PSP) or bank. */
 interface Dispute {
     /**
-     * Dispute ID..
+     * Dispute ID.
      * @format GUID
      * @immutable
      */
@@ -37,7 +31,7 @@ interface Dispute {
      */
     reason?: DisputeReasonWithLiterals;
     /**
-     * Three-letter currency code in @ISO-4217 alphabetic format. Matches the currency of the disputed charge.
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. Matches the currency of the disputed charge.
      * @immutable
      * @format CURRENCY
      */
@@ -49,24 +43,26 @@ interface Dispute {
      */
     amount?: string | null;
     /**
-     * Current status of the dispute, indicating what action is required and who needs to take it.
+     * Current status of the dispute. This indicates what action is required and who needs to take it.
      * @readonly
      */
     status?: DisputeStatusWithLiterals;
     /**
      * 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.
+     *
+     * Seller protection is set by the payment provider. For example, PayPal offers a [seller protection program](https://www.paypal.com/ua/legalhub/paypal/seller-protection).
      * @readonly
      */
     sellerProtection?: SellerProtectionWithLiterals;
     /**
      * Channel through which the dispute is being processed.
-     * Internal disputes are handled by the payment processor, while external disputes go through the card network or issuing bank.
      * @readonly
      */
     channel?: DisputeChannelWithLiterals;
     /**
      * The latest date and time until which the dispute can remain in its current status.
+     *
+     * If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is `WAITING_MERCHANT`, and the due date passes, the dispute will be `LOST` and a refund will be processed automatically.
      * @readonly
      */
     dueDate?: Date | null;
@@ -87,17 +83,17 @@ interface Dispute {
      */
     autoDefended?: boolean | null;
     /**
-     * Date and time when the dispute was defended.
+     * Date and time at which the dispute was defended.
      * @readonly
      */
     defendedDate?: Date | null;
     /**
-     * Date and time when the dispute was accepted.
+     * Date and time at which the dispute was accepted.
      * @readonly
      */
     acceptedDate?: Date | null;
     /**
-     * Actions that can be performed on the dispute.
+     * List of 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
@@ -120,16 +116,21 @@ interface Dispute {
      * @readonly
      */
     revision?: string | null;
-    /** Data Extensions */
+    /**
+     * Custom field data for the dispute 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;
-    /** Tags */
+    /** Tags assigned to the dispute for organization and filtering purposes. */
     tags?: Tags;
 }
 declare enum DisputeStage {
+    /** Unknown dispute stage. */
     UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
     /** Formal dispute filed through the card network or issuing bank. */
     CHARGEBACK = "CHARGEBACK",
-    /** Initial inquiry from the cardholder requesting information about the charge. */
+    /** Initial inquiry from the customer requesting information about the charge. */
     INQUIRY = "INQUIRY"
 }
 /** @enumType */
@@ -167,16 +168,17 @@ declare enum DisputeStatus {
     WAITING_MERCHANT = "WAITING_MERCHANT",
     /** Dispute is being reviewed by the payment service provider or bank. */
     UNDER_REVIEW = "UNDER_REVIEW",
-    /** Buyer action required to proceed with the dispute. */
+    /** Customer action required to proceed with the dispute. */
     WAITING_BUYER = "WAITING_BUYER",
-    /** Dispute was resolved in favor of the merchant. */
+    /** Dispute resolved in favor of the merchant. */
     WON = "WON",
-    /** Dispute was resolved in favor of the customer. */
+    /** Dispute resolved in favor of the customer. When a dispute is lost, the refund is processed automatically. */
     LOST = "LOST"
 }
 /** @enumType */
 type DisputeStatusWithLiterals = DisputeStatus | 'UNKNOWN_DISPUTE_STATUS' | 'WAITING_MERCHANT' | 'UNDER_REVIEW' | 'WAITING_BUYER' | 'WON' | 'LOST';
 declare enum SellerProtection {
+    /** Unknown seller protection. */
     UNKNOWN_SELLER_PROTECTION = "UNKNOWN_SELLER_PROTECTION",
     /** Transaction is not eligible for seller protection. */
     NOT_ELIGIBLE = "NOT_ELIGIBLE",
@@ -188,10 +190,11 @@ declare enum SellerProtection {
 /** @enumType */
 type SellerProtectionWithLiterals = SellerProtection | 'UNKNOWN_SELLER_PROTECTION' | 'NOT_ELIGIBLE' | 'ELIGIBLE' | 'EXTENDED';
 declare enum DisputeChannel {
+    /** Unknown dispute channel. */
     UNKNOWN_DISPUTE_CHANNEL = "UNKNOWN_DISPUTE_CHANNEL",
-    /** Dispute is processed internally by the payment service provider. */
+    /** Dispute is processed by the payment service provider. */
     INTERNAL = "INTERNAL",
-    /** Dispute is processed externally through the card network or issuing bank. */
+    /** Dispute is processed through the card network or issuing bank. */
     EXTERNAL = "EXTERNAL"
 }
 /** @enumType */
@@ -199,15 +202,15 @@ type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | '
 interface DisputeAction {
     /** Type of action that can be performed. */
     type?: DisputeActionTypeWithLiterals;
-    /** Latest date and time by which this action must be completed. */
+    /** Latest date and time by which this action must be performed. */
     dueDate?: Date | null;
 }
 declare enum DisputeActionType {
     /** Unknown dispute action type. */
     UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
-    /** Accept liability for the dispute. */
+    /** Dispute can be accepted. */
     ACCEPT = "ACCEPT",
-    /** Defend the dispute by submitting evidence. */
+    /** Dispute can be defended. */
     DEFEND = "DEFEND"
 }
 /** @enumType */
@@ -508,14 +511,11 @@ interface GetDisputeRequest {
     disputeId: string;
 }
 interface GetDisputeResponse {
-    /** The requested dispute. */
+    /** The retrieved dispute. */
     dispute?: Dispute;
 }
 interface QueryDisputesRequest {
-    /**
-     * WQL expression for filtering and sorting disputes.
-     * Supported properties: `id`, `createdDate`, `updatedDate`
-     */
+    /** WQL expression for filtering and sorting disputes. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -573,7 +573,7 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryDisputesResponse {
-    /** List of disputes matching the query criteria. */
+    /** List of retrieved disputes. */
     disputes?: Dispute[];
     /** Paging metadata for cursor-based pagination. */
     pagingMetadata?: CursorPagingMetadata;
@@ -622,7 +622,7 @@ interface DefendDisputeRequest {
     disputeId: string;
 }
 interface DefendDisputeResponse {
-    /** Updated dispute after initiating defense. */
+    /** Updated dispute after submitting evidence. */
     dispute?: Dispute;
 }
 interface BulkUpdateDisputeTagsRequest {
@@ -682,7 +682,11 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface BulkUpdateDisputeTagsByFilterRequest {
-    /** Filter criteria for selecting disputes to update. */
+    /**
+     * Filter that determines which disputes to update tags for.
+     *
+     * An empty filter updates all disputes.
+     */
     filter: Record<string, any> | null;
     /** Tags to assign to the filtered disputes. */
     assignTags?: Tags;
@@ -757,7 +761,7 @@ interface DisputeCreatedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Fired when a new Dispute is created.
+ * Triggered when a dispute is created.
  * @permissionId PAYMENTS.DISPUTE_READ
  * @webhook
  * @eventType wix.payments.disputes.v1.dispute_created
@@ -770,7 +774,7 @@ interface DisputeUpdatedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Fired when a Dispute is updated.
+ * Triggered when a dispute is updated.
  * @permissionId PAYMENTS.DISPUTE_READ
  * @webhook
  * @eventType wix.payments.disputes.v1.dispute_updated
@@ -779,20 +783,29 @@ interface DisputeUpdatedEnvelope {
  */
 declare function onDisputeUpdated(handler: (event: DisputeUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Retrieves a dispute by ID.
+ * Retrieves a dispute.
  * @param disputeId - ID of the dispute to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeId
  * @permissionId PAYMENTS.DISPUTE_READ
  * @applicableIdentity APP
- * @returns The requested dispute.
+ * @returns The retrieved 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 based on query parameters.
- * Use this method to filter and sort disputes by various criteria such as status, creation date, or amount.
+ * Creates a query to retrieve a list of disputes.
+ *
+ * The Query Disputes method builds a query to retrieve a list of disputes and returns a `DisputesQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
+ *
+ * You can refine the query by chaining `DisputesQueryBuilder` methods onto the query. `DisputesQueryBuilder` methods enable you to filter, sort, and control the results that Query Disputes returns.
+ *
+ * Query Disputes has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `items` property in `DisputesQueryResult`.
  * @public
  * @documentationMaturity preview
  * @permissionId PAYMENTS.DISPUTE_READ
@@ -877,9 +890,16 @@ interface DisputesQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<DisputesQueryResult>;
 }
+/**
+ * @hidden
+ * @fqn wix.payments.disputes.v1.DisputeService.QueryDisputes
+ * @requiredField query
+ */
+declare function typedQueryDisputes(query: CursorQuery): Promise<NonNullablePaths<QueryDisputesResponse, `disputes` | `disputes.${number}._id` | `disputes.${number}.chargeId` | `disputes.${number}.providerDisputeId` | `disputes.${number}.stage` | `disputes.${number}.reason` | `disputes.${number}.status` | `disputes.${number}.sellerProtection` | `disputes.${number}.channel`, 4>>;
 /**
  * Accepts liability for a dispute, indicating the merchant agrees with the customer's claim.
- * This action resolves the dispute in favor of the customer.
+ *
+ * When a dispute is accepted, the refund is processed automatically.
  * @param disputeId - ID of the dispute to accept.
  * @public
  * @documentationMaturity preview
@@ -890,9 +910,9 @@ 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>>;
 /**
- * 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.
+ * Defends a dispute by submitting evidence to the payment service provider or bank handling the dispute.
+ *
+ * To upload evidence documents, use the [Dispute Evidence Documents API](https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/create-dispute-evidence-document). This method submits all the evidence documents uploaded for the specified dispute.
  * @param disputeId - ID of the dispute to defend.
  * @public
  * @documentationMaturity preview
@@ -910,6 +930,7 @@ declare function defendDispute(disputeId: string): Promise<NonNullablePaths<Defe
  * @documentationMaturity preview
  * @requiredField ids
  * @permissionId PAYMENTS.DISPUTE_UPDATE_TAGS
+ * @applicableIdentity APP
  * @fqn wix.payments.disputes.v1.DisputeService.BulkUpdateDisputeTags
  */
 declare function bulkUpdateDisputeTags(ids: string[], options?: BulkUpdateDisputeTagsOptions): Promise<NonNullablePaths<BulkUpdateDisputeTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
@@ -924,11 +945,14 @@ interface BulkUpdateDisputeTagsOptions {
 /**
  * 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.
+ * @param filter - Filter that determines which disputes to update tags for.
+ *
+ * An empty filter updates all disputes.
  * @public
  * @documentationMaturity preview
  * @requiredField filter
  * @permissionId PAYMENTS.DISPUTE_UPDATE_TAGS
+ * @applicableIdentity APP
  * @fqn wix.payments.disputes.v1.DisputeService.BulkUpdateDisputeTagsByFilter
  */
 declare function bulkUpdateDisputeTagsByFilter(filter: Record<string, any>, options?: BulkUpdateDisputeTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeTagsByFilterResponse, `jobId`, 2> & {
@@ -941,4 +965,4 @@ interface BulkUpdateDisputeTagsByFilterOptions {
     unassignTags?: Tags;
 }
 
-export { type AcceptDisputeManuallyRequest, type AcceptDisputeManuallyResponse, type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DefendDisputeManuallyRequest, type DefendDisputeManuallyResponse, type DefendDisputeRequest, type DefendDisputeResponse, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, type DisputeCreatedEnvelope, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputeUpdatedEnvelope, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetDisputeRequest, type GetDisputeResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type TagList, type Tags, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, defendDispute, getDispute, onDisputeCreated, onDisputeUpdated, queryDisputes };
+export { type AcceptDisputeManuallyRequest, type AcceptDisputeManuallyResponse, type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DefendDisputeManuallyRequest, type DefendDisputeManuallyResponse, type DefendDisputeRequest, type DefendDisputeResponse, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, type DisputeCreatedEnvelope, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputeUpdatedEnvelope, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetDisputeRequest, type GetDisputeResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type TagList, type Tags, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, defendDispute, getDispute, onDisputeCreated, onDisputeUpdated, queryDisputes, typedQueryDisputes };

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

@@ -33,7 +33,8 @@ __export(index_typings_exports, {
   bulkUpdateDisputeTagsByFilter: () => bulkUpdateDisputeTagsByFilter2,
   defendDispute: () => defendDispute2,
   getDispute: () => getDispute2,
-  queryDisputes: () => queryDisputes2
+  queryDisputes: () => queryDisputes2,
+  typedQueryDisputes: () => typedQueryDisputes
 });
 module.exports = __toCommonJS(index_typings_exports);
 
@@ -404,6 +405,29 @@ function queryDisputes2() {
     transformationPaths: {}
   });
 }
+async function typedQueryDisputes(query) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
+  const reqOpts = queryDisputes(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function acceptDispute2(disputeId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -533,6 +557,7 @@ async function bulkUpdateDisputeTagsByFilter2(filter, options) {
   bulkUpdateDisputeTagsByFilter,
   defendDispute,
   getDispute,
-  queryDisputes
+  queryDisputes,
+  typedQueryDisputes
 });
 //# sourceMappingURL=index.typings.js.map