@wix/auto_sdk_comments_votes 1.0.0

package/build/es/meta.d.mts

@@ -0,0 +1,610 @@
+import { UpvoteRequest as UpvoteRequest$1, UpvoteResponse as UpvoteResponse$1, DownvoteRequest as DownvoteRequest$1, DownvoteResponse as DownvoteResponse$1, RemoveVoteRequest as RemoveVoteRequest$1, RemoveVoteResponse as RemoveVoteResponse$1, QueryVotesRequest as QueryVotesRequest$1, QueryVotesResponse as QueryVotesResponse$1 } from './index.typings.mjs';
+import '@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;
+}
+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;
+    /**
+     * 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;
+}
+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 {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: 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>;
+};
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function upvote(): __PublicMethodMetaInfo<'POST', {}, UpvoteRequest$1, UpvoteRequest, UpvoteResponse$1, UpvoteResponse>;
+declare function downvote(): __PublicMethodMetaInfo<'POST', {}, DownvoteRequest$1, DownvoteRequest, DownvoteResponse$1, DownvoteResponse>;
+declare function removeVote(): __PublicMethodMetaInfo<'DELETE', {
+    voteId: string;
+}, RemoveVoteRequest$1, RemoveVoteRequest, RemoveVoteResponse$1, RemoveVoteResponse>;
+declare function queryVotes(): __PublicMethodMetaInfo<'POST', {}, QueryVotesRequest$1, QueryVotesRequest, QueryVotesResponse$1, QueryVotesResponse>;
+
+export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type ContextData as ContextDataOriginal, type ContextResourceVoteChange as ContextResourceVoteChangeOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownvoteApplicationErrors as DownvoteApplicationErrorsOriginal, type DownvoteRequest as DownvoteRequestOriginal, type DownvoteResponse as DownvoteResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GetResourceVoteSummaryRequest as GetResourceVoteSummaryRequestOriginal, type GetResourceVoteSummaryResponse as GetResourceVoteSummaryResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentityType as IdentityTypeOriginal, type IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal, type ImportVote as ImportVoteOriginal, type ImportVoteRequest as ImportVoteRequestOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type QueryVotesApplicationErrors as QueryVotesApplicationErrorsOriginal, type QueryVotesRequest as QueryVotesRequestOriginal, type QueryVotesResponse as QueryVotesResponseOriginal, type RemoveVoteApplicationErrors as RemoveVoteApplicationErrorsOriginal, type RemoveVoteRequest as RemoveVoteRequestOriginal, type RemoveVoteResponse as RemoveVoteResponseOriginal, type ResourceVoteSummary as ResourceVoteSummaryOriginal, type RestoreInfo as RestoreInfoOriginal, type SocialIdentity as SocialIdentityOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateVoteRequest as UpdateVoteRequestOriginal, type UpdateVoteResponse as UpdateVoteResponseOriginal, type UpvoteApplicationErrors as UpvoteApplicationErrorsOriginal, type UpvoteRequest as UpvoteRequestOriginal, type UpvoteResponse as UpvoteResponseOriginal, type VoteCast as VoteCastOriginal, type VoteContext as VoteContextOriginal, type VoteDeleted as VoteDeletedOriginal, type Vote as VoteOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, downvote, queryVotes, removeVote, upvote };