@wix/bex-utils 2.93.0 → 2.95.0

package/@wix/ambassador-os-tags-v1-tag/{build/es → cjs/build}/types.impl.d.ts

@@ -1,105 +1,94 @@
-export interface Tag {
+export interface AccountInfo {
     /**
-     * Tag ID.
-     * @readonly
-     * @maxLength 5
+     * ID of the Wix account associated with the event.
+     * @format GUID
      */
-    id?: string | null;
+    accountId?: string | null;
     /**
-     * Revision number, which increments by 1 each time the tag is updated.
-     * @readonly
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
      */
-    revision?: string | null;
+    parentAccountId?: string | null;
     /**
-     * Date and time the tag was created.
-     * @readonly
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
      */
-    createdDate?: Date | null;
+    siteId?: string | null;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
-     * Date and time the tag was last updated.
-     * @readonly
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    updatedDate?: Date | null;
+    anonymousVisitorId?: string;
     /**
-     * Tag name.
-     * @maxLength 255
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    name?: string | null;
+    memberId?: string;
     /**
-     * FQDN of the entity that belongs to this tag.
-     * @immutable
-     * @maxLength 255
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    fqdn?: string | null;
+    wixUserId?: string;
     /**
-     * Tag exposure.
-     * @internal
+     * ID of an app.
+     * @format GUID
      */
-    exposure?: TagExposure;
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
     /**
-     * Indicates whether this tag is deleted.
-     * @internal
-     * @readonly
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    deleted?: boolean | null;
-}
-export declare enum TagExposure {
-    UNKNOWN = "UNKNOWN",
-    PRIVATE = "PRIVATE",
-    /** Not handled by client yet. */
-    PUBLIC = "PUBLIC"
-}
-export interface CreateTagForAccountRequest {
-    /** The tag to be created. */
-    tag: Tag;
-}
-export interface CreateTagForAccountResponse {
-    /** The created tag. */
-    tag?: Tag;
-}
-export interface GetTagForAccountRequest {
+    anonymousVisitorId?: string;
     /**
-     * The ID of the tag to retrieve.
-     * @maxLength 5
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    tagId: string;
-}
-export interface GetTagForAccountResponse {
-    /** The requested tag. */
-    tag?: Tag;
-}
-export interface UpdateTagForAccountRequest {
-    /** The tag to be updated, which may be partial. */
-    tag: Tag;
-}
-export interface UpdateTagForAccountResponse {
-    /** The updated tag. */
-    tag?: Tag;
-}
-export interface DeleteTagForAccountRequest {
+    memberId?: string;
     /**
-     * ID of the tag to delete.
-     * @maxLength 5
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    tagId: string;
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
 }
-export interface DeleteTagForAccountResponse {
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
 }
-export interface ListTagsForAccountRequest {
+export interface MessageEnvelope {
     /**
-     * The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
-     * @maxLength 255
+     * App instance ID.
+     * @format GUID
      */
-    fqdn: string;
+    instanceId?: string | null;
     /**
-     * The tag exposure.
-     * @internal
+     * Event type.
+     * @maxLength 150
      */
-    exposure?: TagExposure;
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
 }
-export interface ListTagsForAccountResponse {
-    /** A list of tags. */
-    tags?: Tag[];
+export interface ActionEvent {
+    bodyAsJson?: string;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -152,13 +141,24 @@ export interface EntityCreatedEvent {
     /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
     restoreInfo?: RestoreInfo;
     /**
-     * WIP
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
      * @internal
      */
     additionalMetadataAsJson?: string | null;
 }
-export interface RestoreInfo {
-    deletedDate?: Date | null;
+export interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 export interface EntityUpdatedEvent {
     /**
@@ -179,121 +179,265 @@ export interface EntityUpdatedEvent {
      */
     previousEntityAsJson?: string | null;
     /**
-     * WIP - This property will hold both names and previous values of the updated fields of the entity.
-     * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
      * @internal
      */
     modifiedFields?: Record<string, any>;
     /**
-     * WIP
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
      * @internal
      */
     additionalMetadataAsJson?: string | null;
 }
-export interface EntityDeletedEvent {
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface CreateGlobalTagRequest {
+    /** The tag to be created. */
+    tag: Tag;
+}
+export interface CreateGlobalTagResponse {
+    /** The created tag. */
+    tag?: Tag;
+}
+export interface CreateTagForAccountRequest {
+    /** The tag to be created. */
+    tag: Tag;
+}
+export interface CreateTagForAccountResponse {
+    /** The created tag. */
+    tag?: Tag;
+}
+export interface CreateTagRequest {
+    /** The tag to be created. */
+    tag: Tag;
+}
+export interface CreateTagResponse {
+    /** The created tag. */
+    tag?: Tag;
+}
+export interface DeleteGlobalTagRequest {
     /**
-     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
-     * @internal
+     * ID of the tag to delete.
+     * @maxLength 5
      */
-    movedToTrash?: boolean | null;
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    tagId: string;
+}
+export interface DeleteGlobalTagResponse {
+}
+export interface DeleteTagForAccountRequest {
     /**
-     * WIP
-     * @internal
+     * ID of the tag to delete.
+     * @maxLength 5
      */
-    additionalMetadataAsJson?: string | null;
+    tagId: string;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+export interface DeleteTagForAccountResponse {
 }
-export interface MessageEnvelope {
+export interface DeleteTagRequest {
     /**
-     * App instance ID.
-     * @format GUID
+     * ID of the tag to delete.
+     * @maxLength 5
      */
-    instanceId?: string | null;
+    tagId: string;
+}
+export interface DeleteTagResponse {
+}
+export interface GetGlobalTagRequest {
     /**
-     * Event type.
-     * @maxLength 150
+     * The ID of the tag to retrieve.
+     * @maxLength 5
      */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
+    tagId: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+export interface GetGlobalTagResponse {
+    /** The requested tag. */
+    tag?: Tag;
+}
+export interface GetTagForAccountRequest {
     /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
+     * The ID of the tag to retrieve.
+     * @maxLength 5
      */
-    anonymousVisitorId?: string;
+    tagId: string;
+}
+export interface GetTagForAccountResponse {
+    /** The requested tag. */
+    tag?: Tag;
+}
+export interface GetTagRequest {
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * The ID of the tag to retrieve.
+     * @maxLength 5
      */
-    memberId?: string;
+    tagId: string;
+}
+export interface GetTagResponse {
+    /** The requested tag. */
+    tag?: Tag;
+}
+export interface ListGlobalTagsRequest {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * The Fully Qualified Domain Name (FQDN) to which the tags are associated.
+     * @maxLength 255
      */
-    wixUserId?: string;
+    fqdn: string;
     /**
-     * ID of an app.
-     * @format GUID
+     * The tag exposure.
+     * @internal
      */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityType;
+    exposure?: TagExposure;
 }
-/** @oneof */
-export interface IdentificationDataIdOneOf {
+export interface ListGlobalTagsResponse {
+    /** A list of tags. */
+    tags?: Tag[];
+}
+export interface ListTagsForAccountRequest {
     /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
+     * The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
+     * @maxLength 255
      */
-    anonymousVisitorId?: string;
+    fqdn: string;
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * The tag exposure.
+     * @internal
      */
-    memberId?: string;
+    exposure?: TagExposure;
+}
+export interface ListTagsForAccountResponse {
+    /** A list of tags. */
+    tags?: Tag[];
+}
+export interface ListTagsRequest {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
+     * @maxLength 255
      */
-    wixUserId?: string;
+    fqdn: string;
     /**
-     * ID of an app.
-     * @format GUID
+     * The tag exposure.
+     * @internal
      */
-    appId?: string;
+    exposure?: TagExposure;
 }
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
+export interface ListTagsResponse {
+    /** A list of tags. */
+    tags?: Tag[];
 }
-export interface CreateTagRequest {
-    /** The tag to be created. */
+export interface MigrateTagRequest {
+    /** The tag to be migrated with custom createdDate. */
     tag: Tag;
 }
-export interface CreateTagResponse {
-    /** The created tag. */
+export interface MigrateTagResponse {
+    /** The migrated tag. */
     tag?: Tag;
 }
-export interface GetTagRequest {
+export interface QueryTagsForAccountRequest {
     /**
-     * The ID of the tag to retrieve.
+     * The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
+     * @maxLength 255
+     */
+    fqdn: string;
+    /**
+     * The tag exposure.
+     * @internal
+     */
+    exposure?: TagExposure;
+    /** WQL expression. */
+    query: CursorQuery;
+}
+export interface QueryTagsForAccountResponse {
+    /** A list of tags. */
+    tags?: Tag[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface QueryTagsRequest {
+    /**
+     * The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
+     * @maxLength 255
+     */
+    fqdn: string;
+    /**
+     * The tag exposure.
+     * @internal
+     */
+    exposure?: TagExposure;
+    /** WQL expression. */
+    query: CursorQuery;
+}
+export interface QueryTagsResponse {
+    /** A list of tags. */
+    tags?: Tag[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface Tag {
+    /**
+     * Tag ID.
+     * @readonly
      * @maxLength 5
      */
-    tagId: string;
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the tag is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the tag was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the tag was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Tag name.
+     * @maxLength 255
+     */
+    name?: string | null;
+    /**
+     * FQDN of the entity that belongs to this tag.
+     * @immutable
+     * @maxLength 255
+     */
+    fqdn?: string | null;
+    /**
+     * Tag exposure.
+     * @internal
+     */
+    exposure?: TagExposure;
+    /**
+     * Indicates whether this tag is deleted.
+     * @internal
+     * @readonly
+     */
+    deleted?: boolean | null;
 }
-export interface GetTagResponse {
-    /** The requested tag. */
+export declare enum TagExposure {
+    UNKNOWN = "UNKNOWN",
+    PRIVATE = "PRIVATE",
+    /** Not handled by client yet. */
+    PUBLIC = "PUBLIC"
+}
+export interface UpdateGlobalTagRequest {
+    /** The tag to be updated, which may be partial. */
+    tag: Tag;
+}
+export interface UpdateGlobalTagResponse {
+    /** The updated tag. */
+    tag?: Tag;
+}
+export interface UpdateTagForAccountRequest {
+    /** The tag to be updated, which may be partial. */
+    tag: Tag;
+}
+export interface UpdateTagForAccountResponse {
+    /** The updated tag. */
     tag?: Tag;
 }
 export interface UpdateTagRequest {
@@ -304,41 +448,109 @@ export interface UpdateTagResponse {
     /** The updated tag. */
     tag?: Tag;
 }
-export interface DeleteTagRequest {
+export interface CursorPaging {
     /**
-     * ID of the tag to delete.
-     * @maxLength 5
+     * Maximum number of items to return in the results.
+     * @max 100
      */
-    tagId: string;
+    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;
 }
-export interface DeleteTagResponse {
+export 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;
 }
-export interface ListTagsRequest {
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
-     * The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
-     * @maxLength 255
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
      */
-    fqdn: string;
+    cursorPaging?: CursorPaging;
     /**
-     * The tag exposure.
-     * @internal
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
-    exposure?: TagExposure;
+    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[];
 }
-export interface ListTagsResponse {
-    /** A list of tags. */
-    tags?: Tag[];
+/** @oneof */
+export 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;
 }
-export interface MigrateTagRequest {
-    /** The tag to be migrated with custom createdDate. */
-    tag: Tag;
+export 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;
 }
-export interface MigrateTagResponse {
-    /** The migrated tag. */
-    tag?: Tag;
+export interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
 }
 /** @docsIgnore */
-export declare type CreateTagForAccountApplicationErrors = {
+export type CreateGlobalTagApplicationErrors = {
+    code?: 'FQDN_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'TAG_NAME_ALREADY_EXISTS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'TAGS_REACHED_LIMIT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+export type CreateTagForAccountApplicationErrors = {
     code?: 'FQDN_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
@@ -356,7 +568,7 @@ export declare type CreateTagForAccountApplicationErrors = {
     data?: Record<string, any>;
 };
 /** @docsIgnore */
-export declare type CreateTagApplicationErrors = {
+export type CreateTagApplicationErrors = {
     code?: 'FQDN_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;