@wix/auto_sdk_payments_dispute-evidence-documents 1.0.30 → 1.0.32

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

@@ -1,69 +1,81 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
-/** Dispute Evidence Document */
+/**
+ * A dispute evidence document represents a file-based piece of evidence submitted to support a payment dispute resolution case.
+ *
+ * Evidence documents are created for specific disputes and follow a structured workflow:
+ * create the document, upload the file, and submit for dispute resolution.
+ * Once submitted, documents become immutable and cannot be deleted or modified.
+ */
 interface DisputeEvidenceDocument {
     /**
-     * DisputeEvidenceDocument ID.
+     * Dispute evidence document ID.
      * @format GUID
      * @readonly
      * @immutable
      */
-    _id?: string;
+    _id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the dispute evidence document is updated.
-     * To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document.
+     * Revision number, which increments by 1 each time the dispute evidence document is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document. Ignored when creating a dispute evidence document.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the DisputeEvidenceDocument was created.
+     * Date and time the dispute evidence document was created.
      * @readonly
      * @immutable
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the DisputeEvidenceDocument was last updated.
+     * Date and time the dispute evidence document was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Dispute ID
+     * ID of the dispute this evidence document supports.
      * @format GUID
      * @immutable
      */
     disputeId?: string;
     /**
-     * Document evidence file if it was uploaded and attached
+     * File details for the uploaded evidence document.
+     *
+     * Returned only when a file has been successfully uploaded and attached to the evidence document.
      * @readonly
      */
     file?: DocumentFile;
     /**
      * Custom field data for the dispute evidence document.
+     *
      * Extended fields must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
-    /** Tags */
+    /**
+     * 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. */
 interface DocumentFile {
     /**
-     * Document filename.
+     * Name of the uploaded evidence file.
      * @readonly
      * @maxLength 255
      */
     filename?: string | null;
     /**
-     * Document size in bytes.
+     * Size of the uploaded evidence file in bytes.
      * @readonly
      */
-    sizeInBytes?: string | null;
+    size?: string | null;
     /**
-     * Hexadecimal representation of the document's MD5 digest.
+     * Hexadecimal checksum of the uploaded file for integrity verification.
      * @minLength 32
-     * @maxLength 32
+     * @maxLength 256
      * @readonly
      */
-    hexMd5Digest?: string | null;
+    checksum?: string | null;
 }
 interface ExtendedFields {
     /**
@@ -113,41 +125,57 @@ interface TagList {
      */
     tagIds?: string[];
 }
+/**
+ * Triggers when tags are modified on a dispute evidence document.
+ * TagsModified message represents a modification of tags associated with a dispute evidence document.
+ */
 interface TagsModified {
-    /** Updated DisputeEvidenceDocument. */
+    /** Dispute evidence document with the updated tags. */
     disputeEvidenceDocument?: DisputeEvidenceDocument;
-    /** Tags that were assigned to the DisputeEvidenceDocument. */
+    /** Tags that were newly assigned to the dispute evidence document. */
     assignedTags?: Tags;
-    /** Tags that were unassigned from the DisputeEvidenceDocument. */
+    /** Tags that were unassigned from the dispute evidence document. */
     unassignedTags?: Tags;
 }
 interface CreateDisputeEvidenceDocumentRequest {
-    /** DisputeEvidenceDocument to be created. */
+    /**
+     * Dispute evidence document to create.
+     *
+     * The `disputeId` field is required. Do not provide an `id` as it will be generated automatically.
+     */
     disputeEvidenceDocument: DisputeEvidenceDocument;
 }
 interface CreateDisputeEvidenceDocumentResponse {
-    /** The created DisputeEvidenceDocument. */
+    /** Created dispute evidence document. */
     disputeEvidenceDocument?: DisputeEvidenceDocument;
     /**
-     * Upload URL to upload file evidence
+     * 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.
      * @format WEB_URL
      */
     uploadUrl?: string | null;
 }
 interface GetDisputeEvidenceDocumentRequest {
     /**
-     * ID of the DisputeEvidenceDocument to retrieve.
+     * ID of the dispute evidence document to retrieve.
+     * ID of the dispute evidence document to retrieve.
      * @format GUID
      */
     disputeEvidenceDocumentId: string;
 }
 interface GetDisputeEvidenceDocumentResponse {
-    /** The requested DisputeEvidenceDocument. */
+    /**
+     * Retrieved dispute evidence document.
+     * Retrieved dispute evidence document.
+     */
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 interface DeleteDisputeEvidenceDocumentRequest {
     /**
-     * Id of the DisputeEvidenceDocument to delete.
+     * ID of the dispute evidence document to delete.
+     * ID of the dispute evidence document to delete.
      * @format GUID
      */
     disputeEvidenceDocumentId: string;
@@ -155,7 +183,14 @@ interface DeleteDisputeEvidenceDocumentRequest {
 interface DeleteDisputeEvidenceDocumentResponse {
 }
 interface QueryDisputeEvidenceDocumentsRequest {
-    /** WQL expression. */
+    /**
+     * 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?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -213,9 +248,15 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryDisputeEvidenceDocumentsResponse {
-    /** List of DisputeEvidenceDocuments. */
+    /**
+     * List of dispute evidence documents matching the query criteria.
+     * List of dispute evidence documents matching the query criteria.
+     */
     disputeEvidenceDocuments?: DisputeEvidenceDocument[];
-    /** Paging metadata */
+    /**
+     * Paging metadata for the query results.
+     * Paging metadata for the query results.
+     */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -245,25 +286,40 @@ interface Cursors {
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
     /**
-     * List of NileProtoTagsEntities that their tags will update.
+     * IDs of the dispute evidence documents to update.
+     * IDs of the dispute evidence documents to update.
+     *
+     * Limited to 100 documents per request.
      * @minSize 1
      * @maxSize 100
      * @format GUID
      */
     ids: string[];
-    /** List of Tags to assign */
+    /**
+     * 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.
+     */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /**
+     * 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.
+     */
     unassignTags?: Tags;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
     /**
-     * Results
+     * 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 regarding the bulk update operation */
+    /**
+     * Metadata about the bulk tag update operation.
+     * Metadata about the bulk tag update operation.
+     */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface ItemMetadata {
@@ -288,7 +344,10 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsResult {
-    /** Metadata regarding the specific single update operation */
+    /**
+     * Metadata about the tag update result for this specific document.
+     * Metadata about the tag update result for this specific document.
+     */
     itemMetadata?: ItemMetadata;
 }
 interface BulkActionMetadata {
@@ -300,72 +359,86 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
-    /** 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.
+     */
     filter: Record<string, any> | null;
-    /** List of Tags to assign */
+    /**
+     * 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.
+     */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /**
+     * 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.
+     */
     unassignTags?: Tags;
 }
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
     /**
-     * Pass this ID to Get Async Job
+     * 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
      */
     jobId?: string;
 }
 interface MigrateDisputeEvidenceDocumentRequest {
     /**
-     * Dispute Id
+     * ID of the dispute.
      * @format GUID
      */
     disputeId?: string;
     /**
-     * Evidence Id
+     * ID of the evidence being migrated.
      * @format GUID
      */
     evidenceId?: string;
     /**
-     * External evidence document Id
+     * External system ID of the evidence document being migrated.
      * @minLength 1
      * @maxLength 64
      */
     evidenceDocumentId?: string;
     /**
-     * File hash
+     * Hash of the file for integrity verification during migration.
      * @minLength 32
      * @maxLength 32
      */
     hash?: string | null;
-    /** Created date */
+    /** Date and time the evidence document was created in the legacy system. */
     _createdDate?: Date | null;
 }
 interface MigrateDisputeEvidenceDocumentResponse {
 }
 interface SubmitMigratedDisputeEvidenceDocumentRequest {
     /**
-     * Dispute Id
+     * ID of the dispute.
      * @format GUID
      */
     disputeId?: string;
     /**
-     * Evidence Id
+     * ID of the migrated evidence document.
      * @format GUID
      */
     evidenceId?: string;
-    /** Submitted date */
+    /** Date when the evidence document was originally submitted in the legacy system. */
     submittedDate?: Date | null;
 }
 interface SubmitMigratedDisputeEvidenceDocumentResponse {
 }
 interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
     /**
-     * Dispute Evidence Document ID
+     * ID of the dispute evidence document.
      * @format GUID
      */
     disputeEvidenceDocumentId?: string;
     /**
-     * Name of the uploaded file
+     * Name of the file to be uploaded as evidence.
      * @minLength 1
      * @maxLength 255
      */
@@ -373,26 +446,26 @@ interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
 }
 interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
     /**
-     * Evidence Document upload URL
+     * URL for uploading the evidence file.
      * @format WEB_URL
      */
     uploadUrl?: string;
 }
 interface AttachDisputeEvidenceDocumentFileRequest {
     /**
-     * Dispute Evidence Document ID
+     * ID of the dispute evidence document.
      * @format GUID
      */
     disputeEvidenceDocumentId?: string;
 }
 interface AttachDisputeEvidenceDocumentFileResponse {
-    /** Dispute Evidence Document */
+    /** Updated dispute evidence document with attached file information. */
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 /** it will be removed */
 interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
     /**
-     * ID of the DisputeEvidenceDocument to generate Download Url.
+     * ID of the dispute evidence document.
      * @format GUID
      */
     disputeEvidenceDocumentId?: string;
@@ -400,17 +473,17 @@ interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
 /** it will be removed */
 interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
     /**
-     * Document source URL.
+     * URL for downloading the evidence document file.
      * @format WEB_URL
      */
     url?: string | null;
-    /** Document source URL expiration date (when relevant). */
+    /** Date and time when the download URL expires. */
     urlExpirationDate?: Date | null;
 }
 /** it will be removed */
 interface MarkDisputeEvidenceDocumentSubmittedRequest {
     /**
-     * Id of the DisputeEvidenceDocument to mark as submitted.
+     * ID of the dispute evidence document to mark as submitted.
      * @format GUID
      */
     disputeEvidenceDocumentId?: string;
@@ -648,31 +721,41 @@ interface DisputeEvidenceDocumentUpdatedEnvelope {
  */
 declare function onDisputeEvidenceDocumentUpdated(handler: (event: DisputeEvidenceDocumentUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Creates a DisputeEvidenceDocument.
- * @param disputeEvidenceDocument - DisputeEvidenceDocument to be created.
+ * 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.
+ * @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
- * @returns The created DisputeEvidenceDocument.
+ * @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, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
+declare function createDisputeEvidenceDocument(disputeEvidenceDocument: NonNullablePaths<DisputeEvidenceDocument, `disputeId`, 2>): Promise<NonNullablePaths<DisputeEvidenceDocument, `disputeId` | `tags.privateTags.tagIds`, 4>>;
 /**
- * Retrieves a DisputeEvidenceDocument.
- * @param disputeEvidenceDocumentId - ID of the DisputeEvidenceDocument to retrieve.
+ * Retrieves a dispute evidence document by ID.
+ * @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
- * @returns The requested DisputeEvidenceDocument.
+ * @returns Retrieved dispute evidence document.
+ * Retrieved dispute evidence document.
  * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GetDisputeEvidenceDocument
  */
-declare function getDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<DisputeEvidenceDocument, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
+declare function getDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<DisputeEvidenceDocument, `disputeId` | `tags.privateTags.tagIds`, 4>>;
 /**
- * Deletes a DisputeEvidenceDocument.
- * @param disputeEvidenceDocumentId - Id of the DisputeEvidenceDocument to delete.
+ * Deletes a dispute evidence document.
+ *
+ * Documents cannot be deleted once they have been submitted for dispute resolution.
+ * @param disputeEvidenceDocumentId - ID of the dispute evidence document to delete.
+ * ID of the dispute evidence document to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField disputeEvidenceDocumentId
@@ -683,7 +766,9 @@ declare function deleteDisputeEvidenceDocument(disputeEvidenceDocumentId: string
     __applicationErrorsType?: DeleteDisputeEvidenceDocumentApplicationErrors;
 }>;
 /**
- * Retrieves a list of DisputeEvidenceDocuments, given the provided [paging, filtering, and sorting][1].
+ * Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting.
+ *
+ * Use the `disputeId` filter to retrieve all evidence documents for a specific dispute.
  * @public
  * @documentationMaturity preview
  * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
@@ -768,9 +853,14 @@ interface DisputeEvidenceDocumentsQueryBuilder {
     find: () => Promise<DisputeEvidenceDocumentsQueryResult>;
 }
 /**
- * Synchronously update tags on multiple dispute evidence documents, by list of dispute evidence document 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 dispute evidence documents by ID.
+ *
+ * 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.
  * @public
  * @documentationMaturity preview
  * @requiredField ids
@@ -781,16 +871,29 @@ declare function bulkUpdateDisputeEvidenceDocumentTags(ids: string[], options?:
     __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors;
 }>;
 interface BulkUpdateDisputeEvidenceDocumentTagsOptions {
-    /** List of Tags to assign */
+    /**
+     * 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.
+     */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /**
+     * 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.
+     */
     unassignTags?: Tags;
 }
 /**
- * Asynchronously update tags on multiple dispute evidence documents, by provided filter.
- * An empty filter will update all dispute evidence documents
- * A tag that appears both in the list of assign and unassign tags, will be assigned
- * @param filter - Filter
+ * Updates tags on multiple dispute evidence documents matching the provided filter.
+ *
+ * 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.
  * @public
  * @documentationMaturity preview
  * @requiredField filter
@@ -801,9 +904,17 @@ declare function bulkUpdateDisputeEvidenceDocumentTagsByFilter(filter: Record<st
     __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors;
 }>;
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
-    /** List of Tags to assign */
+    /**
+     * 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.
+     */
     assignTags?: Tags;
-    /** List of Tags to unAssign */
+    /**
+     * 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.
+     */
     unassignTags?: Tags;
 }