@wix/auto_sdk_feedback_comments 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,547 @@
+/**
+ * A Comment is a note left on a specific location of a site page as part of a feedback session.
+ *
+ * Site visitors leave comments while reviewing a site; the site owner reads them, triages them by
+ * `status`, replies to them, and deletes them.
+ */
+interface Comment {
+    /**
+     * Comment ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Revision number, which increments by 1 each time the Comment is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the Comment.
+     *
+     * Ignored when creating a Comment.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Comment was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Comment was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * ID of the feedback session the Comment belongs to.
+     * @format GUID
+     * @readonly
+     */
+    feedbackId?: string;
+    /**
+     * ID of the site the Comment was left on.
+     * @format GUID
+     * @readonly
+     */
+    metaSiteId?: string;
+    /**
+     * ID of the Wix user or site visitor who left the Comment.
+     * @format GUID
+     * @readonly
+     */
+    commenterId?: string;
+    /**
+     * Text of the Comment.
+     * @minLength 2
+     * @maxLength 2000
+     */
+    message?: string;
+    /**
+     * Triage status of the Comment.
+     *
+     * Read-only: the site owner changes it with Update Comment Status, and no other flow may set it.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /** Where on the page the Comment is anchored. */
+    commentLocation?: CommentLocation;
+    /**
+     * Replies to the Comment, ordered oldest first.
+     *
+     * A reply is addressed by its index in this list, so indexes shift when a reply is deleted.
+     * Pass the Comment's current `revision` when updating or deleting a reply to be sure the index
+     * you're addressing is still the one you read.
+     * @readonly
+     * @maxSize 1000
+     */
+    replies?: CommentReply[];
+}
+/** Triage status of a comment. */
+declare enum Status {
+    /** The comment hasn't been read yet. */
+    NEW = "NEW",
+    /** The comment has been read but isn't resolved. */
+    OPEN = "OPEN",
+    /** The comment has been dealt with. */
+    RESOLVED = "RESOLVED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'NEW' | 'OPEN' | 'RESOLVED';
+/** Where on a site page a Comment is anchored. */
+interface CommentLocation {
+    /**
+     * ID of the editor page the Comment was left on.
+     * @maxLength 100
+     */
+    pageId?: string;
+    /** Horizontal position of the Comment on the page. */
+    x?: number;
+    /** Vertical position of the Comment on the page. */
+    y?: number;
+    /** Responsive-design breakpoint the Comment was left at. */
+    breakpoint?: Breakpoint;
+    /**
+     * Inner path of the Wix dynamic page the Comment was left on.
+     * @maxLength 2048
+     */
+    innerPath?: string;
+    /** Position of the Comment relative to the element it's attached to. */
+    position?: Position;
+}
+/** Responsive-design breakpoint a Comment was left at. */
+interface Breakpoint {
+    /**
+     * Breakpoint ID.
+     * @maxLength 100
+     */
+    _id?: string;
+    /** Lowest viewport width the breakpoint applies to, in pixels. */
+    minWidth?: number;
+    /** Highest viewport width the breakpoint applies to, in pixels. */
+    maxWidth?: number;
+}
+/** Position of a Comment relative to the page element it's attached to. */
+interface Position {
+    /**
+     * DOM selector of the target element.
+     * @maxLength 1024
+     */
+    selector?: string;
+    /** Horizontal offset within the element, as a percentage of its width. */
+    offsetXPct?: number;
+    /** Vertical offset within the element, as a percentage of its height. */
+    offsetYPct?: number;
+    /**
+     * Inner path of the Wix dynamic page the element is on.
+     * @maxLength 2048
+     */
+    innerPath?: string;
+}
+/** A reply to a Comment. */
+interface CommentReply {
+    /**
+     * ID of the Wix user or site visitor who wrote the reply.
+     * @format GUID
+     * @readonly
+     */
+    replierId?: string;
+    /**
+     * Text of the reply.
+     * @minLength 1
+     * @maxLength 2000
+     */
+    message?: string;
+    /**
+     * Date and time the reply was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+}
+interface GetCommentRequest {
+    /**
+     * ID of the Comment to retrieve.
+     * @format GUID
+     */
+    commentId: string;
+}
+interface GetCommentResponse {
+    /** The requested Comment. */
+    comment?: Comment;
+}
+interface QueryCommentsRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    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 QueryCommentsResponse {
+    /** The retrieved Comments. */
+    comments?: Comment[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    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 UpdateCommentStatusRequest {
+    /**
+     * ID of the Comment to triage.
+     * @format GUID
+     */
+    commentId: string;
+    /** Status to set on the Comment. */
+    status: StatusWithLiterals;
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface UpdateCommentStatusResponse {
+    /** The updated Comment. */
+    comment?: Comment;
+}
+interface DeleteCommentRequest {
+    /**
+     * ID of the Comment to delete.
+     * @format GUID
+     */
+    commentId: string;
+}
+interface DeleteCommentResponse {
+}
+interface CreateCommentReplyRequest {
+    /**
+     * ID of the Comment to reply to.
+     * @format GUID
+     */
+    commentId: string;
+    /** The reply to add. Only `message` is honored. */
+    reply: CommentReply;
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface CreateCommentReplyResponse {
+    /** The Comment, including the new reply. */
+    comment?: Comment;
+}
+interface UpdateCommentReplyRequest {
+    /**
+     * ID of the Comment the reply belongs to.
+     * @format GUID
+     */
+    commentId: string;
+    /** Position of the reply in the Comment's `replies` list. */
+    replyIndex: number;
+    /**
+     * New text for the reply.
+     * @minLength 1
+     * @maxLength 2000
+     */
+    message: string;
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface UpdateCommentReplyResponse {
+    /** The Comment, including the updated reply. */
+    comment?: Comment;
+}
+interface DeleteCommentReplyRequest {
+    /**
+     * ID of the Comment the reply belongs to.
+     * @format GUID
+     */
+    commentId: string;
+    /** Position of the reply in the Comment's `replies` list. */
+    replyIndex: number;
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface DeleteCommentReplyResponse {
+    /** The Comment, without the deleted reply. */
+    comment?: Comment;
+}
+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;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+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 AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface CreateCommentRequest {
+    /**
+     * ID of the feedback session to leave the Comment on.
+     * @format GUID
+     */
+    feedbackId?: string;
+    /** The Comment to leave. */
+    comment?: Comment;
+}
+interface CreateCommentResponse {
+    /** The created Comment. */
+    comment?: Comment;
+}
+interface UpdateCommentRequest {
+    /**
+     * The Comment to update, carrying its `id`, its current `revision`, and the new values for the
+     * fields named in `field_mask`.
+     */
+    comment?: Comment;
+}
+interface UpdateCommentResponse {
+    /** The updated Comment. */
+    comment?: Comment;
+}
+interface UpdateCommentStatusOptions {
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface CreateCommentReplyOptions {
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface UpdateCommentReplyIdentifiers {
+    /**
+     * ID of the Comment the reply belongs to.
+     * @format GUID
+     */
+    commentId: string;
+    /** Position of the reply in the Comment's `replies` list. */
+    replyIndex: number;
+}
+interface UpdateCommentReplyOptions {
+    /** Current revision of the Comment. */
+    revision: string | null;
+}
+interface DeleteCommentReplyIdentifiers {
+    /**
+     * ID of the Comment the reply belongs to.
+     * @format GUID
+     */
+    commentId: string;
+    /** Position of the reply in the Comment's `replies` list. */
+    replyIndex: number;
+}
+
+export { type AccountInfo, type ActionEvent, type Breakpoint, type Comment, type CommentLocation, type CommentReply, type CreateCommentReplyOptions, type CreateCommentReplyRequest, type CreateCommentReplyResponse, type CreateCommentRequest, type CreateCommentResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteCommentReplyIdentifiers, type DeleteCommentReplyRequest, type DeleteCommentReplyResponse, type DeleteCommentRequest, type DeleteCommentResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetCommentRequest, type GetCommentResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type Position, type QueryCommentsRequest, type QueryCommentsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type UpdateCommentReplyIdentifiers, type UpdateCommentReplyOptions, type UpdateCommentReplyRequest, type UpdateCommentReplyResponse, type UpdateCommentRequest, type UpdateCommentResponse, type UpdateCommentStatusOptions, type UpdateCommentStatusRequest, type UpdateCommentStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };