@wix/auto_sdk_stores_ribbons-v-3 1.0.10 → 1.0.12

package/build/{internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.d.ts → stores-catalog-v3-ribbon-ribbons-v-3.universal-DWKP9-aP.d.mts}

@@ -1,11 +1,11 @@
 /** A Ribbon is a visual element that you can assign to products to highlight them on your site. */
-export interface Ribbon {
+interface Ribbon {
     /**
      * Ribbon ID.
      * @format GUID
      * @readonly
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * Revision number, which increments by 1 each time the ribbon is updated.
      * To prevent conflicting changes,
@@ -19,12 +19,12 @@ export interface Ribbon {
      * Date and time the ribbon was created.
      * @readonly
      */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /**
      * Date and time the ribbon was updated.
      * @readonly
      */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
     /**
      * Ribbon name.
      * @minLength 1
@@ -38,7 +38,7 @@ export interface Ribbon {
      */
     assignedProductCount?: number | null;
 }
-export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /**
      * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
      * @format GUID
@@ -69,7 +69,7 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     hardPurge?: boolean;
 }
 /** @oneof */
-export interface InvalidateCacheGetByOneOf {
+interface InvalidateCacheGetByOneOf {
     /**
      * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
      * @format GUID
@@ -91,7 +91,7 @@ export interface InvalidateCacheGetByOneOf {
     /** 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;
 }
-export interface App {
+interface App {
     /**
      * The AppDefId
      * @minLength 1
@@ -103,7 +103,7 @@ export interface App {
      */
     instanceId?: string;
 }
-export interface Page {
+interface Page {
     /**
      * the msid the page is on
      * @format GUID
@@ -115,7 +115,7 @@ export interface Page {
      */
     pageId?: string;
 }
-export interface URI {
+interface URI {
     /**
      * the msid the URI is on
      * @format GUID
@@ -127,7 +127,7 @@ export interface URI {
      */
     uriPath?: string;
 }
-export interface File {
+interface File {
     /**
      * the msid the file is related to
      * @format GUID
@@ -140,7 +140,7 @@ export interface File {
      */
     fileName?: string;
 }
-export interface CustomTag {
+interface CustomTag {
     /**
      * the msid the tag is related to
      * @format GUID
@@ -153,15 +153,15 @@ export interface CustomTag {
      */
     tag?: string;
 }
-export interface CreateRibbonRequest {
+interface CreateRibbonRequest {
     /** Ribbon to create. */
     ribbon: Ribbon;
 }
-export interface CreateRibbonResponse {
+interface CreateRibbonResponse {
     /** Created ribbon. */
     ribbon?: Ribbon;
 }
-export interface GetRibbonRequest {
+interface GetRibbonRequest {
     /**
      * Ribbon ID.
      * @format GUID
@@ -175,17 +175,17 @@ export interface GetRibbonRequest {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-export declare enum RequestedFields {
+declare enum RequestedFields {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     ASSIGNED_PRODUCT_COUNT = "ASSIGNED_PRODUCT_COUNT"
 }
 /** @enumType */
-export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'ASSIGNED_PRODUCT_COUNT';
-export interface GetRibbonResponse {
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'ASSIGNED_PRODUCT_COUNT';
+interface GetRibbonResponse {
     /** Ribbon. */
     ribbon?: Ribbon;
 }
-export interface UpdateRibbonRequest {
+interface UpdateRibbonRequest {
     /** Ribbon to update. */
     ribbon: Ribbon;
     /**
@@ -196,20 +196,20 @@ export interface UpdateRibbonRequest {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-export interface UpdateRibbonResponse {
+interface UpdateRibbonResponse {
     /** Updated Ribbon. */
     ribbon?: Ribbon;
 }
-export interface DeleteRibbonRequest {
+interface DeleteRibbonRequest {
     /**
      * Ribbon ID.
      * @format GUID
      */
     ribbonId: string;
 }
-export interface DeleteRibbonResponse {
+interface DeleteRibbonResponse {
 }
-export interface QueryRibbonsRequest {
+interface QueryRibbonsRequest {
     /** Query options. */
     query?: CursorQuery;
     /**
@@ -220,7 +220,7 @@ export interface QueryRibbonsRequest {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -240,11 +240,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -253,15 +253,15 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     /** Ascending order. */
     ASC = "ASC",
     /** Descending order. */
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -276,7 +276,7 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryRibbonsResponse {
+interface QueryRibbonsResponse {
     /**
      * List of ribbons.
      * @minSize 1
@@ -286,7 +286,7 @@ export interface QueryRibbonsResponse {
     /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -299,7 +299,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -311,7 +311,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface BulkCreateRibbonsRequest {
+interface BulkCreateRibbonsRequest {
     /**
      * Ribbons to create.
      * @minSize 1
@@ -325,7 +325,7 @@ export interface BulkCreateRibbonsRequest {
      */
     returnEntity?: boolean;
 }
-export interface BulkCreateRibbonsResponse {
+interface BulkCreateRibbonsResponse {
     /**
      * Ribbons created by bulk action.
      * @maxSize 100
@@ -334,7 +334,7 @@ export interface BulkCreateRibbonsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface V3BulkRibbonResult {
+interface V3BulkRibbonResult {
     /** Bulk action metadata for ribbon. */
     itemMetadata?: ItemMetadata;
     /**
@@ -344,12 +344,12 @@ export interface V3BulkRibbonResult {
      */
     item?: Ribbon;
 }
-export interface 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;
+    _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. */
@@ -357,7 +357,7 @@ export interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -365,7 +365,7 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface BulkActionMetadata {
+interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -373,7 +373,7 @@ export interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-export interface BulkUpdateRibbonsRequest {
+interface BulkUpdateRibbonsRequest {
     /**
      * List of ribbons to update.
      * @minSize 1
@@ -394,13 +394,13 @@ export interface BulkUpdateRibbonsRequest {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-export interface MaskedRibbon {
+interface MaskedRibbon {
     /** Ribbon to update. */
     ribbon?: Ribbon;
     /** Explicit list of fields to update. */
     fieldMask?: string[];
 }
-export interface BulkUpdateRibbonsResponse {
+interface BulkUpdateRibbonsResponse {
     /**
      * Ribbons updated by bulk action.
      * @maxSize 100
@@ -409,7 +409,7 @@ export interface BulkUpdateRibbonsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface GetOrCreateRibbonRequest {
+interface GetOrCreateRibbonRequest {
     /**
      * Ribbon name to retrieve or create.
      * @minLength 1
@@ -424,11 +424,11 @@ export interface GetOrCreateRibbonRequest {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-export interface GetOrCreateRibbonResponse {
+interface GetOrCreateRibbonResponse {
     /** Ribbon. */
     ribbon?: Ribbon;
 }
-export interface BulkGetOrCreateRibbonsRequest {
+interface BulkGetOrCreateRibbonsRequest {
     /**
      * Ribbon names to retrieve or create.
      * @minLength 1
@@ -445,7 +445,7 @@ export interface BulkGetOrCreateRibbonsRequest {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-export interface BulkGetOrCreateRibbonsResponse {
+interface BulkGetOrCreateRibbonsResponse {
     /**
      * Ribbons retrieved or created by bulk action.
      * @maxSize 100
@@ -454,7 +454,7 @@ export interface BulkGetOrCreateRibbonsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkDeleteRibbonsRequest {
+interface BulkDeleteRibbonsRequest {
     /**
      * IDs of ribbons to delete.
      * @format GUID
@@ -463,7 +463,7 @@ export interface BulkDeleteRibbonsRequest {
      */
     ribbonIds: string[];
 }
-export interface BulkDeleteRibbonsResponse {
+interface BulkDeleteRibbonsResponse {
     /**
      * Ribbons deleted by bulk action.
      * @maxSize 100
@@ -472,17 +472,17 @@ export interface BulkDeleteRibbonsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkRibbonResult {
+interface BulkRibbonResult {
     /** Bulk action metadata for ribbon. */
     itemMetadata?: ItemMetadata;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+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;
+    _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`.
@@ -511,38 +511,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -558,7 +556,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -583,7 +581,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -605,7 +603,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -613,4 +611,246 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** 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;
+}
+interface RibbonCreatedEnvelope {
+    entity: Ribbon;
+    metadata: EventMetadata;
+}
+interface RibbonDeletedEnvelope {
+    entity: Ribbon;
+    metadata: EventMetadata;
+}
+interface RibbonUpdatedEnvelope {
+    entity: Ribbon;
+    metadata: EventMetadata;
+}
+interface GetRibbonOptions {
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface UpdateRibbon {
+    /**
+     * Ribbon ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the ribbon is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the ribbon.
+     *
+     * Ignored when creating a ribbon.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the ribbon was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the ribbon was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Ribbon name.
+     * @minLength 1
+     * @maxLength 30
+     */
+    name?: string;
+    /**
+     * Number of products this ribbon is assigned to.
+     * > **Note:** Returned only when you pass `"ASSIGNED_PRODUCT_COUNT"` to the `fields` array in Ribbon API requests.
+     * @readonly
+     */
+    assignedProductCount?: number | null;
+}
+interface UpdateRibbonOptions {
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface QueryRibbonsOptions {
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface RibbonsQueryResult extends QueryCursorResult {
+    items: Ribbon[];
+    query: RibbonsQueryBuilder;
+    next: () => Promise<RibbonsQueryResult>;
+    prev: () => Promise<RibbonsQueryResult>;
+}
+interface RibbonsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'name', value: string) => RibbonsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any[]) => RibbonsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => RibbonsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: boolean) => RibbonsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name'>) => RibbonsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name'>) => RibbonsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => RibbonsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => RibbonsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<RibbonsQueryResult>;
+}
+interface BulkCreateRibbonsOptions {
+    /**
+     * Whether to return the full created ribbon entities in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkUpdateRibbonsOptions {
+    /**
+     * Whether to return the full updated ribbon entities in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface GetOrCreateRibbonOptions {
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface BulkGetOrCreateRibbonsOptions {
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+
+export { type BulkDeleteRibbonsRequest as $, type App as A, type BulkCreateRibbonsOptions as B, type CustomTag as C, type DeleteRibbonRequest as D, type Sorting as E, type File as F, type GetRibbonOptions as G, type CursorPaging as H, type InvalidateCache as I, type QueryRibbonsResponse as J, type CursorPagingMetadata as K, type Cursors as L, type MaskedRibbon as M, type BulkCreateRibbonsRequest as N, type ItemMetadata as O, type Page as P, type QueryRibbonsOptions as Q, type Ribbon as R, SortOrder as S, type ApplicationError as T, type UpdateRibbon as U, type V3BulkRibbonResult as V, WebhookIdentityType as W, type BulkActionMetadata as X, type BulkUpdateRibbonsRequest as Y, type GetOrCreateRibbonRequest as Z, type BulkGetOrCreateRibbonsRequest as _, type UpdateRibbonOptions as a, type BulkRibbonResult as a0, type DomainEvent as a1, type DomainEventBodyOneOf as a2, type EntityCreatedEvent as a3, type RestoreInfo as a4, type EntityUpdatedEvent as a5, type EntityDeletedEvent as a6, type ActionEvent as a7, type Empty as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type RibbonsQueryResult as ae, type RibbonsQueryBuilder as b, type BulkCreateRibbonsResponse as c, type BulkUpdateRibbonsOptions as d, type BulkUpdateRibbonsResponse as e, type GetOrCreateRibbonOptions as f, type GetOrCreateRibbonResponse as g, type BulkGetOrCreateRibbonsOptions as h, type BulkGetOrCreateRibbonsResponse as i, type BulkDeleteRibbonsResponse as j, type RibbonCreatedEnvelope as k, type RibbonDeletedEnvelope as l, type RibbonUpdatedEnvelope as m, RequestedFields as n, type InvalidateCacheGetByOneOf as o, type URI as p, type CreateRibbonRequest as q, type CreateRibbonResponse as r, type GetRibbonRequest as s, type GetRibbonResponse as t, type UpdateRibbonRequest as u, type UpdateRibbonResponse as v, type DeleteRibbonResponse as w, type QueryRibbonsRequest as x, type CursorQuery as y, type CursorQueryPagingMethodOneOf as z };