@wix/auto_sdk_widgets_widget-store 1.0.0

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

@@ -0,0 +1,831 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+/** Registry entry describing a widget that can be offered within an app instance. */
+interface Widget {
+    /**
+     * Widget ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Widget is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Widget was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Widget was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Stable machine-readable key for the widget.
+     * @minLength 1
+     * @maxLength 120
+     */
+    key?: string;
+    /**
+     * Human-readable widget name.
+     * @minLength 1
+     * @maxLength 120
+     */
+    displayName?: string;
+    /**
+     * Short explanation of what the widget does.
+     * @maxLength 1000
+     */
+    description?: string | null;
+    /**
+     * Platform or vendor that provides the widget.
+     * @minLength 1
+     * @maxLength 120
+     */
+    provider?: string;
+    /**
+     * Runtime used to execute the widget.
+     * @minLength 1
+     * @maxLength 120
+     */
+    runtime?: string;
+    /**
+     * Widget package or configuration version.
+     * @maxLength 80
+     */
+    version?: string | null;
+    /** Current lifecycle state of the widget. */
+    status?: WidgetStatusWithLiterals;
+    /**
+     * Capability identifiers supported by the widget.
+     * @maxSize 100
+     * @maxLength 120
+     */
+    capabilities?: string[];
+    /** Data Extensions. */
+    extendedFields?: ExtendedFields;
+    /** Tags. */
+    tags?: Tags;
+}
+declare enum WidgetStatus {
+    ACTIVE = "ACTIVE",
+    PAUSED = "PAUSED",
+    DEPRECATED = "DEPRECATED"
+}
+/** @enumType */
+type WidgetStatusWithLiterals = WidgetStatus | 'ACTIVE' | 'PAUSED' | 'DEPRECATED';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * public_tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    publicTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface WidgetTagsModified {
+    /** Updated Widget. */
+    widget?: Widget;
+    /** Tags that were assigned to the Widget. */
+    assignedTags?: Tags;
+    /** Tags that were unassigned from the Widget. */
+    unassignedTags?: Tags;
+}
+interface CreateWidgetRequest {
+    /** Widget to be created. */
+    widget: Widget;
+}
+interface CreateWidgetResponse {
+    /** The created Widget. */
+    widget?: Widget;
+}
+interface GetWidgetRequest {
+    /**
+     * ID of the Widget to retrieve.
+     * @format GUID
+     */
+    widgetId: string;
+}
+interface GetWidgetResponse {
+    /** The requested Widget. */
+    widget?: Widget;
+}
+interface UpdateWidgetRequest {
+    /** Widget to be updated, may be partial. */
+    widget: Widget;
+}
+interface UpdateWidgetResponse {
+    /** Updated Widget. */
+    widget?: Widget;
+}
+interface DeleteWidgetRequest {
+    /**
+     * ID of the Widget to delete.
+     * @format GUID
+     */
+    widgetId: string;
+}
+interface DeleteWidgetResponse {
+}
+interface QueryWidgetsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+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 QueryWidgetsResponse {
+    /** List of Widgets. */
+    widgets?: Widget[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    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 BulkUpdateWidgetTagsRequest {
+    /**
+     * IDs of Widgets whose tags will be updated.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    widgetIds: string[];
+    /** Tags to assign. */
+    assignTags?: Tags;
+    /** Tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateWidgetTagsResponse {
+    /**
+     * Results.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateWidgetTagsResult[];
+    /** Metadata regarding the bulk update operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdateWidgetTagsResult {
+    /** Metadata regarding the specific single update operation. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdateWidgetTagsByFilterRequest {
+    /** Filter that selects Widgets whose tags will be updated. */
+    filter: Record<string, any> | null;
+    /** Tags to assign. */
+    assignTags?: Tags;
+    /** Tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateWidgetTagsByFilterResponse {
+    /**
+     * Job ID.
+     * @format GUID
+     */
+    jobId?: string;
+}
+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 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 BulkUpdateWidgetTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateWidgetTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Creates a Widget.
+ * @param widget - Widget to be created.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField widget
+ * @requiredField widget.displayName
+ * @requiredField widget.key
+ * @requiredField widget.provider
+ * @requiredField widget.runtime
+ * @permissionId widgets:v1:widget:create_widget
+ * @returns The created Widget.
+ * @fqn wix.widgets.v1.WidgetStoreService.CreateWidget
+ */
+declare function createWidget(widget: NonNullablePaths<Widget, `displayName` | `key` | `provider` | `runtime`, 2>): Promise<NonNullablePaths<Widget, `key` | `displayName` | `provider` | `runtime` | `status` | `capabilities` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Retrieves a Widget.
+ * @param widgetId - ID of the Widget to retrieve.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField widgetId
+ * @permissionId widgets:v1:widget:get_widget
+ * @returns The requested Widget.
+ * @fqn wix.widgets.v1.WidgetStoreService.GetWidget
+ */
+declare function getWidget(widgetId: string): Promise<NonNullablePaths<Widget, `key` | `displayName` | `provider` | `runtime` | `status` | `capabilities` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Updates a Widget.
+ * @param _id - Widget ID.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField widget
+ * @requiredField widget.revision
+ * @permissionId widgets:v1:widget:update_widget
+ * @returns Updated Widget.
+ * @fqn wix.widgets.v1.WidgetStoreService.UpdateWidget
+ */
+declare function updateWidget(_id: string, widget: NonNullablePaths<UpdateWidget, `revision`, 2>): Promise<NonNullablePaths<Widget, `key` | `displayName` | `provider` | `runtime` | `status` | `capabilities` | `tags.privateTags.tagIds`, 4>>;
+interface UpdateWidget {
+    /**
+     * Widget ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Widget is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Widget was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Widget was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Stable machine-readable key for the widget.
+     * @minLength 1
+     * @maxLength 120
+     */
+    key?: string;
+    /**
+     * Human-readable widget name.
+     * @minLength 1
+     * @maxLength 120
+     */
+    displayName?: string;
+    /**
+     * Short explanation of what the widget does.
+     * @maxLength 1000
+     */
+    description?: string | null;
+    /**
+     * Platform or vendor that provides the widget.
+     * @minLength 1
+     * @maxLength 120
+     */
+    provider?: string;
+    /**
+     * Runtime used to execute the widget.
+     * @minLength 1
+     * @maxLength 120
+     */
+    runtime?: string;
+    /**
+     * Widget package or configuration version.
+     * @maxLength 80
+     */
+    version?: string | null;
+    /** Current lifecycle state of the widget. */
+    status?: WidgetStatusWithLiterals;
+    /**
+     * Capability identifiers supported by the widget.
+     * @maxSize 100
+     * @maxLength 120
+     */
+    capabilities?: string[];
+    /** Data Extensions. */
+    extendedFields?: ExtendedFields;
+    /** Tags. */
+    tags?: Tags;
+}
+/**
+ * Deletes a Widget.
+ * @param widgetId - ID of the Widget to delete.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField widgetId
+ * @permissionId widgets:v1:widget:delete_widget
+ * @fqn wix.widgets.v1.WidgetStoreService.DeleteWidget
+ */
+declare function deleteWidget(widgetId: string): Promise<void>;
+/**
+ * Retrieves a list of Widgets by WQL query.
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId widgets:v1:widget:query_widgets
+ * @fqn wix.widgets.v1.WidgetStoreService.QueryWidgets
+ */
+declare function queryWidgets(): WidgetsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface WidgetsQueryResult extends QueryCursorResult {
+    items: Widget[];
+    query: WidgetsQueryBuilder;
+    next: () => Promise<WidgetsQueryResult>;
+    prev: () => Promise<WidgetsQueryResult>;
+}
+interface WidgetsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version', value: any) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version', value: any) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version', value: any) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version', value: any) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version', value: string) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any[]) => WidgetsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasAll: (propertyName: 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any[]) => WidgetsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => WidgetsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: boolean) => WidgetsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds'>) => WidgetsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | 'key' | 'displayName' | 'provider' | 'runtime' | 'version' | 'status' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds'>) => WidgetsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => WidgetsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => WidgetsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<WidgetsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.widgets.v1.WidgetStoreService.QueryWidgets
+ * @requiredField query
+ */
+declare function typedQueryWidgets(query: WidgetQuery): Promise<NonNullablePaths<QueryWidgetsResponse, `widgets` | `widgets.${number}.key` | `widgets.${number}.displayName` | `widgets.${number}.provider` | `widgets.${number}.runtime` | `widgets.${number}.status`, 4>>;
+interface WidgetQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['tags.privateTags.tagIds', 'tags.publicTags.tagIds'];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                '_id',
+                'displayName',
+                'key',
+                'provider',
+                'runtime',
+                'status',
+                'version'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Widget, WidgetQuerySpec>;
+type WidgetQuery = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    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 the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Widget, WidgetQuerySpec, WidgetQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Widget, WidgetQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<WidgetQuerySpec>;
+    };
+};
+/**
+ * Synchronously updates tags on multiple Widgets by ID.
+ * @param widgetIds - IDs of Widgets whose tags will be updated.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField widgetIds
+ * @permissionId widgets:v1:widget:bulk_update_widget_tags
+ * @fqn wix.widgets.v1.WidgetStoreService.BulkUpdateWidgetTags
+ */
+declare function bulkUpdateWidgetTags(widgetIds: string[], options?: BulkUpdateWidgetTagsOptions): Promise<NonNullablePaths<BulkUpdateWidgetTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+    __applicationErrorsType?: BulkUpdateWidgetTagsApplicationErrors;
+}>;
+interface BulkUpdateWidgetTagsOptions {
+    /** Tags to assign. */
+    assignTags?: Tags;
+    /** Tags to unassign. */
+    unassignTags?: Tags;
+}
+/**
+ * Asynchronously updates tags on Widgets matching the provided filter.
+ * @param filter - Filter that selects Widgets whose tags will be updated.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId widgets:v1:widget:bulk_update_widget_tags_by_filter
+ * @fqn wix.widgets.v1.WidgetStoreService.BulkUpdateWidgetTagsByFilter
+ */
+declare function bulkUpdateWidgetTagsByFilter(filter: Record<string, any>, options?: BulkUpdateWidgetTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateWidgetTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdateWidgetTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateWidgetTagsByFilterOptions {
+    /** Tags to assign. */
+    assignTags?: Tags;
+    /** Tags to unassign. */
+    unassignTags?: Tags;
+}
+
+export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkUpdateWidgetTagsApplicationErrors, type BulkUpdateWidgetTagsByFilterApplicationErrors, type BulkUpdateWidgetTagsByFilterOptions, type BulkUpdateWidgetTagsByFilterRequest, type BulkUpdateWidgetTagsByFilterResponse, type BulkUpdateWidgetTagsOptions, type BulkUpdateWidgetTagsRequest, type BulkUpdateWidgetTagsResponse, type BulkUpdateWidgetTagsResult, type CommonQueryWithEntityContext, type CreateWidgetRequest, type CreateWidgetResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteWidgetRequest, type DeleteWidgetResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetWidgetRequest, type GetWidgetResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type QueryWidgetsRequest, type QueryWidgetsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type TagList, type Tags, type UpdateWidget, type UpdateWidgetRequest, type UpdateWidgetResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type Widget, type WidgetQuery, type WidgetQuerySpec, WidgetStatus, type WidgetStatusWithLiterals, type WidgetTagsModified, type WidgetsQueryBuilder, type WidgetsQueryResult, bulkUpdateWidgetTags, bulkUpdateWidgetTagsByFilter, createWidget, deleteWidget, getWidget, queryWidgets, typedQueryWidgets, updateWidget, utils };