@wix/auto_sdk_payments_dispute-evidence-documents 1.0.28 → 1.0.30

package/build/es/index.typings.d.mts

@@ -1 +1,810 @@
-export { ActionEvent, ApplicationError, AttachDisputeEvidenceDocumentFileApplicationErrors, AttachDisputeEvidenceDocumentFileRequest, AttachDisputeEvidenceDocumentFileResponse, BulkActionMetadata, BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors, BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors, BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions, BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest, BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, BulkUpdateDisputeEvidenceDocumentTagsOptions, BulkUpdateDisputeEvidenceDocumentTagsRequest, BulkUpdateDisputeEvidenceDocumentTagsResponse, BulkUpdateDisputeEvidenceDocumentTagsResult, CreateDisputeEvidenceDocumentRequest, CreateDisputeEvidenceDocumentResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteDisputeEvidenceDocumentApplicationErrors, DeleteDisputeEvidenceDocumentRequest, DeleteDisputeEvidenceDocumentResponse, DisputeEvidenceDocument, DisputeEvidenceDocumentsQueryBuilder, DisputeEvidenceDocumentsQueryResult, DocumentFile, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GenerateDisputeEvidenceDocumentDownloadUrlApplicationErrors, GenerateDisputeEvidenceDocumentDownloadUrlRequest, GenerateDisputeEvidenceDocumentDownloadUrlResponse, GenerateDisputeEvidenceDocumentUploadUrlApplicationErrors, GenerateDisputeEvidenceDocumentUploadUrlOptions, GenerateDisputeEvidenceDocumentUploadUrlRequest, GenerateDisputeEvidenceDocumentUploadUrlResponse, GetDisputeEvidenceDocumentRequest, GetDisputeEvidenceDocumentResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MarkDisputeEvidenceDocumentSubmittedRequest, MarkDisputeEvidenceDocumentSubmittedResponse, MessageEnvelope, MigrateDisputeEvidenceDocumentRequest, MigrateDisputeEvidenceDocumentResponse, QueryDisputeEvidenceDocumentsRequest, QueryDisputeEvidenceDocumentsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, SubmitMigratedDisputeEvidenceDocumentRequest, SubmitMigratedDisputeEvidenceDocumentResponse, TagList, Tags, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.mjs';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/** Dispute Evidence Document */
+interface DisputeEvidenceDocument {
+    /**
+     * DisputeEvidenceDocument ID.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    _id?: string;
+    /**
+     * 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.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the DisputeEvidenceDocument was created.
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the DisputeEvidenceDocument was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    disputeId?: string;
+    /**
+     * Document evidence file if it was uploaded and attached
+     * @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?: Tags;
+}
+interface DocumentFile {
+    /**
+     * Document filename.
+     * @readonly
+     * @maxLength 255
+     */
+    filename?: string | null;
+    /**
+     * Document size in bytes.
+     * @readonly
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Hexadecimal representation of the document's MD5 digest.
+     * @minLength 32
+     * @maxLength 32
+     * @readonly
+     */
+    hexMd5Digest?: string | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * public_tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    publicTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface TagsModified {
+    /** Updated DisputeEvidenceDocument. */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+    /** Tags that were assigned to the DisputeEvidenceDocument. */
+    assignedTags?: Tags;
+    /** Tags that were unassigned from the DisputeEvidenceDocument. */
+    unassignedTags?: Tags;
+}
+interface CreateDisputeEvidenceDocumentRequest {
+    /** DisputeEvidenceDocument to be created. */
+    disputeEvidenceDocument: DisputeEvidenceDocument;
+}
+interface CreateDisputeEvidenceDocumentResponse {
+    /** The created DisputeEvidenceDocument. */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+    /**
+     * Upload URL to upload file evidence
+     * @format WEB_URL
+     */
+    uploadUrl?: string | null;
+}
+interface GetDisputeEvidenceDocumentRequest {
+    /**
+     * ID of the DisputeEvidenceDocument to retrieve.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface GetDisputeEvidenceDocumentResponse {
+    /** The requested DisputeEvidenceDocument. */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+}
+interface DeleteDisputeEvidenceDocumentRequest {
+    /**
+     * Id of the DisputeEvidenceDocument to delete.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface DeleteDisputeEvidenceDocumentResponse {
+}
+interface QueryDisputeEvidenceDocumentsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryDisputeEvidenceDocumentsResponse {
+    /** List of DisputeEvidenceDocuments. */
+    disputeEvidenceDocuments?: DisputeEvidenceDocument[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateDisputeEvidenceDocumentTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
+    /**
+     * Pass this ID to Get Async Job
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface MigrateDisputeEvidenceDocumentRequest {
+    /**
+     * Dispute Id
+     * @format GUID
+     */
+    disputeId?: string;
+    /**
+     * Evidence Id
+     * @format GUID
+     */
+    evidenceId?: string;
+    /**
+     * External evidence document Id
+     * @minLength 1
+     * @maxLength 64
+     */
+    evidenceDocumentId?: string;
+    /**
+     * File hash
+     * @minLength 32
+     * @maxLength 32
+     */
+    hash?: string | null;
+    /** Created date */
+    _createdDate?: Date | null;
+}
+interface MigrateDisputeEvidenceDocumentResponse {
+}
+interface SubmitMigratedDisputeEvidenceDocumentRequest {
+    /**
+     * Dispute Id
+     * @format GUID
+     */
+    disputeId?: string;
+    /**
+     * Evidence Id
+     * @format GUID
+     */
+    evidenceId?: string;
+    /** Submitted date */
+    submittedDate?: Date | null;
+}
+interface SubmitMigratedDisputeEvidenceDocumentResponse {
+}
+interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
+    disputeEvidenceDocumentId?: string;
+    /**
+     * Name of the uploaded file
+     * @minLength 1
+     * @maxLength 255
+     */
+    filename?: string;
+}
+interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
+    /**
+     * Evidence Document upload URL
+     * @format WEB_URL
+     */
+    uploadUrl?: string;
+}
+interface AttachDisputeEvidenceDocumentFileRequest {
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
+    disputeEvidenceDocumentId?: string;
+}
+interface AttachDisputeEvidenceDocumentFileResponse {
+    /** Dispute Evidence Document */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+}
+/** it will be removed */
+interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
+    /**
+     * ID of the DisputeEvidenceDocument to generate Download Url.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId?: string;
+}
+/** it will be removed */
+interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
+    /**
+     * Document source URL.
+     * @format WEB_URL
+     */
+    url?: string | null;
+    /** Document source URL expiration date (when relevant). */
+    urlExpirationDate?: Date | null;
+}
+/** it will be removed */
+interface MarkDisputeEvidenceDocumentSubmittedRequest {
+    /**
+     * Id of the DisputeEvidenceDocument to mark as submitted.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId?: string;
+}
+/** it will be removed */
+interface MarkDisputeEvidenceDocumentSubmittedResponse {
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
+type DeleteDisputeEvidenceDocumentApplicationErrors = {
+    code?: 'DISPUTE_EVIDENCE_DOCUMENT_ALREADY_SUBMITTED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface DisputeEvidenceDocumentCreatedEnvelope {
+    entity: DisputeEvidenceDocument;
+    metadata: EventMetadata;
+}
+/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @webhook
+ * @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onDisputeEvidenceDocumentCreated(handler: (event: DisputeEvidenceDocumentCreatedEnvelope) => void | Promise<void>): void;
+interface DisputeEvidenceDocumentDeletedEnvelope {
+    entity: DisputeEvidenceDocument;
+    metadata: EventMetadata;
+}
+/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @webhook
+ * @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onDisputeEvidenceDocumentDeleted(handler: (event: DisputeEvidenceDocumentDeletedEnvelope) => void | Promise<void>): void;
+interface DisputeEvidenceDocumentUpdatedEnvelope {
+    entity: DisputeEvidenceDocument;
+    metadata: EventMetadata;
+}
+/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
+ * @webhook
+ * @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onDisputeEvidenceDocumentUpdated(handler: (event: DisputeEvidenceDocumentUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a DisputeEvidenceDocument.
+ * @param disputeEvidenceDocument - DisputeEvidenceDocument to be created.
+ * @public
+ * @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`, 2>): Promise<NonNullablePaths<DisputeEvidenceDocument, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Retrieves a DisputeEvidenceDocument.
+ * @param disputeEvidenceDocumentId - ID of the DisputeEvidenceDocument to retrieve.
+ * @public
+ * @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, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Deletes a DisputeEvidenceDocument.
+ * @param disputeEvidenceDocumentId - Id of the DisputeEvidenceDocument to delete.
+ * @public
+ * @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].
+ * @public
+ * @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;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface DisputeEvidenceDocumentsQueryResult extends QueryCursorResult {
+    items: DisputeEvidenceDocument[];
+    query: DisputeEvidenceDocumentsQueryBuilder;
+    next: () => Promise<DisputeEvidenceDocumentsQueryResult>;
+    prev: () => Promise<DisputeEvidenceDocumentsQueryResult>;
+}
+interface DisputeEvidenceDocumentsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'disputeId', value: string) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: 'disputeId', value: any[]) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'disputeId', value: boolean) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'disputeId'>) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'disputeId'>) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => DisputeEvidenceDocumentsQueryBuilder;
+    /** @documentationMaturity preview */
+    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.
+ * @public
+ * @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`, 6> & {
+    __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors;
+}>;
+interface BulkUpdateDisputeEvidenceDocumentTagsOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    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
+ * @public
+ * @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`, 2> & {
+    __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+
+export { type ActionEvent, type ApplicationError, type AttachDisputeEvidenceDocumentFileRequest, type AttachDisputeEvidenceDocumentFileResponse, type BaseEventMetadata, 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 DisputeEvidenceDocumentCreatedEnvelope, type DisputeEvidenceDocumentDeletedEnvelope, type DisputeEvidenceDocumentUpdatedEnvelope, type DisputeEvidenceDocumentsQueryBuilder, type DisputeEvidenceDocumentsQueryResult, type DocumentFile, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GenerateDisputeEvidenceDocumentDownloadUrlRequest, type GenerateDisputeEvidenceDocumentDownloadUrlResponse, 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, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateDisputeEvidenceDocumentTags, bulkUpdateDisputeEvidenceDocumentTagsByFilter, createDisputeEvidenceDocument, deleteDisputeEvidenceDocument, getDisputeEvidenceDocument, onDisputeEvidenceDocumentCreated, onDisputeEvidenceDocumentDeleted, onDisputeEvidenceDocumentUpdated, queryDisputeEvidenceDocuments };