@wix/auto_sdk_payments_dispute-evidence-documents 1.0.21 → 1.0.23

package/build/internal/es/{payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.universal-Co3je58H.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /** Dispute Evidence Document */
 interface DisputeEvidenceDocument {
     /**
@@ -530,6 +532,66 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type GenerateDisputeEvidenceDocumentUploadUrlApplicationErrors = {
+    code?: 'DISPUTE_EVIDENCE_DOCUMENT_FILE_ALREADY_ATTACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+type AttachDisputeEvidenceDocumentFileApplicationErrors = {
+    code?: 'DISPUTE_EVIDENCE_DOCUMENT_FILE_ALREADY_ATTACHED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FILE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+type GenerateDisputeEvidenceDocumentDownloadUrlApplicationErrors = {
+    code?: 'FILE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+type DeleteDisputeEvidenceDocumentApplicationErrors = {
+    code?: 'DISPUTE_EVIDENCE_DOCUMENT_ALREADY_SUBMITTED';
+    description?: string;
+    data?: Record<string, any>;
+};
+type BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+type DisputeEvidenceDocumentNonNullablePaths = `disputeId` | `tags.tags.tagIds`;
+/**
+ * Creates a DisputeEvidenceDocument.
+ * @param disputeEvidenceDocument - DisputeEvidenceDocument to be created.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocument
+ * @requiredField disputeEvidenceDocument.disputeId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_CREATE
+ * @returns The created DisputeEvidenceDocument.
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.CreateDisputeEvidenceDocument
+ */
+declare function createDisputeEvidenceDocument(disputeEvidenceDocument: NonNullablePaths<DisputeEvidenceDocument, `disputeId`>): Promise<NonNullablePaths<DisputeEvidenceDocument, DisputeEvidenceDocumentNonNullablePaths>>;
+/**
+ * Generate upload URL to upload the file and associate it with specific evidence using file id.
+ * Note: after uploading file you need to use synchronous call to trigger system directly check uploads [AttachDisputeEvidenceDocumentFile]
+ * @param disputeEvidenceDocumentId - Dispute Evidence Document ID
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocumentId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_GENERATE_UPLOAD_URL
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GenerateDisputeEvidenceDocumentUploadUrl
+ */
+declare function generateDisputeEvidenceDocumentUploadUrl(disputeEvidenceDocumentId: string, options?: GenerateDisputeEvidenceDocumentUploadUrlOptions): Promise<NonNullablePaths<GenerateDisputeEvidenceDocumentUploadUrlResponse, `uploadUrl`> & {
+    __applicationErrorsType?: GenerateDisputeEvidenceDocumentUploadUrlApplicationErrors;
+}>;
 interface GenerateDisputeEvidenceDocumentUploadUrlOptions {
     /**
      * Name of the uploaded file
@@ -538,6 +600,74 @@ interface GenerateDisputeEvidenceDocumentUploadUrlOptions {
      */
     filename?: string;
 }
+/**
+ * Synchronously attaches uploaded document to the corresponding evidence document.
+ * Note: this call doesn't allow to upload document. To upload document use [GenerateDisputeEvidenceDocumentUploadUrl]
+ * @param disputeEvidenceDocumentId - Dispute Evidence Document ID
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocumentId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_ATTACH_FILE
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.AttachDisputeEvidenceDocumentFile
+ */
+declare function attachDisputeEvidenceDocumentFile(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<AttachDisputeEvidenceDocumentFileResponse, {
+    [P in DisputeEvidenceDocumentNonNullablePaths]: `disputeEvidenceDocument.${P}`;
+}[DisputeEvidenceDocumentNonNullablePaths]> & {
+    __applicationErrorsType?: AttachDisputeEvidenceDocumentFileApplicationErrors;
+}>;
+/**
+ * Retrieves a DisputeEvidenceDocument.
+ * @param disputeEvidenceDocumentId - ID of the DisputeEvidenceDocument to retrieve.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocumentId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @returns The requested DisputeEvidenceDocument.
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GetDisputeEvidenceDocument
+ */
+declare function getDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<DisputeEvidenceDocument, DisputeEvidenceDocumentNonNullablePaths>>;
+/**
+ * Generate DisputeEvidenceDocument Download Url.
+ * @param disputeEvidenceDocumentId - ID of the DisputeEvidenceDocument to generate Download Url.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocumentId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_GENERATE_DOWNLOAD_URL
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GenerateDisputeEvidenceDocumentDownloadUrl
+ */
+declare function generateDisputeEvidenceDocumentDownloadUrl(disputeEvidenceDocumentId: string): Promise<GenerateDisputeEvidenceDocumentDownloadUrlResponse & {
+    __applicationErrorsType?: GenerateDisputeEvidenceDocumentDownloadUrlApplicationErrors;
+}>;
+/**
+ * Mark a DisputeEvidenceDocument as submitted.
+ * @param disputeEvidenceDocumentId - Id of the DisputeEvidenceDocument to mark as submitted.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocumentId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_MARK_SUBMITTED
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.MarkDisputeEvidenceDocumentSubmitted
+ */
+declare function markDisputeEvidenceDocumentSubmitted(disputeEvidenceDocumentId: string): Promise<void>;
+/**
+ * Deletes a DisputeEvidenceDocument.
+ * @param disputeEvidenceDocumentId - Id of the DisputeEvidenceDocument to delete.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeEvidenceDocumentId
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_DELETE
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.DeleteDisputeEvidenceDocument
+ */
+declare function deleteDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<void & {
+    __applicationErrorsType?: DeleteDisputeEvidenceDocumentApplicationErrors;
+}>;
+/**
+ * Retrieves a list of DisputeEvidenceDocuments, given the provided [paging, filtering, and sorting][1].
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.QueryDisputeEvidenceDocuments
+ */
+declare function queryDisputeEvidenceDocuments(): DisputeEvidenceDocumentsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -615,12 +745,39 @@ interface DisputeEvidenceDocumentsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<DisputeEvidenceDocumentsQueryResult>;
 }
+/**
+ * Synchronously update tags on multiple products, by list of product 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.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_UPDATE_TAGS
+ * @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`> & {
+    __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors;
+}>;
 interface BulkUpdateDisputeEvidenceDocumentTagsOptions {
     /** List of Tags to assign */
     assignTags?: Tags;
     /** List of Tags to unAssign */
     unassignTags?: Tags;
 }
+/**
+ * Asynchronously update tags on multiple products, by provided filter
+ * An empty filter will update all products
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
+ * @param filter - Filter
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_UPDATE_TAGS
+ * @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.BulkUpdateDisputeEvidenceDocumentTagsByFilter
+ */
+declare function bulkUpdateDisputeEvidenceDocumentTagsByFilter(filter: Record<string, any>, options?: BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, `jobId`> & {
+    __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors;
+}>;
 interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
     /** List of Tags to assign */
     assignTags?: Tags;
@@ -628,4 +785,4 @@ interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
     unassignTags?: Tags;
 }
 
-export { type IdentificationData as $, type AttachDisputeEvidenceDocumentFileResponse as A, type BulkUpdateDisputeEvidenceDocumentTagsOptions as B, type CreateDisputeEvidenceDocumentRequest as C, type DisputeEvidenceDocument as D, type ExtendedFields as E, type SubmitMigratedDisputeEvidenceDocumentRequest as F, type GenerateDisputeEvidenceDocumentUploadUrlOptions as G, type SubmitMigratedDisputeEvidenceDocumentResponse as H, type BulkUpdateDisputeEvidenceDocumentTagsRequest as I, type ItemMetadata as J, type ApplicationError as K, type BulkUpdateDisputeEvidenceDocumentTagsResult as L, type MarkDisputeEvidenceDocumentSubmittedRequest as M, type BulkActionMetadata as N, type BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest as O, type DomainEvent as P, type QueryDisputeEvidenceDocumentsRequest as Q, type DomainEventBodyOneOf as R, SortOrder as S, type Tags as T, type EntityCreatedEvent as U, type RestoreInfo as V, WebhookIdentityType as W, type EntityUpdatedEvent as X, type EntityDeletedEvent as Y, type ActionEvent as Z, type MessageEnvelope as _, type GenerateDisputeEvidenceDocumentUploadUrlResponse as a, type IdentificationDataIdOneOf as a0, type DisputeEvidenceDocumentsQueryResult as a1, type GenerateDisputeEvidenceDocumentDownloadUrlResponse as b, type DisputeEvidenceDocumentsQueryBuilder as c, type BulkUpdateDisputeEvidenceDocumentTagsResponse as d, type BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions as e, type BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse as f, type DocumentFile as g, type TagList as h, type CreateDisputeEvidenceDocumentResponse as i, type GenerateDisputeEvidenceDocumentUploadUrlRequest as j, type AttachDisputeEvidenceDocumentFileRequest as k, type GetDisputeEvidenceDocumentRequest as l, type GetDisputeEvidenceDocumentResponse as m, type GenerateDisputeEvidenceDocumentDownloadUrlRequest as n, type MarkDisputeEvidenceDocumentSubmittedResponse as o, type DeleteDisputeEvidenceDocumentRequest as p, type DeleteDisputeEvidenceDocumentResponse as q, type CursorQuery as r, type CursorQueryPagingMethodOneOf as s, type Sorting as t, type CursorPaging as u, type QueryDisputeEvidenceDocumentsResponse as v, type CursorPagingMetadata as w, type Cursors as x, type MigrateDisputeEvidenceDocumentRequest as y, type MigrateDisputeEvidenceDocumentResponse as z };
+export { type ActionEvent, type ApplicationError, type AttachDisputeEvidenceDocumentFileApplicationErrors, type AttachDisputeEvidenceDocumentFileRequest, type AttachDisputeEvidenceDocumentFileResponse, type BulkActionMetadata, type BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors, type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors, type BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions, type BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest, type BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, type BulkUpdateDisputeEvidenceDocumentTagsOptions, type BulkUpdateDisputeEvidenceDocumentTagsRequest, type BulkUpdateDisputeEvidenceDocumentTagsResponse, type BulkUpdateDisputeEvidenceDocumentTagsResult, type CreateDisputeEvidenceDocumentRequest, type CreateDisputeEvidenceDocumentResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteDisputeEvidenceDocumentApplicationErrors, type DeleteDisputeEvidenceDocumentRequest, type DeleteDisputeEvidenceDocumentResponse, type DisputeEvidenceDocument, type DisputeEvidenceDocumentsQueryBuilder, type DisputeEvidenceDocumentsQueryResult, type DocumentFile, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GenerateDisputeEvidenceDocumentDownloadUrlApplicationErrors, type GenerateDisputeEvidenceDocumentDownloadUrlRequest, type GenerateDisputeEvidenceDocumentDownloadUrlResponse, type GenerateDisputeEvidenceDocumentUploadUrlApplicationErrors, type GenerateDisputeEvidenceDocumentUploadUrlOptions, type GenerateDisputeEvidenceDocumentUploadUrlRequest, type GenerateDisputeEvidenceDocumentUploadUrlResponse, type GetDisputeEvidenceDocumentRequest, type GetDisputeEvidenceDocumentResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MarkDisputeEvidenceDocumentSubmittedRequest, type MarkDisputeEvidenceDocumentSubmittedResponse, type MessageEnvelope, type MigrateDisputeEvidenceDocumentRequest, type MigrateDisputeEvidenceDocumentResponse, type QueryDisputeEvidenceDocumentsRequest, type QueryDisputeEvidenceDocumentsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitMigratedDisputeEvidenceDocumentRequest, type SubmitMigratedDisputeEvidenceDocumentResponse, type TagList, type Tags, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, attachDisputeEvidenceDocumentFile, bulkUpdateDisputeEvidenceDocumentTags, bulkUpdateDisputeEvidenceDocumentTagsByFilter, createDisputeEvidenceDocument, deleteDisputeEvidenceDocument, generateDisputeEvidenceDocumentDownloadUrl, generateDisputeEvidenceDocumentUploadUrl, getDisputeEvidenceDocument, markDisputeEvidenceDocumentSubmitted, queryDisputeEvidenceDocuments };