@wix/auto_sdk_payments_dispute-evidence-documents 1.0.36 → 1.0.38

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

@@ -40,20 +40,17 @@ interface DisputeEvidenceDocument {
     /**
      * File details for the uploaded evidence document.
      *
-     * Returned only when a file has been successfully uploaded and attached to the evidence document.
+     * If a file hasn't been uploaded yet, this field is `null`.
      * @readonly
      */
     file?: DocumentFile;
     /**
-     * Custom field data for the dispute evidence document.
+     * Custom field data for the dispute evidence document object.
      *
-     * Extended fields must be configured in the app dashboard before they can be accessed with API calls.
+     * [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 assigned to the dispute evidence document for organization and filtering purposes.
-     * Tags assigned to the dispute evidence document for organization and filtering purposes.
-     */
+    /** Tags assigned to the dispute evidence document for organization and filtering purposes. */
     tags?: Tags;
 }
 /** File details for an uploaded evidence document. */
@@ -70,7 +67,7 @@ interface DocumentFile {
      */
     size?: string | null;
     /**
-     * Hexadecimal checksum of the uploaded file for integrity verification.
+     * Hexadecimal checksum of the uploaded file.
      * @minLength 32
      * @maxLength 256
      * @readonly
@@ -138,11 +135,7 @@ interface TagsModified {
     unassignedTags?: Tags;
 }
 interface CreateDisputeEvidenceDocumentRequest {
-    /**
-     * Dispute evidence document to create.
-     *
-     * The `disputeId` field is required. Do not provide an `id` as it will be generated automatically.
-     */
+    /** Dispute evidence document to create. */
     disputeEvidenceDocument: DisputeEvidenceDocument;
 }
 interface CreateDisputeEvidenceDocumentResponse {
@@ -152,14 +145,13 @@ interface CreateDisputeEvidenceDocumentResponse {
      * URL for uploading the evidence file.
      *
      * Use this URL to upload the file that will serve as evidence for the dispute.
-     * File attachment is automatic once the upload completes successfully.
+     * Learn how to [upload an evidence document](https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/upload-an-evidence-document).
      * @format WEB_URL
      */
     uploadUrl?: string | null;
 }
 interface GetDisputeEvidenceDocumentRequest {
     /**
-     * ID of the dispute evidence document to retrieve.
      * ID of the dispute evidence document to retrieve.
      * @format GUID
      */
@@ -174,7 +166,6 @@ interface GetDisputeEvidenceDocumentResponse {
 }
 interface DeleteDisputeEvidenceDocumentRequest {
     /**
-     * ID of the dispute evidence document to delete.
      * ID of the dispute evidence document to delete.
      * @format GUID
      */
@@ -183,14 +174,7 @@ interface DeleteDisputeEvidenceDocumentRequest {
 interface DeleteDisputeEvidenceDocumentResponse {
 }
 interface QueryDisputeEvidenceDocumentsRequest {
-    /**
-     * Query options for filtering, sorting, and paging dispute evidence documents.
-     *
-     * Supported properties: `disputeId`
-     * Query options for filtering, sorting, and paging dispute evidence documents.
-     *
-     * Supported properties: `disputeId`
-     */
+    /** Query options for filtering, sorting, and paging dispute evidence documents. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -248,15 +232,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryDisputeEvidenceDocumentsResponse {
-    /**
-     * List of dispute evidence documents matching the query criteria.
-     * List of dispute evidence documents matching the query criteria.
-     */
+    /** Retrieved dispute evidence documents. */
     disputeEvidenceDocuments?: DisputeEvidenceDocument[];
-    /**
-     * Paging metadata for the query results.
-     * Paging metadata for the query results.
-     */
+    /** Paging metadata for the query results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -286,40 +264,25 @@ interface Cursors {
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
     /**
-     * IDs of the dispute evidence documents to update.
-     * IDs of the dispute evidence documents to update.
-     *
-     * Limited to 100 documents per request.
+     * List of dispute evidence document IDs to update tags for.
      * @minSize 1
      * @maxSize 100
      * @format GUID
      */
     ids: string[];
-    /**
-     * Tags to assign to the dispute evidence documents.
-     * Tags to assign to the dispute evidence documents.
-     * Tags to assign to the filtered dispute evidence documents.
-     */
+    /** Tags to assign to the dispute evidence documents. */
     assignTags?: Tags;
-    /**
-     * Tags to remove from the dispute evidence documents.
-     * Tags to remove from the dispute evidence documents.
-     * Tags to remove from the filtered dispute evidence documents.
-     */
+    /** Tags to remove from the dispute evidence documents. */
     unassignTags?: Tags;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
     /**
-     * Results of the bulk tag update operation for each document.
      * Results of the bulk tag update operation for each document.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkUpdateDisputeEvidenceDocumentTagsResult[];
-    /**
-     * Metadata about the bulk tag update operation.
-     * Metadata about the bulk tag update operation.
-     */
+    /** Metadata about the bulk tag update operation. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface ItemMetadata {
@@ -344,10 +307,7 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsResult {
-    /**
-     * Metadata about the tag update result for this specific document.
-     * Metadata about the tag update result for this specific document.
-     */
+    /** Metadata about the tag update result for this specific document. */
     itemMetadata?: ItemMetadata;
 }
 interface BulkActionMetadata {
@@ -360,28 +320,18 @@ interface BulkActionMetadata {
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
     /**
-     * Filter criteria for selecting dispute evidence documents to update.
-     * Filter criteria for selecting dispute evidence documents to update.
+     * Filter that determines which disputes to update tags for.
      *
-     * An empty filter will update all dispute evidence documents.
+     * An empty filter updates all dispute evidence documents.
      */
     filter: Record<string, any> | null;
-    /**
-     * Tags to assign to the filtered dispute evidence documents.
-     * Tags to assign to the dispute evidence documents.
-     * Tags to assign to the filtered dispute evidence documents.
-     */
+    /** Tags to assign to the dispute evidence documents. */
     assignTags?: Tags;
-    /**
-     * Tags to remove from the filtered dispute evidence documents.
-     * Tags to remove from the dispute evidence documents.
-     * Tags to remove from the filtered dispute evidence documents.
-     */
+    /** Tags to remove from the dispute evidence documents. */
     unassignTags?: Tags;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
     /**
-     * Job ID for tracking the progress of the bulk tag update operation.
      * Job ID for tracking the progress of the bulk tag update operation.
      * @format GUID
      */
@@ -691,7 +641,13 @@ interface DisputeEvidenceDocumentCreatedEnvelope {
     entity: DisputeEvidenceDocument;
     metadata: EventMetadata;
 }
-/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+/** @permissionScope Manage Payments - All Permissions
+ * @permissionScopeId SCOPE.DC-PAYMENTS.MANAGE-PAYMENTS
+ * @permissionScope Manage Disputes
+ * @permissionScopeId SCOPE.DC-PAYMENTS.MANAGE-DISPUTES
+ * @permissionScope Read Disputes
+ * @permissionScopeId SCOPE.DC-PAYMENTS.READ-DISPUTES
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
  * @webhook
  * @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_created
  * @slug created
@@ -702,7 +658,13 @@ interface DisputeEvidenceDocumentDeletedEnvelope {
     entity: DisputeEvidenceDocument;
     metadata: EventMetadata;
 }
-/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+/** @permissionScope Manage Payments - All Permissions
+ * @permissionScopeId SCOPE.DC-PAYMENTS.MANAGE-PAYMENTS
+ * @permissionScope Manage Disputes
+ * @permissionScopeId SCOPE.DC-PAYMENTS.MANAGE-DISPUTES
+ * @permissionScope Read Disputes
+ * @permissionScopeId SCOPE.DC-PAYMENTS.READ-DISPUTES
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
  * @webhook
  * @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_deleted
  * @slug deleted
@@ -713,7 +675,13 @@ interface DisputeEvidenceDocumentUpdatedEnvelope {
     entity: DisputeEvidenceDocument;
     metadata: EventMetadata;
 }
-/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+/** @permissionScope Manage Payments - All Permissions
+ * @permissionScopeId SCOPE.DC-PAYMENTS.MANAGE-PAYMENTS
+ * @permissionScope Manage Disputes
+ * @permissionScopeId SCOPE.DC-PAYMENTS.MANAGE-DISPUTES
+ * @permissionScope Read Disputes
+ * @permissionScopeId SCOPE.DC-PAYMENTS.READ-DISPUTES
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
  * @webhook
  * @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_updated
  * @slug updated
@@ -723,28 +691,26 @@ declare function onDisputeEvidenceDocumentUpdated(handler: (event: DisputeEviden
 /**
  * Creates a dispute evidence document for a specific dispute.
  *
- * Returns the created document along with an upload URL for attaching the evidence file.
- * Use the provided upload URL to upload your evidence file directly.
+ * Use the upload URL in the response to upload your evidence file. Once uploaded, you can submit it by calling [Defend Dispute](https://dev.wix.com/docs/api-reference/business-management/payments/disputes/disputes/defend-dispute). Learn how to [upload an evidence document](https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/upload-an-evidence-document).
  * @param disputeEvidenceDocument - Dispute evidence document to create.
- *
- * The `disputeId` field is required. Do not provide an `id` as it will be generated automatically.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeEvidenceDocument
  * @requiredField disputeEvidenceDocument.disputeId
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_CREATE
+ * @applicableIdentity APP
  * @returns Created dispute evidence document.
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.CreateDisputeEvidenceDocument
  */
 declare function createDisputeEvidenceDocument(disputeEvidenceDocument: NonNullablePaths<DisputeEvidenceDocument, `disputeId`, 2>): Promise<NonNullablePaths<DisputeEvidenceDocument, `disputeId` | `tags.privateTags.tagIds`, 4>>;
 /**
- * Retrieves a dispute evidence document by ID.
+ * Retrieves a dispute evidence document.
  * @param disputeEvidenceDocumentId - ID of the dispute evidence document to retrieve.
- * ID of the dispute evidence document to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeEvidenceDocumentId
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @applicableIdentity APP
  * @returns Retrieved dispute evidence document.
  * Retrieved dispute evidence document.
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GetDisputeEvidenceDocument
@@ -753,25 +719,34 @@ declare function getDisputeEvidenceDocument(disputeEvidenceDocumentId: string):
 /**
  * Deletes a dispute evidence document.
  *
- * Documents cannot be deleted once they have been submitted for dispute resolution.
+ * > **Note:** After you've submitted an evidence document by calling [Defend Dispute](https://dev.wix.com/docs/api-reference/business-management/payments/disputes/disputes/defend-dispute), you can't delete it.
  * @param disputeEvidenceDocumentId - ID of the dispute evidence document to delete.
- * ID of the dispute evidence document to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeEvidenceDocumentId
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_DELETE
+ * @applicableIdentity APP
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.DeleteDisputeEvidenceDocument
  */
 declare function deleteDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<void & {
     __applicationErrorsType?: DeleteDisputeEvidenceDocumentApplicationErrors;
 }>;
 /**
- * Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of dispute evidence documents.
+ *
+ * The Query Dispute Evidence Documents method builds a query to retrieve a list of dispute evidence documents and returns a `DisputeEvidenceDocumentsQueryBuilder` 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 `DisputeEvidenceDocumentsQueryBuilder` methods onto the query. `DisputeEvidenceDocumentsQueryBuilder` methods enable you to filter, sort, and control the results that Query Dispute Evidence Documents returns.
+ *
+ * Query Dispute Evidence Documents has a default paging limit of 50, which you can override.
  *
- * Use the `disputeId` filter to retrieve all evidence documents for a specific dispute.
+ *  For a full description of the item object, see the object returned for the `items` property in `DisputeEvidenceDocumentsQueryResult`.
  * @public
  * @documentationMaturity preview
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @applicableIdentity APP
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.QueryDisputeEvidenceDocuments
  */
 declare function queryDisputeEvidenceDocuments(): DisputeEvidenceDocumentsQueryBuilder;
@@ -857,64 +832,43 @@ interface DisputeEvidenceDocumentsQueryBuilder {
  *
  * If a tag appears in both assign and unassign lists, it will be assigned.
  * Limited to 100 documents per request.
- * @param ids - IDs of the dispute evidence documents to update.
- * IDs of the dispute evidence documents to update.
- *
- * Limited to 100 documents per request.
+ * @param ids - List of dispute evidence document IDs to update tags for.
  * @public
  * @documentationMaturity preview
  * @requiredField ids
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_UPDATE_TAGS
+ * @applicableIdentity APP
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.BulkUpdateDisputeEvidenceDocumentTags
  */
 declare function bulkUpdateDisputeEvidenceDocumentTags(ids: string[], options?: BulkUpdateDisputeEvidenceDocumentTagsOptions): Promise<NonNullablePaths<BulkUpdateDisputeEvidenceDocumentTagsResponse, `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> & {
     __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors;
 }>;
 interface BulkUpdateDisputeEvidenceDocumentTagsOptions {
-    /**
-     * Tags to assign to the dispute evidence documents.
-     * Tags to assign to the dispute evidence documents.
-     * Tags to assign to the filtered dispute evidence documents.
-     */
+    /** Tags to assign to the dispute evidence documents. */
     assignTags?: Tags;
-    /**
-     * Tags to remove from the dispute evidence documents.
-     * Tags to remove from the dispute evidence documents.
-     * Tags to remove from the filtered dispute evidence documents.
-     */
+    /** Tags to remove from the dispute evidence documents. */
     unassignTags?: Tags;
 }
 /**
- * Updates tags on multiple dispute evidence documents matching the provided filter.
+ * Asynchronously updates tags on multiple dispute evidence documents 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 that determines which disputes to update tags for.
  *
- * This operation runs asynchronously and returns a job ID for tracking progress.
- * An empty filter will update all dispute evidence documents.
- * If a tag appears in both assign and unassign lists, it will be assigned.
- * @param filter - Filter criteria for selecting dispute evidence documents to update.
- * Filter criteria for selecting dispute evidence documents to update.
- *
- * An empty filter will update all dispute evidence documents.
+ * An empty filter updates all dispute evidence documents.
  * @public
  * @documentationMaturity preview
  * @requiredField filter
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_UPDATE_TAGS
+ * @applicableIdentity APP
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.BulkUpdateDisputeEvidenceDocumentTagsByFilter
  */
 declare function bulkUpdateDisputeEvidenceDocumentTagsByFilter(filter: Record<string, any>, options?: BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, `jobId`, 2> & {
     __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors;
 }>;
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
-    /**
-     * Tags to assign to the filtered dispute evidence documents.
-     * Tags to assign to the dispute evidence documents.
-     * Tags to assign to the filtered dispute evidence documents.
-     */
+    /** Tags to assign to the dispute evidence documents. */
     assignTags?: Tags;
-    /**
-     * Tags to remove from the filtered dispute evidence documents.
-     * Tags to remove from the dispute evidence documents.
-     * Tags to remove from the filtered dispute evidence documents.
-     */
+    /** Tags to remove from the dispute evidence documents. */
     unassignTags?: Tags;
 }