import { CreateLabelRequest as CreateLabelRequest$1, CreateLabelResponse as CreateLabelResponse$1, GetLabelRequest as GetLabelRequest$1, GetLabelResponse as GetLabelResponse$1, ListLabelsRequest as ListLabelsRequest$1, ListLabelsResponse as ListLabelsResponse$1, QueryLabelsRequest as QueryLabelsRequest$1, QueryLabelsResponse as QueryLabelsResponse$1, CountLabelsRequest as CountLabelsRequest$1, CountLabelsResponse as CountLabelsResponse$1, UpdateLabelRequest as UpdateLabelRequest$1, UpdateLabelResponse as UpdateLabelResponse$1, DeleteLabelRequest as DeleteLabelRequest$1, DeleteLabelResponse as DeleteLabelResponse$1, BulkDeleteLabelsRequest as BulkDeleteLabelsRequest$1, BulkDeleteLabelsResponse as BulkDeleteLabelsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; interface Label { /** * Item label ID. * @format GUID * @readonly */ id?: string | null; /** * Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label. * @readonly */ revision?: string | null; /** * Date and time the item label was created. * @readonly */ createdDate?: Date | null; /** * Date and time the item label was updated. * @readonly */ updatedDate?: Date | null; /** * Item label name. * @minLength 1 * @maxLength 50 */ name?: string; /** Item label icon. */ icon?: Image; /** Extended fields. */ extendedFields?: ExtendedFields; } interface Image { /** WixMedia image ID. */ id?: string; /** Image URL. */ url?: string; /** Original image height. */ height?: number; /** Original image width. */ width?: number; /** Image alt text. */ altText?: string | null; /** Image filename. */ filename?: string | null; } 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>; } interface ExternalReferenceInfo { /** * ID of the external integrator app\system associated with this object. * @format GUID */ externalAppId?: string | null; /** * Reference to an external resource ID. Used to link this object to a specific entity in an external system. * @maxLength 100 */ externalEntityId?: string | null; /** Last time this item label was synced with the external app. */ lastSyncDate?: Date | null; /** Whether the connection to the external system is currently active. */ connected?: boolean | null; } interface InvalidateCache extends InvalidateCacheGetByOneOf { /** * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ metaSiteId?: string; /** * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; /** * tell us why you're invalidating the cache. You don't need to add your app name * @maxLength 256 */ reason?: string | null; /** Is local DS */ localDc?: boolean; hardPurge?: boolean; /** * Optional caller-provided ID for tracking this invalidation through the system. * When set, the corresponding CDN purge completion event will include this ID, * allowing you to confirm when the invalidation has fully propagated. * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event. * @maxLength 256 */ correlationId?: string | null; } /** @oneof */ interface InvalidateCacheGetByOneOf { /** * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ metaSiteId?: string; /** * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; } interface App { /** * The AppDefId * @minLength 1 */ appDefId?: string; /** * The instance Id * @format GUID */ instanceId?: string; } interface Page { /** * the msid the page is on * @format GUID */ metaSiteId?: string; /** * Invalidate by Page ID * @minLength 1 */ pageId?: string; } interface URI { /** * the msid the URI is on * @format GUID */ metaSiteId?: string; /** * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes * @minLength 1 */ uriPath?: string; } interface File { /** * the msid the file is related to * @format GUID */ metaSiteId?: string; /** * Invalidate by filename (for media files such as PDFs) * @minLength 1 * @maxLength 256 */ fileName?: string; } interface CustomTag { /** * the msid the tag is related to * @format GUID */ metaSiteId?: string; /** * Tag to invalidate by * @minLength 1 * @maxLength 256 */ tag?: string; } interface Pages { /** * the msid the pages are on * @format GUID */ metaSiteId?: string; /** * Invalidate by multiple Page IDs in a single message * @maxSize 100 * @minLength 1 */ pageIds?: string[]; } interface URIs { /** * the msid the URIs are on * @format GUID */ metaSiteId?: string; /** * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes * @maxSize 100 * @minLength 1 */ uriPaths?: string[]; } interface CreateLabelRequest { /** Item label details. */ label: Label; } interface CreateLabelResponse { /** Item label. */ label?: Label; } interface GetLabelRequest { /** * Item label ID. * @format GUID */ labelId: string; } interface GetLabelResponse { /** Item label. */ label?: Label; } interface ListLabelsRequest { } interface ListLabelsResponse { /** Retrieved item labels. */ labels?: Label[]; } interface QueryLabelsRequest { /** Query options. */ query?: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** 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 in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** 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; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface CursorPaging { /** * Number of items to load. * @max 500 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * You can get the relevant cursor token * from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. */ cursor?: string | null; } interface QueryLabelsResponse { /** Retrieved item labels. */ labels?: Label[]; /** The metadata of the paginated results. */ pagingMetadata?: CursorPagingMetadata; } interface CursorPagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ 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. */ hasNext?: boolean | null; } interface Cursors { /** Cursor pointing to next page in the list of results. */ next?: string | null; /** Cursor pointing to previous page in the list of results. */ prev?: string | null; } interface CountLabelsRequest { /** Filter for counting labels. */ filter?: Record | null; } interface CountLabelsResponse { /** Counted labels. */ count?: number; } interface UpdateLabelRequest { /** Item label to update. */ label: Label; } interface UpdateLabelResponse { /** Updated item label. */ label?: Label; } interface DeleteLabelRequest { /** * ID of the item label. * @format GUID */ labelId: string; } interface DeleteLabelResponse { } interface BulkDeleteLabelsRequest { /** * Item Label IDs. * @format GUID * @maxSize 200 */ ids: string[]; } interface BulkDeleteLabelsResponse { /** Information about the deleted labels. */ results?: BulkDeleteLabelsResult[]; /** Metadata for the API call. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkDeleteLabelsResult { /** Metadata for labels deletion. */ itemMetadata?: ItemMetadata; } interface ItemMetadata { /** * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). * @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 was successful for this item. When `false`, the `error` field is populated. */ 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 | null; } 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 CloneLabelsRequest { /** * The MetaSiteId to clone from. * @format GUID */ metaSiteId?: string; } interface CloneLabelsResponse { } interface SyncContentToMultilingualRequest { /** * MetaSite ID * @format GUID */ metaSiteId?: string; } interface SyncContentToMultilingualResponse { } 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 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 CountLabelsApplicationErrors = { code?: 'TOO_MANY_TO_COUNT'; description?: string; data?: Record; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createLabel(): __PublicMethodMetaInfo<'POST', {}, CreateLabelRequest$1, CreateLabelRequest, CreateLabelResponse$1, CreateLabelResponse>; declare function getLabel(): __PublicMethodMetaInfo<'GET', { labelId: string; }, GetLabelRequest$1, GetLabelRequest, GetLabelResponse$1, GetLabelResponse>; declare function listLabels(): __PublicMethodMetaInfo<'GET', {}, ListLabelsRequest$1, ListLabelsRequest, ListLabelsResponse$1, ListLabelsResponse>; declare function queryLabels(): __PublicMethodMetaInfo<'POST', {}, QueryLabelsRequest$1, QueryLabelsRequest, QueryLabelsResponse$1, QueryLabelsResponse>; declare function countLabels(): __PublicMethodMetaInfo<'POST', {}, CountLabelsRequest$1, CountLabelsRequest, CountLabelsResponse$1, CountLabelsResponse>; declare function updateLabel(): __PublicMethodMetaInfo<'PATCH', { labelId: string; }, UpdateLabelRequest$1, UpdateLabelRequest, UpdateLabelResponse$1, UpdateLabelResponse>; declare function deleteLabel(): __PublicMethodMetaInfo<'DELETE', { labelId: string; }, DeleteLabelRequest$1, DeleteLabelRequest, DeleteLabelResponse$1, DeleteLabelResponse>; declare function bulkDeleteLabels(): __PublicMethodMetaInfo<'DELETE', {}, BulkDeleteLabelsRequest$1, BulkDeleteLabelsRequest, BulkDeleteLabelsResponse$1, BulkDeleteLabelsResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkDeleteLabelsRequest as BulkDeleteLabelsRequestOriginal, type BulkDeleteLabelsResponse as BulkDeleteLabelsResponseOriginal, type BulkDeleteLabelsResult as BulkDeleteLabelsResultOriginal, type CloneLabelsRequest as CloneLabelsRequestOriginal, type CloneLabelsResponse as CloneLabelsResponseOriginal, type CountLabelsApplicationErrors as CountLabelsApplicationErrorsOriginal, type CountLabelsRequest as CountLabelsRequestOriginal, type CountLabelsResponse as CountLabelsResponseOriginal, type CreateLabelRequest as CreateLabelRequestOriginal, type CreateLabelResponse as CreateLabelResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteLabelRequest as DeleteLabelRequestOriginal, type DeleteLabelResponse as DeleteLabelResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReferenceInfo as ExternalReferenceInfoOriginal, type File as FileOriginal, type GetLabelRequest as GetLabelRequestOriginal, type GetLabelResponse as GetLabelResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Label as LabelOriginal, type ListLabelsRequest as ListLabelsRequestOriginal, type ListLabelsResponse as ListLabelsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type QueryLabelsRequest as QueryLabelsRequestOriginal, type QueryLabelsResponse as QueryLabelsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SyncContentToMultilingualRequest as SyncContentToMultilingualRequestOriginal, type SyncContentToMultilingualResponse as SyncContentToMultilingualResponseOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateLabelRequest as UpdateLabelRequestOriginal, type UpdateLabelResponse as UpdateLabelResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkDeleteLabels, countLabels, createLabel, deleteLabel, getLabel, listLabels, queryLabels, updateLabel };