@wix/auto_sdk_payments_dispute-history-records 1.0.0

package/build/internal/es/src/payments-dispute-history-records-v1-dispute-history-record-dispute-history-records.universal.d.ts

@@ -0,0 +1,506 @@
+/** A DisputeHistoryRecord */
+export interface DisputeHistoryRecord {
+    /**
+     * DisputeHistoryRecord ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Revision number
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the DisputeHistoryRecord was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the DisputeHistoryRecord was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Dispute ID */
+    disputeId?: string;
+    /** Dispute stage (RFI, Chargeback, so on) */
+    stage?: DisputeStage;
+    /** Dispute Status */
+    status?: DisputeStatus;
+    /**
+     * Due Date
+     * @readonly
+     */
+    dueDate?: Date | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+export declare enum DisputeStage {
+    UNKNOWN_DISPUTE_TYPE = "UNKNOWN_DISPUTE_TYPE",
+    /** Notification of Fraud, Pre-chargeback, Early Fraud Warning */
+    NOTIFICATION_OF_FRAUD = "NOTIFICATION_OF_FRAUD",
+    /** Request for Information / Inquiry */
+    RFI = "RFI",
+    /** Chargeback */
+    CHARGEBACK = "CHARGEBACK"
+}
+export 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"
+}
+export 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"]
+ * }
+ * }
+ * }
+ */
+export interface Tags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+export interface TagList {
+    /** List of tag IDs */
+    tagIds?: string[];
+}
+export interface GetDisputeHistoryRecordRequest {
+    /** ID of the DisputeHistoryRecord to retrieve. */
+    disputeHistoryRecordId: string;
+}
+export interface GetDisputeHistoryRecordResponse {
+    /** The requested DisputeHistoryRecord. */
+    disputeHistoryRecord?: DisputeHistoryRecord;
+}
+export interface QueryDisputeHistoryRecordsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+export 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"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export 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;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface QueryDisputeHistoryRecordsResponse {
+    /** List of DisputeHistoryRecords. */
+    disputeHistoryRecords?: DisputeHistoryRecord[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export 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;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface Empty {
+}
+export interface BulkUpdateDisputeHistoryRecordTagsRequest {
+    /** List of NileProtoTagsEntities that their tags will update. */
+    ids: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateDisputeHistoryRecordTagsResponse {
+    /** Results */
+    results?: BulkUpdateDisputeHistoryRecordTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _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;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkUpdateDisputeHistoryRecordTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+export 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;
+}
+export interface BulkUpdateDisputeHistoryRecordTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateDisputeHistoryRecordTagsByFilterResponse {
+    /** Job ID */
+    jobId?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface TagListNonNullableFields {
+    tagIds: string[];
+}
+interface TagsNonNullableFields {
+    tags?: TagListNonNullableFields;
+}
+export interface DisputeHistoryRecordNonNullableFields {
+    _id: string;
+    disputeId: string;
+    stage: DisputeStage;
+    status: DisputeStatus;
+    tags?: TagsNonNullableFields;
+}
+export interface GetDisputeHistoryRecordResponseNonNullableFields {
+    disputeHistoryRecord?: DisputeHistoryRecordNonNullableFields;
+}
+export interface QueryDisputeHistoryRecordsResponseNonNullableFields {
+    disputeHistoryRecords: DisputeHistoryRecordNonNullableFields[];
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkUpdateDisputeHistoryRecordTagsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkUpdateDisputeHistoryRecordTagsResponseNonNullableFields {
+    results: BulkUpdateDisputeHistoryRecordTagsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkUpdateDisputeHistoryRecordTagsByFilterResponseNonNullableFields {
+    jobId: string;
+}
+/**
+ * Retrieves a DisputeHistoryRecord.
+ * @param disputeHistoryRecordId - ID of the DisputeHistoryRecord to retrieve.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField disputeHistoryRecordId
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_READ
+ * @returns The requested DisputeHistoryRecord.
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.GetDisputeHistoryRecord
+ */
+export declare function getDisputeHistoryRecord(disputeHistoryRecordId: string): Promise<DisputeHistoryRecord & DisputeHistoryRecordNonNullableFields>;
+/**
+ * Retrieves a list of DisputeHistoryRecords, given the provided [paging, filtering, and sorting][1].
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_READ
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.QueryDisputeHistoryRecords
+ */
+export declare function queryDisputeHistoryRecords(): DisputeHistoryRecordsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface DisputeHistoryRecordsQueryResult extends QueryCursorResult {
+    items: DisputeHistoryRecord[];
+    query: DisputeHistoryRecordsQueryBuilder;
+    next: () => Promise<DisputeHistoryRecordsQueryResult>;
+    prev: () => Promise<DisputeHistoryRecordsQueryResult>;
+}
+export 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 `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 update tags on multiple products, by list of product ids
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
+ * @param ids - List of NileProtoTagsEntities that their tags will update.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_UPDATE_TAGS
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.BulkUpdateDisputeHistoryRecordTags
+ */
+export declare function bulkUpdateDisputeHistoryRecordTags(ids: string[], options?: BulkUpdateDisputeHistoryRecordTagsOptions): Promise<BulkUpdateDisputeHistoryRecordTagsResponse & BulkUpdateDisputeHistoryRecordTagsResponseNonNullableFields>;
+export interface BulkUpdateDisputeHistoryRecordTagsOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+/**
+ * Asynchronously update tags on multiple products, by provided filter
+ * An empty filter will update all products
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
+ * @param filter - Filter
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId PAYMENTS.DISPUTE_HISTORY_RECORD_UPDATE_TAGS
+ * @fqn wix.payments.dispute_history_records.v1.DisputeHistoryRecordService.BulkUpdateDisputeHistoryRecordTagsByFilter
+ */
+export declare function bulkUpdateDisputeHistoryRecordTagsByFilter(filter: Record<string, any> | null, options?: BulkUpdateDisputeHistoryRecordTagsByFilterOptions): Promise<BulkUpdateDisputeHistoryRecordTagsByFilterResponse & BulkUpdateDisputeHistoryRecordTagsByFilterResponseNonNullableFields>;
+export interface BulkUpdateDisputeHistoryRecordTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export {};