@wix/auto_sdk_payments_dispute-history-records 1.0.26 → 1.0.28

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

@@ -1 +1,648 @@
-export { ActionEvent, ApplicationError, BulkActionMetadata, BulkUpdateDisputeHistoryRecordTagsApplicationErrors, BulkUpdateDisputeHistoryRecordTagsByFilterApplicationErrors, BulkUpdateDisputeHistoryRecordTagsByFilterOptions, BulkUpdateDisputeHistoryRecordTagsByFilterRequest, BulkUpdateDisputeHistoryRecordTagsByFilterResponse, BulkUpdateDisputeHistoryRecordTagsOptions, BulkUpdateDisputeHistoryRecordTagsRequest, BulkUpdateDisputeHistoryRecordTagsResponse, BulkUpdateDisputeHistoryRecordTagsResult, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DisputeChannel, DisputeChannelWithLiterals, DisputeHistoryRecord, DisputeHistoryRecordsQueryBuilder, DisputeHistoryRecordsQueryResult, DisputeStage, DisputeStageWithLiterals, DisputeStatus, DisputeStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetDisputeHistoryRecordRequest, GetDisputeHistoryRecordResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, QueryDisputeHistoryRecordsRequest, QueryDisputeHistoryRecordsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, TagList, Tags, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.js';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A dispute history record represents a snapshot of dispute information at a specific point in time.
+ *
+ * Records are automatically created whenever a dispute changes status, stage, or other key properties, providing a complete audit trail for compliance and audit requirements.
+ */
+interface DisputeHistoryRecord {
+    /**
+     * DisputeHistoryRecord ID.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    _id?: string;
+    /**
+     * Revision number, which increments by 1 each time the dispute history record is updated.
+     * To prevent conflicting changes, the existing revision must be specified when updating a dispute history record.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the DisputeHistoryRecord was created.
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the DisputeHistoryRecord was last updated.
+     * @readonly
+     * @immutable
+     */
+    _updatedDate?: Date | null;
+    /**
+     * ID of the dispute that this history record tracks. Each dispute can have multiple history records showing its lifecycle changes.
+     * @format GUID
+     * @immutable
+     */
+    disputeId?: string;
+    /**
+     * Stage of the dispute lifecycle at the time this record was created.
+     * Indicates whether this was an inquiry (request for information) or a chargeback (formal dispute).
+     * @readonly
+     * @immutable
+     */
+    stage?: DisputeStageWithLiterals;
+    /**
+     * Status of the dispute at the time this record was created.
+     * Indicates what action was required and by whom at this point in the dispute lifecycle.
+     * @readonly
+     * @immutable
+     */
+    status?: DisputeStatusWithLiterals;
+    /**
+     * Date by which action must be taken on the dispute.
+     * After this date, the dispute may be automatically resolved against the merchant.
+     * @readonly
+     * @immutable
+     */
+    dueDate?: Date | null;
+    /**
+     * ID of the payment charge that is being disputed.
+     * Links this history record to the original transaction.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    chargeId?: string;
+    /**
+     * 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
+     * @immutable
+     */
+    channel?: DisputeChannelWithLiterals;
+    /** Custom field data for the dispute history record. Extended fields must be configured in the app dashboard before they can be accessed with API calls. */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+declare enum DisputeStage {
+    UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
+    /** Formal dispute filed by the cardholder through their bank. */
+    CHARGEBACK = "CHARGEBACK",
+    /** Request for additional information about the transaction, which may escalate to a chargeback if not resolved. */
+    INQUIRY = "INQUIRY"
+}
+/** @enumType */
+type DisputeStageWithLiterals = DisputeStage | 'UNKNOWN_DISPUTE_STAGE' | 'CHARGEBACK' | 'INQUIRY';
+declare enum DisputeStatus {
+    /** Unknown status */
+    UNKNOWN_DISPUTE_STATUS = "UNKNOWN_DISPUTE_STATUS",
+    /** Waiting for merchant action, such as submitting evidence or accepting the dispute. */
+    WAITING_MERCHANT = "WAITING_MERCHANT",
+    /** Dispute is under review by the payment service provider (internal channel) or bank (external channel). */
+    UNDER_REVIEW = "UNDER_REVIEW",
+    /** Waiting for buyer action or response. */
+    WAITING_BUYER = "WAITING_BUYER",
+    /** Dispute was resolved in favor of the merchant. */
+    WON = "WON",
+    /** Dispute was resolved in favor of the cardholder. */
+    LOST = "LOST",
+    /** Evidence was submitted and is being processed on the provider side. This status will be removed in a future version. */
+    PROCESSING_EVIDENCE_SUBMISSION = "PROCESSING_EVIDENCE_SUBMISSION",
+    /** The dispute was accepted and the acceptance is being processed on the provider side. This status will be removed in a future version. */
+    PROCESSING_ACCEPTANCE = "PROCESSING_ACCEPTANCE"
+}
+/** @enumType */
+type DisputeStatusWithLiterals = DisputeStatus | 'UNKNOWN_DISPUTE_STATUS' | 'WAITING_MERCHANT' | 'UNDER_REVIEW' | 'WAITING_BUYER' | 'WON' | 'LOST' | 'PROCESSING_EVIDENCE_SUBMISSION' | 'PROCESSING_ACCEPTANCE';
+declare enum DisputeChannel {
+    UNKNOWN_DISPUTE_CHANNEL = "UNKNOWN_DISPUTE_CHANNEL",
+    /** Dispute is reviewed internally by the payment service provider. */
+    INTERNAL = "INTERNAL",
+    /** Dispute is reviewed externally by the bank or other financial institution. */
+    EXTERNAL = "EXTERNAL"
+}
+/** @enumType */
+type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | 'INTERNAL' | 'EXTERNAL';
+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[];
+}
+/** Triggered when tags are modified on a dispute history record. */
+interface TagsModified {
+    /** Updated dispute history record. */
+    disputeHistoryRecord?: DisputeHistoryRecord;
+    /** Tags that were assigned to the dispute history record. */
+    assignedTags?: Tags;
+    /** Tags that were unassigned from the dispute history record. */
+    unassignedTags?: Tags;
+}
+interface GetDisputeHistoryRecordRequest {
+    /**
+     * ID of the dispute history record to retrieve.
+     * @format GUID
+     */
+    disputeHistoryRecordId: string;
+}
+interface GetDisputeHistoryRecordResponse {
+    /** The requested dispute history record. */
+    disputeHistoryRecord?: DisputeHistoryRecord;
+}
+interface QueryDisputeHistoryRecordsRequest {
+    /**
+     * WQL expression for filtering, sorting, and paging dispute history records.
+     *
+     * Supported properties: `disputeId`, `stage`, `status`, `dueDate`, `chargeId`, `channel`, `createdDate`, `updatedDate`
+     */
+    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 QueryDisputeHistoryRecordsResponse {
+    /** List of dispute history records matching the query criteria. */
+    disputeHistoryRecords?: DisputeHistoryRecord[];
+    /** Paging metadata for cursor-based pagination. */
+    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 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 Empty {
+}
+interface BulkUpdateDisputeHistoryRecordTagsRequest {
+    /**
+     * List of dispute history record IDs whose tags will be updated.
+     *
+     * Limited to 100 IDs per request.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+    /** Tags to assign to the dispute history records. */
+    assignTags?: Tags;
+    /** Tags to unassign from the dispute history records. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeHistoryRecordTagsResponse {
+    /**
+     * Results of the bulk tag update operation for each dispute history record.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateDisputeHistoryRecordTagsResult[];
+    /** Metadata about 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 BulkUpdateDisputeHistoryRecordTagsResult {
+    /** Metadata about the individual item 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 BulkUpdateDisputeHistoryRecordTagsByFilterRequest {
+    /**
+     * Filter criteria for selecting dispute history records to update.
+     * An empty filter will update all dispute history records.
+     */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeHistoryRecordTagsByFilterResponse {
+    /**
+     * Job ID for tracking the asynchronous bulk update operation.
+     * @format GUID
+     */
+    jobId?: 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 BulkUpdateDisputeHistoryRecordTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateDisputeHistoryRecordTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Retrieves a dispute history record by ID.
+ * @param disputeHistoryRecordId - ID of the dispute history record to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField disputeHistoryRecordId
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_READ
+ * @returns The requested dispute history record.
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.GetDisputeHistoryRecord
+ */
+declare function getDisputeHistoryRecord(disputeHistoryRecordId: string): Promise<NonNullablePaths<DisputeHistoryRecord, `_id` | `disputeId` | `stage` | `status` | `chargeId` | `channel` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Retrieves dispute history records with support for filtering, cursor-based paging, and sorting.
+ *
+ * Use this method to get the complete audit trail for specific disputes or to query records across multiple disputes based on various criteria.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_READ
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.QueryDisputeHistoryRecords
+ */
+declare function queryDisputeHistoryRecords(): DisputeHistoryRecordsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface DisputeHistoryRecordsQueryResult extends QueryCursorResult {
+    items: DisputeHistoryRecord[];
+    query: DisputeHistoryRecordsQueryBuilder;
+    next: () => Promise<DisputeHistoryRecordsQueryResult>;
+    prev: () => Promise<DisputeHistoryRecordsQueryResult>;
+}
+interface DisputeHistoryRecordsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'disputeId', value: string) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: 'disputeId', value: any[]) => DisputeHistoryRecordsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'disputeId', value: any) => DisputeHistoryRecordsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'disputeId', value: boolean) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'disputeId'>) => DisputeHistoryRecordsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'disputeId'>) => DisputeHistoryRecordsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => DisputeHistoryRecordsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => DisputeHistoryRecordsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<DisputeHistoryRecordsQueryResult>;
+}
+/**
+ * Synchronously updates tags on multiple dispute history records by ID.
+ *
+ * Use this method when you need immediate confirmation of tag updates for a specific set of records.
+ * Limited to 100 records per request. If a tag appears in both assign and unassign lists, it will be assigned.
+ * @param ids - List of dispute history record IDs whose tags will be updated.
+ *
+ * Limited to 100 IDs per request.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_UPDATE_TAGS
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.BulkUpdateDisputeHistoryRecordTags
+ */
+declare function bulkUpdateDisputeHistoryRecordTags(ids: string[], options?: BulkUpdateDisputeHistoryRecordTagsOptions): Promise<NonNullablePaths<BulkUpdateDisputeHistoryRecordTagsResponse, `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?: BulkUpdateDisputeHistoryRecordTagsApplicationErrors;
+}>;
+interface BulkUpdateDisputeHistoryRecordTagsOptions {
+    /** Tags to assign to the dispute history records. */
+    assignTags?: Tags;
+    /** Tags to unassign from the dispute history records. */
+    unassignTags?: Tags;
+}
+/**
+ * Asynchronously updates tags on multiple dispute history records using a filter.
+ *
+ * Use this method for bulk operations on large sets of records. An empty filter will update all dispute history records.
+ * Returns a job ID for tracking the operation status. If a tag appears in both assign and unassign lists, it will be assigned.
+ * @param filter - Filter criteria for selecting dispute history records to update.
+ * An empty filter will update all dispute history records.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_UPDATE_TAGS
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.BulkUpdateDisputeHistoryRecordTagsByFilter
+ */
+declare function bulkUpdateDisputeHistoryRecordTagsByFilter(filter: Record<string, any>, options?: BulkUpdateDisputeHistoryRecordTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeHistoryRecordTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdateDisputeHistoryRecordTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateDisputeHistoryRecordTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+
+export { type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkUpdateDisputeHistoryRecordTagsApplicationErrors, type BulkUpdateDisputeHistoryRecordTagsByFilterApplicationErrors, type BulkUpdateDisputeHistoryRecordTagsByFilterOptions, type BulkUpdateDisputeHistoryRecordTagsByFilterRequest, type BulkUpdateDisputeHistoryRecordTagsByFilterResponse, type BulkUpdateDisputeHistoryRecordTagsOptions, type BulkUpdateDisputeHistoryRecordTagsRequest, type BulkUpdateDisputeHistoryRecordTagsResponse, type BulkUpdateDisputeHistoryRecordTagsResult, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DisputeChannel, type DisputeChannelWithLiterals, type DisputeHistoryRecord, type DisputeHistoryRecordsQueryBuilder, type DisputeHistoryRecordsQueryResult, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDisputeHistoryRecordRequest, type GetDisputeHistoryRecordResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type QueryDisputeHistoryRecordsRequest, type QueryDisputeHistoryRecordsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type TagList, type Tags, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateDisputeHistoryRecordTags, bulkUpdateDisputeHistoryRecordTagsByFilter, getDisputeHistoryRecord, queryDisputeHistoryRecords };