@wix/auto_sdk_payments_disputes 1.0.33 → 1.0.34

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

@@ -1 +1,1014 @@
-export { AcceptDisputeManuallyRequest, AcceptDisputeManuallyResponse, AcceptDisputeRequest, AcceptDisputeResponse, ActionEvent, ApplicationError, BulkActionMetadata, BulkUpdateDisputeTagsApplicationErrors, BulkUpdateDisputeTagsByFilterApplicationErrors, BulkUpdateDisputeTagsByFilterOptions, BulkUpdateDisputeTagsByFilterRequest, BulkUpdateDisputeTagsByFilterResponse, BulkUpdateDisputeTagsOptions, BulkUpdateDisputeTagsRequest, BulkUpdateDisputeTagsResponse, BulkUpdateDisputeTagsResult, ChangeDisputeStatusManuallyRequest, ChangeDisputeStatusManuallyResponse, CreateDisputeManuallyRequest, CreateDisputeManuallyResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DefendDisputeManuallyRequest, DefendDisputeManuallyResponse, DefendDisputeRequest, DefendDisputeResponse, Dispute, DisputeAction, DisputeActionType, DisputeActionTypeWithLiterals, DisputeChannel, DisputeChannelWithLiterals, DisputeReason, DisputeReasonWithLiterals, DisputeStage, DisputeStageWithLiterals, DisputeStatus, DisputeStatusWithLiterals, DisputesQueryBuilder, DisputesQueryResult, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetDisputeRequest, GetDisputeResponse, IdentificationData, IdentificationDataIdOneOf, InternalChangeDisputeStatusManuallyRequest, InternalChangeDisputeStatusManuallyResponse, InternalCreateDisputeManuallyRequest, InternalCreateDisputeManuallyResponse, ItemMetadata, MessageEnvelope, QueryDisputesRequest, QueryDisputesResponse, RestoreInfo, SellerProtection, SellerProtectionWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, SubmitDisputeEvidenceRequest, SubmitDisputeEvidenceResponse, TagList, Tags, TagsModified, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.mjs';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/** Dispute. A dispute occurs when an account owner contacts their PSP or bank to contest a payment to you for a number of possible reasons. */
+interface Dispute {
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    _id?: string;
+    /**
+     * Charge ID
+     * @format GUID
+     * @immutable
+     */
+    chargeId?: string;
+    /**
+     * Provider Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    providerDisputeId?: string;
+    /**
+     * Dispute stage
+     * @readonly
+     */
+    stage?: DisputeStageWithLiterals;
+    /**
+     * Dispute reason
+     * @readonly
+     */
+    reason?: DisputeReasonWithLiterals;
+    /**
+     * Dispute currency. Should be the same as the charge currency.
+     * @immutable
+     * @format CURRENCY
+     */
+    currencyCode?: string | null;
+    /**
+     * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Dispute status based on provider dispute status
+     * @readonly
+     */
+    status?: DisputeStatusWithLiterals;
+    /**
+     * Seller protection helps protect sellers from financial loss on eligible transactions due to unauthorized payments or claims that items were not received
+     * @readonly
+     */
+    sellerProtection?: SellerProtectionWithLiterals;
+    /**
+     * 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
+     */
+    channel?: DisputeChannelWithLiterals;
+    /**
+     * The latest date and time until which the dispute can remain in its current status
+     * @readonly
+     */
+    dueDate?: Date | null;
+    /**
+     * Network reason code
+     * @minLength 1
+     * @maxLength 64
+     */
+    networkReasonCode?: string | null;
+    /**
+     * True if dispute is defendable
+     * @readonly
+     */
+    defendable?: boolean | null;
+    /**
+     * True if it is an auto dispute
+     * @readonly
+     */
+    autoDefended?: boolean | null;
+    /**
+     * The dispute defended date
+     * @readonly
+     */
+    defendedDate?: Date | null;
+    /**
+     * The dispute acceptance date
+     * @readonly
+     */
+    acceptedDate?: Date | null;
+    /**
+     * The actions that can be perform with the dispute
+     * @readonly
+     * @maxSize 20
+     */
+    actions?: DisputeAction[];
+    /**
+     * The dispute created date
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+    /**
+     * The dispute updated date
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the Dispute is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+declare enum DisputeStage {
+    UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
+    /** Chargeback */
+    CHARGEBACK = "CHARGEBACK",
+    /** Inquiry (Request for Information) */
+    INQUIRY = "INQUIRY"
+}
+/** @enumType */
+type DisputeStageWithLiterals = DisputeStage | 'UNKNOWN_DISPUTE_STAGE' | 'CHARGEBACK' | 'INQUIRY';
+declare enum DisputeReason {
+    /** Unknown reason */
+    UNKNOWN_DISPUTE_REASON = "UNKNOWN_DISPUTE_REASON",
+    /** Fraud card */
+    FRAUD_CARD_PRESENT = "FRAUD_CARD_PRESENT",
+    /** Card absent */
+    FRAUD_CARD_ABSENT = "FRAUD_CARD_ABSENT",
+    /** DUPLICATE */
+    DUPLICATE_PROCESSING = "DUPLICATE_PROCESSING",
+    /** Service not provided */
+    SERVICES_NOT_PROVIDED = "SERVICES_NOT_PROVIDED",
+    /** Canceled Recurring */
+    CANCELED_RECURRING = "CANCELED_RECURRING",
+    /** Item not as describe */
+    NOT_AS_DESCRIBED = "NOT_AS_DESCRIBED",
+    /** Counterfeit */
+    COUNTERFEIT = "COUNTERFEIT",
+    /** Misrepresentation */
+    MISREPRESENTATION = "MISREPRESENTATION",
+    /** Canceled */
+    CANCELED = "CANCELED",
+    /** Other reason */
+    OTHER = "OTHER"
+}
+/** @enumType */
+type DisputeReasonWithLiterals = DisputeReason | 'UNKNOWN_DISPUTE_REASON' | 'FRAUD_CARD_PRESENT' | 'FRAUD_CARD_ABSENT' | 'DUPLICATE_PROCESSING' | 'SERVICES_NOT_PROVIDED' | 'CANCELED_RECURRING' | 'NOT_AS_DESCRIBED' | 'COUNTERFEIT' | 'MISREPRESENTATION' | 'CANCELED' | 'OTHER';
+declare enum DisputeStatus {
+    /** Unknown status */
+    UNKNOWN_DISPUTE_STATUS = "UNKNOWN_DISPUTE_STATUS",
+    /** Waiting for some merchant action */
+    WAITING_MERCHANT = "WAITING_MERCHANT",
+    /** Dispute is under review by PSP or Bank */
+    UNDER_REVIEW = "UNDER_REVIEW",
+    /** Waiting for some buyer action */
+    WAITING_BUYER = "WAITING_BUYER",
+    /** Dispute won */
+    WON = "WON",
+    /** Dispute lost */
+    LOST = "LOST",
+    /** Evidence were submitted and are being processed on provider side */
+    PROCESSING_EVIDENCE_SUBMISSION = "PROCESSING_EVIDENCE_SUBMISSION",
+    /** The dispute was accepted and the acceptance is being processed on provider side */
+    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 SellerProtection {
+    UNKNOWN_SELLER_PROTECTION = "UNKNOWN_SELLER_PROTECTION",
+    /** Not Eligible */
+    NOT_ELIGIBLE = "NOT_ELIGIBLE",
+    /** Eligible */
+    ELIGIBLE = "ELIGIBLE",
+    /** Extended seller protection */
+    EXTENDED = "EXTENDED"
+}
+/** @enumType */
+type SellerProtectionWithLiterals = SellerProtection | 'UNKNOWN_SELLER_PROTECTION' | 'NOT_ELIGIBLE' | 'ELIGIBLE' | 'EXTENDED';
+declare enum DisputeChannel {
+    UNKNOWN_DISPUTE_CHANNEL = "UNKNOWN_DISPUTE_CHANNEL",
+    /** Internal, the dispute is reviewed by PSP */
+    INTERNAL = "INTERNAL",
+    /** External, the dispute is reviewed by bank (or other financial institution) */
+    EXTERNAL = "EXTERNAL"
+}
+/** @enumType */
+type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | 'INTERNAL' | 'EXTERNAL';
+interface DisputeAction {
+    /** Dispute Action type */
+    type?: DisputeActionTypeWithLiterals;
+    /** The latest date and time until which the action can be performed */
+    dueDate?: Date | null;
+}
+declare enum DisputeActionType {
+    /** Unknown dispute status */
+    UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
+    /** Accept dispute */
+    ACCEPT = "ACCEPT",
+    /** Defend evidence */
+    DEFEND = "DEFEND"
+}
+/** @enumType */
+type DisputeActionTypeWithLiterals = DisputeActionType | 'UNKNOWN_DISPUTE_ACTION' | 'ACCEPT' | 'DEFEND';
+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 Dispute. */
+    dispute?: Dispute;
+    /** Tags that were assigned to the Dispute. */
+    assignedTags?: Tags;
+    /** Tags that were unassigned from the Dispute. */
+    unassignedTags?: Tags;
+}
+interface InternalCreateDisputeManuallyRequest {
+    /**
+     * Dispute Id
+     * @format GUID
+     */
+    disputeId?: string;
+    /**
+     * Charge Id
+     * @format GUID
+     */
+    chargeId?: string;
+    /** Open date */
+    openDate?: Date | null;
+    /**
+     * Provider Dispute Id
+     * @minLength 1
+     * @maxLength 100
+     */
+    providerDisputeId?: string;
+    /** Dispute stage */
+    stage?: DisputeStageWithLiterals;
+    /** Dispute reason */
+    reason?: DisputeReasonWithLiterals;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatusWithLiterals;
+    /** The latest date and time until which the dispute can remain in its current status */
+    dueDate?: Date | null;
+    /**
+     * Dispute currency. Should be the same as the charge currency.
+     * @immutable
+     * @format CURRENCY
+     */
+    currencyCode?: string | null;
+    /**
+     * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Network reason code
+     * @minLength 1
+     * @maxLength 64
+     */
+    networkReasonCode?: string | null;
+    /** External or Internal */
+    external?: boolean | null;
+    /**
+     * Seller protection
+     * @minLength 1
+     * @maxLength 64
+     */
+    sellerProtection?: string | null;
+    /** Is charge refundable */
+    chargeRefundable?: boolean | null;
+    /** True if dispute is defendable */
+    defendable?: boolean | null;
+    /** True if it is an auto dispute */
+    autoDefended?: boolean | null;
+}
+interface InternalCreateDisputeManuallyResponse {
+}
+interface InternalChangeDisputeStatusManuallyRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId?: string;
+    /** Changed date */
+    changedDate?: Date | null;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatusWithLiterals;
+}
+interface InternalChangeDisputeStatusManuallyResponse {
+}
+interface AcceptDisputeManuallyRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId?: string;
+    /** Accepted date */
+    acceptedDate?: Date | null;
+}
+interface AcceptDisputeManuallyResponse {
+}
+interface DefendDisputeManuallyRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId?: string;
+    /** Defense date */
+    defendedDate?: Date | null;
+}
+interface DefendDisputeManuallyResponse {
+}
+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';
+interface GetDisputeRequest {
+    /**
+     * ID of the Dispute to retrieve.
+     * @format GUID
+     */
+    disputeId: string;
+}
+interface GetDisputeResponse {
+    /** The requested Dispute. */
+    dispute?: Dispute;
+}
+interface QueryDisputesRequest {
+    /** 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 QueryDisputesResponse {
+    /** List of Disputes. */
+    disputes?: Dispute[];
+    /** 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 AcceptDisputeRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId: string;
+}
+interface AcceptDisputeResponse {
+    /** Dispute */
+    dispute?: Dispute;
+}
+interface DefendDisputeRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId: string;
+}
+interface DefendDisputeResponse {
+    /** Dispute */
+    dispute?: Dispute;
+}
+interface SubmitDisputeEvidenceRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId?: string;
+}
+interface SubmitDisputeEvidenceResponse {
+    /** Dispute */
+    dispute?: Dispute;
+}
+interface CreateDisputeManuallyRequest {
+    /**
+     * Dispute Id
+     * @format GUID
+     */
+    disputeId?: string;
+    /**
+     * Charge Id
+     * @format GUID
+     */
+    chargeId?: string;
+    /** Open date */
+    openDate?: Date | null;
+    /**
+     * Provider Dispute Id
+     * @minLength 1
+     * @maxLength 100
+     */
+    providerDisputeId?: string;
+    /** Dispute stage */
+    stage?: DisputeStageWithLiterals;
+    /** Dispute reason */
+    reason?: DisputeReasonWithLiterals;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatusWithLiterals;
+    /** The latest date and time until which the dispute can remain in its current status */
+    dueDate?: Date | null;
+    /**
+     * Dispute currency. Should be the same as the charge currency.
+     * @immutable
+     * @format CURRENCY
+     */
+    currencyCode?: string | null;
+    /**
+     * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Network reason code
+     * @minLength 1
+     * @maxLength 64
+     */
+    networkReasonCode?: string | null;
+    /** External or Internal */
+    external?: boolean | null;
+    /**
+     * Seller protection
+     * @minLength 1
+     * @maxLength 64
+     */
+    sellerProtection?: string | null;
+    /** Is charge refundable */
+    chargeRefundable?: boolean | null;
+    /** True if dispute is defendable */
+    defendable?: boolean | null;
+    /** True if it is an auto dispute */
+    autoDefended?: boolean | null;
+}
+interface CreateDisputeManuallyResponse {
+}
+interface ChangeDisputeStatusManuallyRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId?: string;
+    /** Changed date */
+    changedDate?: Date | null;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatusWithLiterals;
+}
+interface ChangeDisputeStatusManuallyResponse {
+}
+interface BulkUpdateDisputeTagsRequest {
+    /**
+     * 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 BulkUpdateDisputeTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateDisputeTagsResult[];
+    /** 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 BulkUpdateDisputeTagsResult {
+    /** 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 BulkUpdateDisputeTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeTagsByFilterResponse {
+    /**
+     * Pass this ID to Get Async Job
+     * @format GUID
+     */
+    jobId?: string;
+}
+/** @docsIgnore */
+type BulkUpdateDisputeTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateDisputeTagsByFilterApplicationErrors = {
+    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 DisputeCreatedEnvelope {
+    entity: Dispute;
+    metadata: EventMetadata;
+}
+/**
+ * Fired when a new Dispute is created.
+ * @permissionId PAYMENTS.DISPUTE_READ
+ * @webhook
+ * @eventType wix.payments.disputes.v1.dispute_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onDisputeCreated(handler: (event: DisputeCreatedEnvelope) => void | Promise<void>): void;
+interface DisputeUpdatedEnvelope {
+    entity: Dispute;
+    metadata: EventMetadata;
+}
+/**
+ * Fired when a Dispute is updated.
+ * @permissionId PAYMENTS.DISPUTE_READ
+ * @webhook
+ * @eventType wix.payments.disputes.v1.dispute_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onDisputeUpdated(handler: (event: DisputeUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Get Dispute by ID
+ * @param disputeId - ID of the Dispute to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField disputeId
+ * @permissionId PAYMENTS.DISPUTE_READ
+ * @returns The requested Dispute.
+ * @fqn wix.payments.disputes.v1.DisputeService.GetDispute
+ */
+declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Retrieves a list of Disputes
+ * @public
+ * @documentationMaturity preview
+ * @permissionId PAYMENTS.DISPUTE_READ
+ * @fqn wix.payments.disputes.v1.DisputeService.QueryDisputes
+ */
+declare function queryDisputes(): DisputesQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface DisputesQueryResult extends QueryCursorResult {
+    items: Dispute[];
+    query: DisputesQueryBuilder;
+    next: () => Promise<DisputesQueryResult>;
+    prev: () => Promise<DisputesQueryResult>;
+}
+interface DisputesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id', value: string) => DisputesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any[]) => DisputesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: boolean) => DisputesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => DisputesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => DisputesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => DisputesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => DisputesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<DisputesQueryResult>;
+}
+/**
+ * Accept Dispute
+ * @param disputeId - Dispute ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField disputeId
+ * @permissionId PAYMENTS.DISPUTE_ACCEPT
+ * @fqn wix.payments.disputes.v1.DisputeService.AcceptDispute
+ */
+declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<AcceptDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
+/**
+ * Defend Dispute
+ * @param disputeId - Dispute ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField disputeId
+ * @permissionId PAYMENTS.DISPUTE_DEFEND
+ * @fqn wix.payments.disputes.v1.DisputeService.DefendDispute
+ */
+declare function defendDispute(disputeId: string): Promise<NonNullablePaths<DefendDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
+/**
+ * Synchronously update tags on multiple Disputes, by list of Disputes 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_UPDATE_TAGS
+ * @fqn wix.payments.disputes.v1.DisputeService.BulkUpdateDisputeTags
+ */
+declare function bulkUpdateDisputeTags(ids: string[], options?: BulkUpdateDisputeTagsOptions): Promise<NonNullablePaths<BulkUpdateDisputeTagsResponse, `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?: BulkUpdateDisputeTagsApplicationErrors;
+}>;
+interface BulkUpdateDisputeTagsOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+/**
+ * Asynchronously update tags on multiple Disputes, by provided filter
+ * An empty filter will update all Disputes
+ * 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_UPDATE_TAGS
+ * @fqn wix.payments.disputes.v1.DisputeService.BulkUpdateDisputeTagsByFilter
+ */
+declare function bulkUpdateDisputeTagsByFilter(filter: Record<string, any>, options?: BulkUpdateDisputeTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdateDisputeTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateDisputeTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+
+export { type AcceptDisputeManuallyRequest, type AcceptDisputeManuallyResponse, type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DefendDisputeManuallyRequest, type DefendDisputeManuallyResponse, type DefendDisputeRequest, type DefendDisputeResponse, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, type DisputeCreatedEnvelope, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputeUpdatedEnvelope, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetDisputeRequest, type GetDisputeResponse, type IdentificationData, type IdentificationDataIdOneOf, type InternalChangeDisputeStatusManuallyRequest, type InternalChangeDisputeStatusManuallyResponse, type InternalCreateDisputeManuallyRequest, type InternalCreateDisputeManuallyResponse, type ItemMetadata, type MessageEnvelope, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitDisputeEvidenceRequest, type SubmitDisputeEvidenceResponse, type TagList, type Tags, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, defendDispute, getDispute, onDisputeCreated, onDisputeUpdated, queryDisputes };