@wix/auto_sdk_payments_dispute-history-records 1.0.14 → 1.0.16

package/build/cjs/index.d.ts

@@ -1 +1,549 @@
-export * from './src/payments-dispute-history-records-v1-dispute-history-record-dispute-history-records.context.js';
+/** A DisputeHistoryRecord */
+interface DisputeHistoryRecord {
+    /**
+     * DisputeHistoryRecord ID.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    _id?: string | null;
+    /**
+     * Revision number
+     * @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;
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    disputeId?: string;
+    /**
+     * Dispute stage (RFI, Chargeback, so on)
+     * @readonly
+     * @immutable
+     */
+    stage?: DisputeStageWithLiterals;
+    /**
+     * Dispute Status
+     * @readonly
+     * @immutable
+     */
+    status?: DisputeStatusWithLiterals;
+    /**
+     * Due Date
+     * @readonly
+     * @immutable
+     */
+    dueDate?: Date | null;
+    /**
+     * Charge ID
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    chargeId?: string;
+    /**
+     * Dispute Channel
+     * Internal - this dispute is created on provider side
+     * External - this dispute is created on bank side
+     * @readonly
+     * @immutable
+     */
+    channel?: DisputeChannelWithLiterals;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+declare enum DisputeStage {
+    UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
+    /** Notification of Fraud, Pre-chargeback, Early Fraud Warning */
+    NOTIFICATION_OF_FRAUD = "NOTIFICATION_OF_FRAUD",
+    /** Request for Information / Inquiry */
+    RFI = "RFI",
+    /** Chargeback */
+    CHARGEBACK = "CHARGEBACK"
+}
+/** @enumType */
+type DisputeStageWithLiterals = DisputeStage | 'UNKNOWN_DISPUTE_STAGE' | 'NOTIFICATION_OF_FRAUD' | 'RFI' | 'CHARGEBACK';
+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 (internal channel) or Bank (external channel) */
+    UNDER_REVIEW = "UNDER_REVIEW",
+    /** Waiting for some buyer action */
+    WAITING_BUYER = "WAITING_BUYER",
+    /** Dispute won */
+    WON = "WON",
+    /** Dispute lost */
+    LOST = "LOST"
+}
+/** @enumType */
+type DisputeStatusWithLiterals = DisputeStatus | 'UNKNOWN_DISPUTE_STATUS' | 'WAITING_MERCHANT' | 'UNDER_REVIEW' | 'WAITING_BUYER' | 'WON' | 'LOST';
+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 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 {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface GetDisputeHistoryRecordRequest {
+    /**
+     * ID of the DisputeHistoryRecord to retrieve.
+     * @format GUID
+     */
+    disputeHistoryRecordId: string;
+}
+interface GetDisputeHistoryRecordResponse {
+    /** The requested DisputeHistoryRecord. */
+    disputeHistoryRecord?: DisputeHistoryRecord;
+}
+interface QueryDisputeHistoryRecordsRequest {
+    /** 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 QueryDisputeHistoryRecordsResponse {
+    /** List of DisputeHistoryRecords. */
+    disputeHistoryRecords?: DisputeHistoryRecord[];
+    /** 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 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 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 BulkUpdateDisputeHistoryRecordTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateDisputeHistoryRecordTagsResult[];
+    /** 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 BulkUpdateDisputeHistoryRecordTagsResult {
+    /** 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 BulkUpdateDisputeHistoryRecordTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeHistoryRecordTagsByFilterResponse {
+    /**
+     * Job ID
+     * @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';
+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>;
+}
+interface BulkUpdateDisputeHistoryRecordTagsOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeHistoryRecordTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+
+export { type ActionEvent, type ApplicationError, type BulkActionMetadata, 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 DisputeHistoryRecord, type DisputeHistoryRecordsQueryBuilder, type DisputeHistoryRecordsQueryResult, DisputeStage, DisputeStatus, 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 Sorting, type TagList, type Tags, WebhookIdentityType };