@wix/auto_sdk_feedback_comments 1.0.0 → 1.0.2

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

@@ -45,7 +45,7 @@ interface Comment {
      */
     metaSiteId?: string;
     /**
-     * ID of the Wix user or site visitor who left the Comment.
+     * ID of the site visitor who left the Comment.
      * @format GUID
      * @readonly
      */
@@ -146,7 +146,8 @@ interface Position {
 /** A reply to a Comment. */
 interface CommentReply {
     /**
-     * ID of the Wix user or site visitor who wrote the reply.
+     * ID of whoever wrote the reply: the site visitor who left the Comment, a user managing the site, or
+     * the app that replied on the site's behalf.
      * @format GUID
      * @readonly
      */
@@ -526,13 +527,104 @@ interface UpdateCommentResponse {
     /** The updated Comment. */
     comment?: Comment;
 }
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+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;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface CommentCreatedEnvelope {
+    entity: Comment;
+    metadata: EventMetadata;
+}
+/** @permissionId partners:feedback:v1:comment:read_events
+ * @webhook
+ * @eventType wix.partners.feedback.v1.comment_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onCommentCreated(handler: (event: CommentCreatedEnvelope) => void | Promise<void>): void;
+interface CommentDeletedEnvelope {
+    entity: Comment;
+    metadata: EventMetadata;
+}
+/** @permissionId partners:feedback:v1:comment:read_events
+ * @webhook
+ * @eventType wix.partners.feedback.v1.comment_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onCommentDeleted(handler: (event: CommentDeletedEnvelope) => void | Promise<void>): void;
+interface CommentUpdatedEnvelope {
+    entity: Comment;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/** @permissionId partners:feedback:v1:comment:read_events
+ * @webhook
+ * @eventType wix.partners.feedback.v1.comment_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onCommentUpdated(handler: (event: CommentUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * Retrieves a Comment.
  * @param commentId - ID of the Comment to retrieve.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField commentId
  * @permissionId partners:feedback:v1:comment:get_comment
+ * @applicableIdentity APP
  * @returns The requested Comment.
  * @fqn wix.partners.feedback.v1.Comments.GetComment
  */
@@ -547,10 +639,11 @@ declare function getComment(commentId: string): Promise<NonNullablePaths<Comment
  * [1]: https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging
  * [2]: https://dev.wix.com/docs/rest/articles/getting-started/api-query-language
  * @param query - Query options.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField query
  * @permissionId partners:feedback:v1:comment:query_comments
+ * @applicableIdentity APP
  * @fqn wix.partners.feedback.v1.Comments.QueryComments
  */
 declare function queryComments(query: CursorQuery): Promise<NonNullablePaths<QueryCommentsResponse, `comments` | `comments.${number}._id` | `comments.${number}.feedbackId` | `comments.${number}.metaSiteId` | `comments.${number}.commenterId` | `comments.${number}.message` | `comments.${number}.status` | `comments.${number}.commentLocation.pageId` | `comments.${number}.commentLocation.x` | `comments.${number}.commentLocation.y` | `comments.${number}.commentLocation.breakpoint._id` | `comments.${number}.commentLocation.breakpoint.minWidth` | `comments.${number}.commentLocation.breakpoint.maxWidth` | `comments.${number}.commentLocation.innerPath` | `comments.${number}.commentLocation.position.selector` | `comments.${number}.commentLocation.position.offsetXPct` | `comments.${number}.commentLocation.position.offsetYPct` | `comments.${number}.commentLocation.position.innerPath`, 4>>;
@@ -565,13 +658,14 @@ declare function queryComments(query: CursorQuery): Promise<NonNullablePaths<Que
  * overwrites.
  * @param commentId - ID of the Comment to triage.
  * @param status - Status to set on the Comment.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField commentId
  * @requiredField options
  * @requiredField options.revision
  * @requiredField status
  * @permissionId partners:feedback:v1:comment:update_comment_status
+ * @applicableIdentity APP
  * @fqn wix.partners.feedback.v1.Comments.UpdateCommentStatus
  */
 declare function updateCommentStatus(commentId: string, status: StatusWithLiterals, options: NonNullablePaths<UpdateCommentStatusOptions, `revision`, 0>): Promise<NonNullablePaths<UpdateCommentStatusResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
@@ -584,10 +678,11 @@ interface UpdateCommentStatusOptions {
  *
  * Deleting a Comment also deletes its replies.
  * @param commentId - ID of the Comment to delete.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField commentId
  * @permissionId partners:feedback:v1:comment:delete_comment
+ * @applicableIdentity APP
  * @fqn wix.partners.feedback.v1.Comments.DeleteComment
  */
 declare function deleteComment(commentId: string): Promise<void>;
@@ -598,7 +693,7 @@ declare function deleteComment(commentId: string): Promise<void>;
  * user identity.
  * @param commentId - ID of the Comment to reply to.
  * @param reply - The reply to add. Only `message` is honored.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField commentId
  * @requiredField options
@@ -606,6 +701,7 @@ declare function deleteComment(commentId: string): Promise<void>;
  * @requiredField reply
  * @requiredField reply.message
  * @permissionId partners:feedback:v1:comment:create_comment_reply
+ * @applicableIdentity APP
  * @fqn wix.partners.feedback.v1.Comments.CreateCommentReply
  */
 declare function createCommentReply(commentId: string, reply: NonNullablePaths<CommentReply, `message`, 0>, options: NonNullablePaths<CreateCommentReplyOptions, `revision`, 0>): Promise<NonNullablePaths<CreateCommentReplyResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
@@ -620,7 +716,7 @@ interface CreateCommentReplyOptions {
  * indexes shift when a reply is deleted, the Comment's current `revision` must be passed; a stale
  * `revision` is rejected rather than applied to whichever reply now sits at that index.
  * @param message - New text for the reply.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.commentId
@@ -629,6 +725,7 @@ interface CreateCommentReplyOptions {
  * @requiredField options
  * @requiredField options.revision
  * @permissionId partners:feedback:v1:comment:update_comment_reply
+ * @applicableIdentity APP
  * @fqn wix.partners.feedback.v1.Comments.UpdateCommentReply
  */
 declare function updateCommentReply(identifiers: NonNullablePaths<UpdateCommentReplyIdentifiers, `commentId` | `replyIndex`, 0>, message: string, options: NonNullablePaths<UpdateCommentReplyOptions, `revision`, 0>): Promise<NonNullablePaths<UpdateCommentReplyResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
@@ -654,13 +751,14 @@ interface UpdateCommentReplyOptions {
  * indexes shift when a reply is deleted, the Comment's current `revision` must be passed; a stale
  * `revision` is rejected rather than applied to whichever reply now sits at that index.
  * @param revision - Current revision of the Comment.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.commentId
  * @requiredField identifiers.replyIndex
  * @requiredField revision
  * @permissionId partners:feedback:v1:comment:delete_comment_reply
+ * @applicableIdentity APP
  * @fqn wix.partners.feedback.v1.Comments.DeleteCommentReply
  */
 declare function deleteCommentReply(identifiers: NonNullablePaths<DeleteCommentReplyIdentifiers, `commentId` | `replyIndex`, 0>, revision: string): Promise<NonNullablePaths<DeleteCommentReplyResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
@@ -674,4 +772,4 @@ interface DeleteCommentReplyIdentifiers {
     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, createCommentReply, deleteComment, deleteCommentReply, getComment, queryComments, updateCommentReply, updateCommentStatus };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type BaseEventMetadata, type Breakpoint, type Comment, type CommentCreatedEnvelope, type CommentDeletedEnvelope, type CommentLocation, type CommentReply, type CommentUpdatedEnvelope, 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 EventMetadata, 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, createCommentReply, deleteComment, deleteCommentReply, getComment, onCommentCreated, onCommentDeleted, onCommentUpdated, queryComments, updateCommentReply, updateCommentStatus };

package/build/internal/es/meta.d.mts

@@ -46,7 +46,7 @@ interface Comment {
      */
     metaSiteId?: string;
     /**
-     * ID of the Wix user or site visitor who left the Comment.
+     * ID of the site visitor who left the Comment.
      * @format GUID
      * @readonly
      */
@@ -147,7 +147,8 @@ interface Position {
 /** A reply to a Comment. */
 interface CommentReply {
     /**
-     * ID of the Wix user or site visitor who wrote the reply.
+     * ID of whoever wrote the reply: the site visitor who left the Comment, a user managing the site, or
+     * the app that replied on the site's behalf.
      * @format GUID
      * @readonly
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_feedback_comments",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.partners.feedback.v1.comment"
     }
   },
-  "falconPackageHash": "5bcdb29dc3b3b0a7eecd0bcce3f869e2fb75655ddc40b22c83614389"
+  "falconPackageHash": "50d854e74f152b188cb05d5695a80eec09865f0acbe5167623ab6842"
 }