@wix/auto_sdk_comments_votes 1.0.0

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

@@ -0,0 +1,938 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+/** An upvote or downvote cast by one identity on a resource in an app context. */
+interface Vote {
+    /**
+     * Vote resource ID
+     * @maxLength 128
+     */
+    resourceId?: string;
+    /**
+     * Resource fully qualified domain name
+     * @maxLength 300
+     */
+    resourceFqdn?: string;
+    /**
+     * Vote ID
+     * @format GUID
+     * @readonly
+     */
+    voteId?: string;
+    /**
+     * Type of vote
+     * @readonly
+     */
+    type?: TypeWithLiterals;
+    /**
+     * Vote author
+     * @readonly
+     */
+    createdBy?: SocialIdentity;
+    /**
+     * Vote created date
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Vote updated date
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Vote context, defining where the vote belongs to */
+    context?: VoteContext;
+    /**
+     * Vote revision
+     * @readonly
+     */
+    revision?: string;
+}
+/** Type of vote */
+declare enum Type {
+    UNKNOWN = "UNKNOWN",
+    UPVOTE = "UPVOTE",
+    DOWNVOTE = "DOWNVOTE"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN' | 'UPVOTE' | 'DOWNVOTE';
+interface SocialIdentity {
+    /** @format GUID */
+    identityId?: string;
+    identityType?: IdentityTypeWithLiterals;
+}
+declare enum IdentityType {
+    ANONYMOUS = "ANONYMOUS",
+    MEMBER = "MEMBER",
+    USER = "USER",
+    SERVICE = "SERVICE",
+    /** indicates everyone who is a member of a group */
+    MEMBER_GROUP = "MEMBER_GROUP"
+}
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'ANONYMOUS' | 'MEMBER' | 'USER' | 'SERVICE' | 'MEMBER_GROUP';
+interface VoteContext {
+    /**
+     * Context ID
+     * @maxLength 128
+     */
+    contextId?: string;
+    /** Context type */
+    contextType?: string | null;
+    /**
+     * Vote app ID
+     * @format GUID
+     * @readonly
+     */
+    appDefId?: string;
+    /**
+     * MetaSite ID
+     * @format GUID
+     * @readonly
+     */
+    metaSiteId?: string;
+}
+interface UpvoteRequest {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /**
+     * resource identifier for vote be cast on
+     * @maxLength 128
+     */
+    resourceId: string;
+    /**
+     * resource name
+     * @maxLength 300
+     */
+    resourceFqdn: string;
+    /** context data */
+    contextData?: ContextData;
+}
+/**
+ * Identifies the app and context containing the resource.
+ * When provided, contextData takes precedence over the deprecated contextToken.
+ */
+interface ContextData {
+    /**
+     * ID of the app that owns the context.
+     * @format GUID
+     */
+    appDefId?: string;
+    /**
+     * ID of the context containing the resource.
+     * @maxLength 128
+     */
+    contextId?: string;
+    /** Optional type used by the app to resolve its context. */
+    contextType?: string | null;
+}
+interface UpvoteResponse {
+    /** created vote */
+    vote?: Vote;
+}
+interface ContextResourceVoteChange {
+    /**
+     * Resource ID
+     * @maxLength 128
+     */
+    resourceId?: string;
+    /**
+     * Resource fully qualified domain name
+     * @maxLength 300
+     */
+    resourceFqdn?: string;
+    /** Score of votes */
+    score?: number;
+    /** Upvote count */
+    upvoteCount?: number;
+    /** Downvote count */
+    downvoteCount?: number;
+    /** Vote context */
+    context?: VoteContext;
+}
+interface VoteCast {
+    /** Vote */
+    vote?: Vote;
+}
+interface DownvoteRequest {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /**
+     * resource identifier for vote be cast on
+     * @maxLength 128
+     */
+    resourceId: string;
+    /**
+     * resource name
+     * @maxLength 300
+     */
+    resourceFqdn: string;
+    /** context data */
+    contextData?: ContextData;
+}
+interface DownvoteResponse {
+    /** created vote */
+    vote?: Vote;
+}
+interface UpdateVoteRequest {
+    /** vote to be updated, may be partial and include only VoteId and the field to change */
+    vote?: Vote;
+    /**
+     * explicit list of fields to update
+     * @internal
+     */
+    fieldMask?: string[];
+}
+interface UpdateVoteResponse {
+    /** updated vote */
+    vote?: Vote;
+}
+interface RemoveVoteRequest {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /** id of the vote which will be deleted */
+    voteId: string;
+    /** context data */
+    contextData?: ContextData;
+}
+interface RemoveVoteResponse {
+    /** removed vote */
+    vote?: Vote;
+}
+interface VoteDeleted {
+    /** Vote */
+    vote?: Vote;
+}
+interface QueryVotesRequest {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /** query request. Filter supports only "resourceId" field. Fields and Fieldset are not supported */
+    query?: QueryV2;
+    /** context data */
+    contextData?: ContextData;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** 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.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** 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;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
+    /**
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     */
+    origin?: AddressLocation;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+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 QueryVotesResponse {
+    /** matching votes */
+    votes?: Vote[];
+    /** paging metadata. Only contains cursors */
+    paging?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
+     */
+    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 GetResourceVoteSummaryRequest {
+    /** appDef ID */
+    appDefId?: string;
+    /** context ID */
+    contextId?: string;
+    /** resource ID */
+    resourceId?: string;
+}
+interface GetResourceVoteSummaryResponse {
+    /** Resource vote summary */
+    summary?: ResourceVoteSummary;
+}
+interface ResourceVoteSummary {
+    /** vote context */
+    context?: VoteContext;
+    /** resource ID */
+    resourceId?: string;
+    /** vote score */
+    score?: number;
+    /** upvote count */
+    upvoteCount?: number;
+    /** downvote count */
+    downvoteCount?: number;
+}
+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 ImportVoteRequest {
+    /** metaSite ID */
+    metaSiteId?: string;
+    /** vote to import */
+    vote?: ImportVote;
+}
+interface ImportVote {
+    /**
+     * Resource ID
+     * @maxLength 128
+     */
+    resourceId?: string;
+    /**
+     * Resource fully qualified domain name
+     * @maxLength 300
+     */
+    resourceFqdn?: string;
+    /**
+     * Vote ID
+     * @format GUID
+     */
+    voteId?: string;
+    /** Type of vote */
+    type?: TypeWithLiterals;
+    /** Vote author */
+    createdBy?: SocialIdentity;
+    /** Vote creation date */
+    _createdDate?: Date | null;
+    /** Vote update date */
+    _updatedDate?: Date | null;
+    /** Vote context */
+    context?: VoteContext;
+}
+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;
+}
+/** @docsIgnore */
+type UpvoteApplicationErrors = {
+    code?: 'MISSING_METASITE_CONTEXT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PERMISSION_DENIED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type DownvoteApplicationErrors = {
+    code?: 'MISSING_METASITE_CONTEXT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PERMISSION_DENIED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type RemoveVoteApplicationErrors = {
+    code?: 'MISSING_METASITE_CONTEXT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PERMISSION_DENIED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'VOTE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type QueryVotesApplicationErrors = {
+    code?: 'MISSING_METASITE_CONTEXT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PERMISSION_DENIED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'UNSUPPORTED_FILTER_FIELDS';
+    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 VoteContextResourceVoteChangeEnvelope {
+    data: ContextResourceVoteChange;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.comments.v1.vote_context_resource_vote_change
+ * @serviceIdentifier com.wixpress.comments.Votes
+ * @slug context_resource_vote_change
+ * @documentationMaturity preview
+ */
+declare function onVoteContextResourceVoteChange(handler: (event: VoteContextResourceVoteChangeEnvelope) => void | Promise<void>): void;
+interface VoteCastEnvelope {
+    data: VoteCast;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.comments.v1.vote_vote_cast
+ * @serviceIdentifier com.wixpress.comments.Votes
+ * @slug vote_cast
+ * @documentationMaturity preview
+ */
+declare function onVoteCast(handler: (event: VoteCastEnvelope) => void | Promise<void>): void;
+interface VoteDeletedEnvelope {
+    data: VoteDeleted;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.comments.v1.vote_vote_deleted
+ * @serviceIdentifier com.wixpress.comments.Votes
+ * @slug vote_deleted
+ * @documentationMaturity preview
+ */
+declare function onVoteDeleted(handler: (event: VoteDeletedEnvelope) => void | Promise<void>): void;
+/**
+ * Casts an upvote on a resource for the current identity.
+ * Changes an existing downvote to an upvote. Repeating an upvote does not remove it.
+ * Provide contextData for the app and context. Context voting permissions apply.
+ * Authorization is enforced by the service for the current identity and context.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.resourceFqdn
+ * @requiredField options.resourceId
+ * @fqn com.wixpress.comments.Votes.Upvote
+ */
+declare function upvote(options?: NonNullablePaths<UpvoteOptions, `resourceFqdn` | `resourceId`, 2>): Promise<NonNullablePaths<UpvoteResponse, `vote.resourceId` | `vote.resourceFqdn` | `vote.voteId` | `vote.type` | `vote.createdBy.identityId` | `vote.createdBy.identityType` | `vote.context.contextId` | `vote.context.appDefId` | `vote.context.metaSiteId` | `vote.revision`, 4> & {
+    __applicationErrorsType?: UpvoteApplicationErrors;
+}>;
+interface UpvoteOptions {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /**
+     * resource identifier for vote be cast on
+     * @maxLength 128
+     */
+    resourceId: string;
+    /**
+     * resource name
+     * @maxLength 300
+     */
+    resourceFqdn: string;
+    /** context data */
+    contextData?: ContextData;
+}
+/**
+ * Casts a downvote on a resource for the current identity.
+ * Changes an existing upvote to a downvote. Use RemoveVote to clear a vote.
+ * Provide contextData for the app and context. Context voting permissions apply.
+ * Authorization is enforced by the service for the current identity and context.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.resourceFqdn
+ * @requiredField options.resourceId
+ * @fqn com.wixpress.comments.Votes.Downvote
+ */
+declare function downvote(options?: NonNullablePaths<DownvoteOptions, `resourceFqdn` | `resourceId`, 2>): Promise<NonNullablePaths<DownvoteResponse, `vote.resourceId` | `vote.resourceFqdn` | `vote.voteId` | `vote.type` | `vote.createdBy.identityId` | `vote.createdBy.identityType` | `vote.context.contextId` | `vote.context.appDefId` | `vote.context.metaSiteId` | `vote.revision`, 4> & {
+    __applicationErrorsType?: DownvoteApplicationErrors;
+}>;
+interface DownvoteOptions {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /**
+     * resource identifier for vote be cast on
+     * @maxLength 128
+     */
+    resourceId: string;
+    /**
+     * resource name
+     * @maxLength 300
+     */
+    resourceFqdn: string;
+    /** context data */
+    contextData?: ContextData;
+}
+/**
+ * Removes the current identity's vote in the specified context and returns it.
+ * Obtain voteId from a vote response or QueryVotes. A repeated removal can fail.
+ * Authorization is enforced by the service for the current identity and context.
+ * @param voteId - id of the vote which will be deleted
+ * @public
+ * @documentationMaturity preview
+ * @requiredField voteId
+ * @fqn com.wixpress.comments.Votes.RemoveVote
+ */
+declare function removeVote(voteId: string, options?: RemoveVoteOptions): Promise<NonNullablePaths<RemoveVoteResponse, `vote.resourceId` | `vote.resourceFqdn` | `vote.voteId` | `vote.type` | `vote.createdBy.identityId` | `vote.createdBy.identityType` | `vote.context.contextId` | `vote.context.appDefId` | `vote.context.metaSiteId` | `vote.revision`, 4> & {
+    __applicationErrorsType?: RemoveVoteApplicationErrors;
+}>;
+interface RemoveVoteOptions {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string;
+    /** context data */
+    contextData?: ContextData;
+}
+/**
+ * Retrieves votes in the specified app and context.
+ * Visitor and member callers receive only their own votes. Application callers
+ * can query all votes only when granted WIX_COMMENTS.VOTE_QUERY.
+ * Filter on resourceId, including $in for a batch of comment IDs.
+ * Continue with query.cursorPaging.cursor from paging.cursors.next.
+ * Authorization is enforced by the service for the current identity and context.
+ * @public
+ * @documentationMaturity preview
+ * @fqn com.wixpress.comments.Votes.QueryVotes
+ */
+declare function queryVotes(options?: QueryVotesOptions): VotesQueryBuilder;
+interface QueryVotesOptions {
+    /**
+     * context token to be passed
+     * @deprecated
+     * @replacedBy context_data
+     */
+    contextToken?: string | undefined;
+    /** context data */
+    contextData?: ContextData | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface VotesQueryResult extends QueryCursorResult {
+    items: Vote[];
+    query: VotesQueryBuilder;
+    next: () => Promise<VotesQueryResult>;
+    prev: () => Promise<VotesQueryResult>;
+}
+interface VotesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'resourceId', value: any) => VotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'resourceId', value: any) => VotesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'resourceId', value: any) => VotesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => VotesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => VotesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<VotesQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn com.wixpress.comments.Votes.QueryVotes
+ * @requiredField query
+ */
+declare function typedQueryVotes(query: VoteQuery, options?: QueryVotesOptions): Promise<NonNullablePaths<QueryVotesResponse, `votes` | `votes.${number}.resourceId` | `votes.${number}.resourceFqdn` | `votes.${number}.voteId` | `votes.${number}.type` | `votes.${number}.createdBy.identityId` | `votes.${number}.createdBy.identityType` | `votes.${number}.context.contextId` | `votes.${number}.context.appDefId` | `votes.${number}.context.metaSiteId` | `votes.${number}.revision`, 5> & {
+    __applicationErrorsType?: QueryVotesApplicationErrors;
+}>;
+interface VoteQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['resourceId'];
+            operators: ['$eq', '$in', '$ne'];
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Vote, VoteQuerySpec>;
+type VoteQuery = {
+    /**
+    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?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+        /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
+        /**
+      Origin point for geo-distance sorting on a GEO field
+      results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+      */
+        origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
+    }[];
+};
+declare const utils: {
+    query: _wix_sdk_types.QueryHelpers<Vote, VoteQuerySpec, VoteQuery>;
+};
+
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type BaseEventMetadata, type CommonQueryWithEntityContext, type ContextData, type ContextResourceVoteChange, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownvoteApplicationErrors, type DownvoteOptions, type DownvoteRequest, type DownvoteResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetResourceVoteSummaryRequest, type GetResourceVoteSummaryResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type ImportVote, type ImportVoteRequest, type MessageEnvelope, type Paging, type PagingMetadataV2, type QueryV2, type QueryV2PagingMethodOneOf, type QueryVotesApplicationErrors, type QueryVotesOptions, type QueryVotesRequest, type QueryVotesResponse, type RemoveVoteApplicationErrors, type RemoveVoteOptions, type RemoveVoteRequest, type RemoveVoteResponse, type ResourceVoteSummary, type RestoreInfo, type SocialIdentity, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdateVoteRequest, type UpdateVoteResponse, type UpvoteApplicationErrors, type UpvoteOptions, type UpvoteRequest, type UpvoteResponse, type Vote, type VoteCast, type VoteCastEnvelope, type VoteContext, type VoteContextResourceVoteChangeEnvelope, type VoteDeleted, type VoteDeletedEnvelope, type VoteQuery, type VoteQuerySpec, type VotesQueryBuilder, type VotesQueryResult, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, downvote, onVoteCast, onVoteContextResourceVoteChange, onVoteDeleted, queryVotes, removeVote, typedQueryVotes, upvote, utils };