@wix/auto_sdk_comments_ratings 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,521 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface V1CommentResourceRating extends V1CommentResourceRatingOwnerOneOf {
+    /**
+     * Visitor Id
+     * @readonly
+     */
+    visitorId?: string | null;
+    /**
+     * Member Id
+     * @readonly
+     */
+    memberId?: string | null;
+    /**
+     * @readonly
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Rating Context */
+    ratingContext?: RatingContext;
+    /** Resource Id */
+    resourceId?: string | null;
+    /**
+     * Rating Value
+     * @min 1
+     * @max 5
+     */
+    rating?: number | null;
+    /** Published comments count */
+    publishedCommentCount?: number;
+}
+/** @oneof */
+interface V1CommentResourceRatingOwnerOneOf {
+    /**
+     * Visitor Id
+     * @readonly
+     */
+    visitorId?: string | null;
+    /**
+     * Member Id
+     * @readonly
+     */
+    memberId?: string | null;
+}
+interface RatingContext {
+    /**
+     * Context Application Definition Id
+     * @format GUID
+     */
+    appDefId?: string | null;
+    /** Context Id */
+    contextId?: string | null;
+    /** Context Type */
+    contextType?: string | null;
+}
+interface CommentResourceRatingChanged {
+    /** Resource rating */
+    resourceRating?: V1CommentResourceRating;
+}
+interface CommentResourceRatingDeleted {
+    /** resource rating */
+    resourceRating?: V1CommentResourceRating;
+}
+interface V1CreateRatingRequest {
+    /** Resource rating to be created or updated */
+    resourceRating?: V1CommentResourceRating;
+}
+interface V1CreateRatingResponse {
+    /** Created/Updated resource rating */
+    resourceRating?: V1CommentResourceRating;
+}
+interface RemoveMyRatingRequest {
+    /** Rating context */
+    ratingContext?: RatingContext;
+    /** Resource Id */
+    resourceId: string | null;
+}
+interface RemoveMyRatingResponse {
+}
+interface V1GetMyRatingRequest {
+    /** Rating context */
+    ratingContext?: RatingContext;
+    /** Resource Id */
+    resourceId: string | null;
+}
+interface V1GetMyRatingResponse {
+    /** Current member/visitor resource rating */
+    resourceRating?: V1CommentResourceRating;
+}
+interface GetResourceSummaryRequest {
+    /** Rating context */
+    ratingContext?: RatingContext;
+    /** Resource Id */
+    resourceId: string | null;
+}
+interface GetResourceSummaryResponse {
+    /** Average rating score */
+    average?: number;
+    /** Total amount of ratings */
+    total?: number;
+    /** Breakdown of how many of each rating is there */
+    breakdown?: Record<number, number>;
+}
+interface MoveRatingRequest {
+    /** Context for the comment that is being moved */
+    moveContext?: MoveContext;
+    /** New resourceId to which the comment is being moved to */
+    newResourceId?: string;
+    /** New contextId to which the comment is being moved to */
+    newContextId?: string;
+}
+interface MoveContext {
+    /**
+     * Comment ID
+     * @format GUID
+     */
+    commentId?: string;
+    /**
+     * MetaSite ID
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /**
+     * App ID
+     * @format GUID
+     */
+    appDefId?: string;
+    /**
+     * Context ID
+     * @maxLength 300
+     */
+    contextId?: string;
+    /**
+     * Context type
+     * @maxLength 300
+     */
+    contextType?: string;
+    /**
+     * Resource ID
+     * @maxLength 128
+     */
+    resourceId?: string;
+    /** Member ID */
+    memberId?: string | null;
+    /** Visitor ID */
+    visitorId?: string | null;
+}
+interface MoveRatingResponse {
+    /** Moved resource rating */
+    resourceRating?: V1CommentResourceRating;
+}
+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 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 CommentResourceRating extends CommentResourceRatingOwnerOneOf {
+    visitorId?: string | null;
+    memberId?: string | null;
+    /**
+     * @readonly
+     * @format GUID
+     */
+    _id?: string | null;
+    /** @format GUID */
+    appDefId?: string | null;
+    resourceId?: string | null;
+    /**
+     * @min 1
+     * @max 5
+     */
+    rating?: number | null;
+}
+/** @oneof */
+interface CommentResourceRatingOwnerOneOf {
+    visitorId?: string | null;
+    memberId?: string | null;
+}
+interface CreateRatingRequest {
+    resourceRating?: CommentResourceRating;
+}
+interface CreateRatingResponse {
+    resourceRating?: CommentResourceRating;
+}
+interface GetMyRatingRequest {
+    /** @format GUID */
+    appDefId?: string | null;
+    resourceId?: string | null;
+}
+interface GetMyRatingResponse {
+    resourceRating?: CommentResourceRating;
+}
+/** @docsIgnore */
+type RemoveMyRatingApplicationErrors = {
+    code?: 'RATING_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetMyRatingApplicationErrors = {
+    code?: 'RATING_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+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 RatingCommentResourceRatingChangedEnvelope {
+    data: CommentResourceRatingChanged;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.comments.resource.v1.rating_comment_resource_rating_changed
+ * @serviceIdentifier wix.comments.ratings.v1.CommentsRatings
+ * @slug comment_resource_rating_changed
+ * @documentationMaturity preview
+ */
+declare function onRatingCommentResourceRatingChanged(handler: (event: RatingCommentResourceRatingChangedEnvelope) => void | Promise<void>): void;
+interface RatingCommentResourceRatingDeletedEnvelope {
+    data: CommentResourceRatingDeleted;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.comments.resource.v1.rating_comment_resource_rating_deleted
+ * @serviceIdentifier wix.comments.ratings.v1.CommentsRatings
+ * @slug comment_resource_rating_deleted
+ * @documentationMaturity preview
+ */
+declare function onRatingCommentResourceRatingDeleted(handler: (event: RatingCommentResourceRatingDeletedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates resource rating, if member/visitor has already created an rating it will be updated with provided value
+ * @param resourceId - Resource Id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.resourceRating.rating
+ * @requiredField options.resourceRating.ratingContext.appDefId
+ * @requiredField options.resourceRating.ratingContext.contextId
+ * @requiredField resourceId
+ * @fqn wix.comments.ratings.v1.CommentsRatings.CreateRating
+ */
+declare function createRating(resourceId: string, options?: NonNullablePaths<CreateRatingOptions, `resourceRating.rating` | `resourceRating.ratingContext.appDefId` | `resourceRating.ratingContext.contextId`, 4>): Promise<NonNullablePaths<V1CreateRatingResponse, `resourceRating.publishedCommentCount`, 3>>;
+interface CreateRatingOptions {
+    resourceRating?: {
+        /**
+         * Visitor Id
+         * @readonly
+         */
+        visitorId?: string | null;
+        /**
+         * Member Id
+         * @readonly
+         */
+        memberId?: string | null;
+        /**
+         * @readonly
+         * @format GUID
+         */
+        _id?: string | null;
+        /** Rating Context */
+        ratingContext?: RatingContext;
+        /**
+         * Rating Value
+         * @min 1
+         * @max 5
+         */
+        rating?: number | null;
+        /** Published comments count */
+        publishedCommentCount?: number;
+    };
+}
+/**
+ * Removes rating for current caller
+ * @param resourceId - Resource Id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.ratingContext.appDefId
+ * @requiredField options.ratingContext.contextId
+ * @requiredField resourceId
+ * @fqn wix.comments.ratings.v1.CommentsRatings.RemoveMyRating
+ */
+declare function removeMyRating(resourceId: string, options?: NonNullablePaths<RemoveMyRatingOptions, `ratingContext.appDefId` | `ratingContext.contextId`, 3>): Promise<void & {
+    __applicationErrorsType?: RemoveMyRatingApplicationErrors;
+}>;
+interface RemoveMyRatingOptions {
+    /** Rating context */
+    ratingContext?: RatingContext;
+}
+/**
+ * Returns rating for current caller
+ * @param resourceId - Resource Id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.ratingContext.appDefId
+ * @requiredField options.ratingContext.contextId
+ * @requiredField resourceId
+ * @fqn wix.comments.ratings.v1.CommentsRatings.GetMyRating
+ */
+declare function getMyRating(resourceId: string, options?: NonNullablePaths<GetMyRatingOptions, `ratingContext.appDefId` | `ratingContext.contextId`, 3>): Promise<NonNullablePaths<V1GetMyRatingResponse, `resourceRating.publishedCommentCount`, 3> & {
+    __applicationErrorsType?: GetMyRatingApplicationErrors;
+}>;
+interface GetMyRatingOptions {
+    /** Rating context */
+    ratingContext?: RatingContext;
+}
+/** @param resourceId - Resource Id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.ratingContext.appDefId
+ * @requiredField options.ratingContext.contextId
+ * @requiredField resourceId
+ * @fqn wix.comments.ratings.v1.CommentsRatings.GetResourceSummary
+ */
+declare function getResourceSummary(resourceId: string, options?: NonNullablePaths<GetResourceSummaryOptions, `ratingContext.appDefId` | `ratingContext.contextId`, 3>): Promise<NonNullablePaths<GetResourceSummaryResponse, `average` | `total`, 2>>;
+interface GetResourceSummaryOptions {
+    /** Rating context */
+    ratingContext?: RatingContext;
+}
+
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type BaseEventMetadata, type CommentResourceRating, type CommentResourceRatingChanged, type CommentResourceRatingDeleted, type CommentResourceRatingOwnerOneOf, type CreateRatingOptions, type CreateRatingRequest, type CreateRatingResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetMyRatingApplicationErrors, type GetMyRatingOptions, type GetMyRatingRequest, type GetMyRatingResponse, type GetResourceSummaryOptions, type GetResourceSummaryRequest, type GetResourceSummaryResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type MoveContext, type MoveRatingRequest, type MoveRatingResponse, type RatingCommentResourceRatingChangedEnvelope, type RatingCommentResourceRatingDeletedEnvelope, type RatingContext, type RemoveMyRatingApplicationErrors, type RemoveMyRatingOptions, type RemoveMyRatingRequest, type RemoveMyRatingResponse, type RestoreInfo, type V1CommentResourceRating, type V1CommentResourceRatingOwnerOneOf, type V1CreateRatingRequest, type V1CreateRatingResponse, type V1GetMyRatingRequest, type V1GetMyRatingResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createRating, getMyRating, getResourceSummary, onRatingCommentResourceRatingChanged, onRatingCommentResourceRatingDeleted, removeMyRating };