@wix/auto_sdk_feedback_comments 1.0.1 → 1.0.2

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

@@ -1,8 +1,7 @@
-import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { Comment, CursorQuery, QueryCommentsResponse, StatusWithLiterals, UpdateCommentStatusOptions, UpdateCommentStatusResponse, CommentReply, CreateCommentReplyOptions, CreateCommentReplyResponse, UpdateCommentReplyIdentifiers, UpdateCommentReplyOptions, UpdateCommentReplyResponse, DeleteCommentReplyIdentifiers, DeleteCommentReplyResponse } from './index.typings.mjs';
-export { AccountInfo, ActionEvent, Breakpoint, CommentLocation, CreateCommentReplyRequest, CreateCommentRequest, CreateCommentResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DeleteCommentReplyRequest, DeleteCommentRequest, DeleteCommentResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetCommentRequest, GetCommentResponse, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, Position, QueryCommentsRequest, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Status, UpdateCommentReplyRequest, UpdateCommentRequest, UpdateCommentResponse, UpdateCommentStatusRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Comment, CursorQuery, QueryCommentsResponse, StatusWithLiterals, UpdateCommentStatusOptions, UpdateCommentStatusResponse, CommentReply, CreateCommentReplyOptions, CreateCommentReplyResponse, UpdateCommentReplyIdentifiers, UpdateCommentReplyOptions, UpdateCommentReplyResponse, DeleteCommentReplyIdentifiers, DeleteCommentReplyResponse, CommentCreatedEnvelope, CommentDeletedEnvelope, CommentUpdatedEnvelope } from './index.typings.mjs';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, Breakpoint, CommentLocation, CreateCommentReplyRequest, CreateCommentRequest, CreateCommentResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DeleteCommentReplyRequest, DeleteCommentRequest, DeleteCommentResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetCommentRequest, GetCommentResponse, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, Position, QueryCommentsRequest, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Status, UpdateCommentReplyRequest, UpdateCommentRequest, UpdateCommentResponse, UpdateCommentStatusRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
 
-/** @internal */
 declare function getComment$1(httpClient: HttpClient): GetCommentSignature;
 interface GetCommentSignature {
     /**
@@ -12,7 +11,6 @@ interface GetCommentSignature {
      */
     (commentId: string): Promise<NonNullablePaths<Comment, `_id` | `feedbackId` | `metaSiteId` | `commenterId` | `message` | `status` | `commentLocation.pageId` | `commentLocation.x` | `commentLocation.y` | `commentLocation.breakpoint._id` | `commentLocation.breakpoint.minWidth` | `commentLocation.breakpoint.maxWidth` | `commentLocation.innerPath` | `commentLocation.position.selector` | `commentLocation.position.offsetXPct` | `commentLocation.position.offsetYPct` | `commentLocation.position.innerPath` | `replies` | `replies.${number}.replierId` | `replies.${number}.message`, 2>>;
 }
-/** @internal */
 declare function queryComments$1(httpClient: HttpClient): QueryCommentsSignature;
 interface QueryCommentsSignature {
     /**
@@ -28,7 +26,6 @@ interface QueryCommentsSignature {
      */
     (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>>;
 }
-/** @internal */
 declare function updateCommentStatus$1(httpClient: HttpClient): UpdateCommentStatusSignature;
 interface UpdateCommentStatusSignature {
     /**
@@ -45,7 +42,6 @@ interface UpdateCommentStatusSignature {
      */
     (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>>;
 }
-/** @internal */
 declare function deleteComment$1(httpClient: HttpClient): DeleteCommentSignature;
 interface DeleteCommentSignature {
     /**
@@ -56,7 +52,6 @@ interface DeleteCommentSignature {
      */
     (commentId: string): Promise<void>;
 }
-/** @internal */
 declare function createCommentReply$1(httpClient: HttpClient): CreateCommentReplySignature;
 interface CreateCommentReplySignature {
     /**
@@ -69,7 +64,6 @@ interface CreateCommentReplySignature {
      */
     (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>>;
 }
-/** @internal */
 declare function updateCommentReply$1(httpClient: HttpClient): UpdateCommentReplySignature;
 interface UpdateCommentReplySignature {
     /**
@@ -82,7 +76,6 @@ interface UpdateCommentReplySignature {
      */
     (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>>;
 }
-/** @internal */
 declare function deleteCommentReply$1(httpClient: HttpClient): DeleteCommentReplySignature;
 interface DeleteCommentReplySignature {
     /**
@@ -97,20 +90,22 @@ interface DeleteCommentReplySignature {
      */
     (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>>;
 }
+declare const onCommentCreated$1: EventDefinition<CommentCreatedEnvelope, "wix.partners.feedback.v1.comment_created">;
+declare const onCommentDeleted$1: EventDefinition<CommentDeletedEnvelope, "wix.partners.feedback.v1.comment_deleted">;
+declare const onCommentUpdated$1: EventDefinition<CommentUpdatedEnvelope, "wix.partners.feedback.v1.comment_updated">;
 
-/** @internal */
 declare const getComment: MaybeContext<BuildRESTFunction<typeof getComment$1> & typeof getComment$1>;
-/** @internal */
 declare const queryComments: MaybeContext<BuildRESTFunction<typeof queryComments$1> & typeof queryComments$1>;
-/** @internal */
 declare const updateCommentStatus: MaybeContext<BuildRESTFunction<typeof updateCommentStatus$1> & typeof updateCommentStatus$1>;
-/** @internal */
 declare const deleteComment: MaybeContext<BuildRESTFunction<typeof deleteComment$1> & typeof deleteComment$1>;
-/** @internal */
 declare const createCommentReply: MaybeContext<BuildRESTFunction<typeof createCommentReply$1> & typeof createCommentReply$1>;
-/** @internal */
 declare const updateCommentReply: MaybeContext<BuildRESTFunction<typeof updateCommentReply$1> & typeof updateCommentReply$1>;
-/** @internal */
 declare const deleteCommentReply: MaybeContext<BuildRESTFunction<typeof deleteCommentReply$1> & typeof deleteCommentReply$1>;
+/** */
+declare const onCommentCreated: BuildEventDefinition<typeof onCommentCreated$1> & typeof onCommentCreated$1;
+/** */
+declare const onCommentDeleted: BuildEventDefinition<typeof onCommentDeleted$1> & typeof onCommentDeleted$1;
+/** */
+declare const onCommentUpdated: BuildEventDefinition<typeof onCommentUpdated$1> & typeof onCommentUpdated$1;
 
-export { Comment, CommentReply, CreateCommentReplyOptions, CreateCommentReplyResponse, CursorQuery, DeleteCommentReplyIdentifiers, DeleteCommentReplyResponse, QueryCommentsResponse, StatusWithLiterals, UpdateCommentReplyIdentifiers, UpdateCommentReplyOptions, UpdateCommentReplyResponse, UpdateCommentStatusOptions, UpdateCommentStatusResponse, createCommentReply, deleteComment, deleteCommentReply, getComment, queryComments, updateCommentReply, updateCommentStatus };
+export { Comment, CommentCreatedEnvelope, CommentDeletedEnvelope, CommentReply, CommentUpdatedEnvelope, CreateCommentReplyOptions, CreateCommentReplyResponse, CursorQuery, DeleteCommentReplyIdentifiers, DeleteCommentReplyResponse, QueryCommentsResponse, StatusWithLiterals, UpdateCommentReplyIdentifiers, UpdateCommentReplyOptions, UpdateCommentReplyResponse, UpdateCommentStatusOptions, UpdateCommentStatusResponse, createCommentReply, deleteComment, deleteCommentReply, getComment, onCommentCreated, onCommentDeleted, onCommentUpdated, queryComments, updateCommentReply, updateCommentStatus };

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

@@ -527,10 +527,100 @@ 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
@@ -549,7 +639,7 @@ 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
@@ -568,7 +658,7 @@ 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
@@ -588,7 +678,7 @@ 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
@@ -603,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
@@ -626,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
@@ -661,7 +751,7 @@ 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
@@ -682,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/package.json

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