@wix/auto_sdk_widgets_widget-store 1.0.0

package/build/cjs/meta.d.ts

@@ -0,0 +1,531 @@
+import { CreateWidgetRequest as CreateWidgetRequest$1, CreateWidgetResponse as CreateWidgetResponse$1, GetWidgetRequest as GetWidgetRequest$1, GetWidgetResponse as GetWidgetResponse$1, UpdateWidgetRequest as UpdateWidgetRequest$1, UpdateWidgetResponse as UpdateWidgetResponse$1, DeleteWidgetRequest as DeleteWidgetRequest$1, DeleteWidgetResponse as DeleteWidgetResponse$1, QueryWidgetsRequest as QueryWidgetsRequest$1, QueryWidgetsResponse as QueryWidgetsResponse$1, BulkUpdateWidgetTagsRequest as BulkUpdateWidgetTagsRequest$1, BulkUpdateWidgetTagsResponse as BulkUpdateWidgetTagsResponse$1, BulkUpdateWidgetTagsByFilterRequest as BulkUpdateWidgetTagsByFilterRequest$1, BulkUpdateWidgetTagsByFilterResponse as BulkUpdateWidgetTagsByFilterResponse$1 } from './index.typings.js';
+import '@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 {
+    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 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>;
+};
+
+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 createWidget(): __PublicMethodMetaInfo<'POST', {}, CreateWidgetRequest$1, CreateWidgetRequest, CreateWidgetResponse$1, CreateWidgetResponse>;
+declare function getWidget(): __PublicMethodMetaInfo<'GET', {
+    widgetId: string;
+}, GetWidgetRequest$1, GetWidgetRequest, GetWidgetResponse$1, GetWidgetResponse>;
+declare function updateWidget(): __PublicMethodMetaInfo<'PATCH', {
+    widgetId: string;
+}, UpdateWidgetRequest$1, UpdateWidgetRequest, UpdateWidgetResponse$1, UpdateWidgetResponse>;
+declare function deleteWidget(): __PublicMethodMetaInfo<'DELETE', {
+    widgetId: string;
+}, DeleteWidgetRequest$1, DeleteWidgetRequest, DeleteWidgetResponse$1, DeleteWidgetResponse>;
+declare function queryWidgets(): __PublicMethodMetaInfo<'GET', {}, QueryWidgetsRequest$1, QueryWidgetsRequest, QueryWidgetsResponse$1, QueryWidgetsResponse>;
+declare function bulkUpdateWidgetTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateWidgetTagsRequest$1, BulkUpdateWidgetTagsRequest, BulkUpdateWidgetTagsResponse$1, BulkUpdateWidgetTagsResponse>;
+declare function bulkUpdateWidgetTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateWidgetTagsByFilterRequest$1, BulkUpdateWidgetTagsByFilterRequest, BulkUpdateWidgetTagsByFilterResponse$1, BulkUpdateWidgetTagsByFilterResponse>;
+
+export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkUpdateWidgetTagsApplicationErrors as BulkUpdateWidgetTagsApplicationErrorsOriginal, type BulkUpdateWidgetTagsByFilterApplicationErrors as BulkUpdateWidgetTagsByFilterApplicationErrorsOriginal, type BulkUpdateWidgetTagsByFilterRequest as BulkUpdateWidgetTagsByFilterRequestOriginal, type BulkUpdateWidgetTagsByFilterResponse as BulkUpdateWidgetTagsByFilterResponseOriginal, type BulkUpdateWidgetTagsRequest as BulkUpdateWidgetTagsRequestOriginal, type BulkUpdateWidgetTagsResponse as BulkUpdateWidgetTagsResponseOriginal, type BulkUpdateWidgetTagsResult as BulkUpdateWidgetTagsResultOriginal, type CreateWidgetRequest as CreateWidgetRequestOriginal, type CreateWidgetResponse as CreateWidgetResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteWidgetRequest as DeleteWidgetRequestOriginal, type DeleteWidgetResponse as DeleteWidgetResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetWidgetRequest as GetWidgetRequestOriginal, type GetWidgetResponse as GetWidgetResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type QueryWidgetsRequest as QueryWidgetsRequestOriginal, type QueryWidgetsResponse as QueryWidgetsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type UpdateWidgetRequest as UpdateWidgetRequestOriginal, type UpdateWidgetResponse as UpdateWidgetResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type Widget as WidgetOriginal, WidgetStatus as WidgetStatusOriginal, type WidgetStatusWithLiterals as WidgetStatusWithLiteralsOriginal, type WidgetTagsModified as WidgetTagsModifiedOriginal, type __PublicMethodMetaInfo, bulkUpdateWidgetTags, bulkUpdateWidgetTagsByFilter, createWidget, deleteWidget, getWidget, queryWidgets, updateWidget };