@wix/auto_sdk_stores_ribbons-v-3 1.0.0 → 1.0.2

package/build/internal/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.d.ts

@@ -2,6 +2,7 @@
 export interface Ribbon {
     /**
      * Ribbon ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -24,7 +25,11 @@ export interface Ribbon {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Ribbon name. */
+    /**
+     * Ribbon name.
+     * @minLength 1
+     * @maxLength 30
+     */
     name?: string;
     /**
      * Number of products this ribbon is assigned to.
@@ -34,9 +39,15 @@ export interface Ribbon {
     assignedProductCount?: number | null;
 }
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * 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! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -46,7 +57,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     uri?: URI;
     /** Invalidate by file (for media files such as PDFs) */
     file?: File;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    /**
+     * 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;
@@ -54,9 +68,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
 }
 /** @oneof */
 export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * 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! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -68,27 +88,52 @@ export interface InvalidateCacheGetByOneOf {
     file?: File;
 }
 export interface App {
-    /** The AppDefId */
+    /**
+     * The AppDefId
+     * @minLength 1
+     */
     appDefId?: string;
-    /** The instance Id */
+    /**
+     * The instance Id
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface Page {
-    /** the msid the page is on */
+    /**
+     * the msid the page is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Page ID */
+    /**
+     * Invalidate by Page ID
+     * @minLength 1
+     */
     pageId?: string;
 }
 export interface URI {
-    /** the msid the URI is on */
+    /**
+     * the msid the URI is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    /**
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
+     */
     uriPath?: string;
 }
 export interface File {
-    /** the msid the file is related to */
+    /**
+     * the msid the file is related to
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by filename (for media files such as PDFs) */
+    /**
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
+     */
     fileName?: string;
 }
 export interface CreateRibbonRequest {
@@ -100,12 +145,16 @@ export interface CreateRibbonResponse {
     ribbon?: Ribbon;
 }
 export interface GetRibbonRequest {
-    /** Ribbon ID. */
+    /**
+     * Ribbon ID.
+     * @format GUID
+     */
     ribbonId: string;
     /**
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -124,6 +173,7 @@ export interface UpdateRibbonRequest {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -132,7 +182,10 @@ export interface UpdateRibbonResponse {
     ribbon?: Ribbon;
 }
 export interface DeleteRibbonRequest {
-    /** Ribbon ID. */
+    /**
+     * Ribbon ID.
+     * @format GUID
+     */
     ribbonId: string;
 }
 export interface DeleteRibbonResponse {
@@ -144,6 +197,7 @@ export interface QueryRibbonsRequest {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -162,6 +216,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 4
      */
     sort?: Sorting[];
 }
@@ -171,7 +226,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -183,18 +241,26 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * 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;
 }
 export interface QueryRibbonsResponse {
-    /** List of ribbons. */
+    /**
+     * List of ribbons.
+     * @minSize 1
+     * @maxSize 100
+     */
     ribbons?: Ribbon[];
     /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata;
@@ -213,13 +279,23 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * 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. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface BulkCreateRibbonsRequest {
-    /** Ribbons to create. */
+    /**
+     * Ribbons to create.
+     * @minSize 1
+     * @maxSize 100
+     */
     ribbons: Ribbon[];
     /**
      * Whether to return the full created ribbon entities in the response.
@@ -229,7 +305,10 @@ export interface BulkCreateRibbonsRequest {
     returnEntity?: boolean;
 }
 export interface BulkCreateRibbonsResponse {
-    /** Ribbons created by bulk action. */
+    /**
+     * Ribbons created by bulk action.
+     * @maxSize 100
+     */
     results?: V3BulkRibbonResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -245,7 +324,10 @@ export interface V3BulkRibbonResult {
     item?: Ribbon;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * 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;
@@ -271,7 +353,11 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface BulkUpdateRibbonsRequest {
-    /** List of ribbons to update. */
+    /**
+     * List of ribbons to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     ribbons: MaskedRibbon[];
     /**
      * Whether to return the full updated ribbon entities in the response.
@@ -283,6 +369,7 @@ export interface BulkUpdateRibbonsRequest {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -293,18 +380,26 @@ export interface MaskedRibbon {
     fieldMask?: string[];
 }
 export interface BulkUpdateRibbonsResponse {
-    /** Ribbons updated by bulk action. */
+    /**
+     * Ribbons updated by bulk action.
+     * @maxSize 100
+     */
     results?: V3BulkRibbonResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface GetOrCreateRibbonRequest {
-    /** Ribbon name to retrieve or create. */
+    /**
+     * Ribbon name to retrieve or create.
+     * @minLength 1
+     * @maxLength 30
+     */
     ribbonName: string;
     /**
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -313,27 +408,45 @@ export interface GetOrCreateRibbonResponse {
     ribbon?: Ribbon;
 }
 export interface BulkGetOrCreateRibbonsRequest {
-    /** Ribbon names to retrieve or create. */
+    /**
+     * Ribbon names to retrieve or create.
+     * @minLength 1
+     * @maxLength 30
+     * @minSize 1
+     * @maxSize 100
+     */
     ribbonNames: string[];
     /**
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
 export interface BulkGetOrCreateRibbonsResponse {
-    /** Ribbons retrieved or created by bulk action. */
+    /**
+     * Ribbons retrieved or created by bulk action.
+     * @maxSize 100
+     */
     results?: V3BulkRibbonResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface BulkDeleteRibbonsRequest {
-    /** IDs of ribbons to delete. */
+    /**
+     * IDs of ribbons to delete.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     ribbonIds: string[];
 }
 export interface BulkDeleteRibbonsResponse {
-    /** Ribbons deleted by bulk action. */
+    /**
+     * Ribbons deleted by bulk action.
+     * @maxSize 100
+     */
     results?: BulkRibbonResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -415,9 +528,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -425,26 +544,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -510,9 +653,15 @@ export interface BulkDeleteRibbonsResponseNonNullableFields {
     bulkActionMetadata?: BulkActionMetadataNonNullableFields;
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -559,14 +708,20 @@ export interface RibbonCreatedEnvelope {
     entity: Ribbon;
     metadata: EventMetadata;
 }
-/** @permissionScope Read ribbons in v3 catalog
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read ribbons in v3 catalog
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
  * @permissionScope Read v3 catalog
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
  * @permissionScope Read Products
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Product write in v3 catalog
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
  * @permissionScope Manage v3 catalog
@@ -576,6 +731,7 @@ export interface RibbonCreatedEnvelope {
  * @permissionId WIX_STORES.RIBBON_READ
  * @webhook
  * @eventType wix.stores.catalog.v3.ribbon_created
+ * @slug created
  * @documentationMaturity preview
  */
 export declare function onRibbonCreated(handler: (event: RibbonCreatedEnvelope) => void | Promise<void>): void;
@@ -583,14 +739,20 @@ export interface RibbonDeletedEnvelope {
     entity: Ribbon;
     metadata: EventMetadata;
 }
-/** @permissionScope Read ribbons in v3 catalog
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read ribbons in v3 catalog
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
  * @permissionScope Read v3 catalog
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
  * @permissionScope Read Products
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Product write in v3 catalog
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
  * @permissionScope Manage v3 catalog
@@ -600,6 +762,7 @@ export interface RibbonDeletedEnvelope {
  * @permissionId WIX_STORES.RIBBON_READ
  * @webhook
  * @eventType wix.stores.catalog.v3.ribbon_deleted
+ * @slug deleted
  * @documentationMaturity preview
  */
 export declare function onRibbonDeleted(handler: (event: RibbonDeletedEnvelope) => void | Promise<void>): void;
@@ -607,14 +770,20 @@ export interface RibbonUpdatedEnvelope {
     entity: Ribbon;
     metadata: EventMetadata;
 }
-/** @permissionScope Read ribbons in v3 catalog
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read ribbons in v3 catalog
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
  * @permissionScope Read v3 catalog
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
  * @permissionScope Read Products
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Product write in v3 catalog
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
  * @permissionScope Manage v3 catalog
@@ -624,6 +793,7 @@ export interface RibbonUpdatedEnvelope {
  * @permissionId WIX_STORES.RIBBON_READ
  * @webhook
  * @eventType wix.stores.catalog.v3.ribbon_updated
+ * @slug updated
  * @documentationMaturity preview
  */
 export declare function onRibbonUpdated(handler: (event: RibbonUpdatedEnvelope) => void | Promise<void>): void;
@@ -637,6 +807,8 @@ export declare function onRibbonUpdated(handler: (event: RibbonUpdatedEnvelope)
  * @requiredField ribbon
  * @requiredField ribbon.name
  * @permissionId WIX_STORES.RIBBON_CREATE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -657,14 +829,20 @@ export declare function createRibbon(ribbon: Ribbon): Promise<Ribbon & RibbonNon
  * @documentationMaturity preview
  * @requiredField ribbonId
  * @permissionId WIX_STORES.RIBBON_READ
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read ribbons in v3 catalog
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
  * @permissionScope Read v3 catalog
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
  * @permissionScope Read Products
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Product write in v3 catalog
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
  * @permissionScope Manage v3 catalog
@@ -681,6 +859,7 @@ export interface GetRibbonOptions {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -698,6 +877,8 @@ export interface GetRibbonOptions {
  * @requiredField ribbon
  * @requiredField ribbon.revision
  * @permissionId WIX_STORES.RIBBON_UPDATE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -714,6 +895,7 @@ export declare function updateRibbon(_id: string | null, ribbon: UpdateRibbon, o
 export interface UpdateRibbon {
     /**
      * Ribbon ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -736,7 +918,11 @@ export interface UpdateRibbon {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Ribbon name. */
+    /**
+     * Ribbon name.
+     * @minLength 1
+     * @maxLength 30
+     */
     name?: string;
     /**
      * Number of products this ribbon is assigned to.
@@ -750,6 +936,7 @@ export interface UpdateRibbonOptions {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -763,6 +950,8 @@ export interface UpdateRibbonOptions {
  * @documentationMaturity preview
  * @requiredField ribbonId
  * @permissionId WIX_STORES.RIBBON_DELETE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -793,14 +982,20 @@ export declare function deleteRibbon(ribbonId: string): Promise<void>;
  * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
  * @public
  * @documentationMaturity preview
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read ribbons in v3 catalog
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
  * @permissionScope Read v3 catalog
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
  * @permissionScope Read Products
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Product write in v3 catalog
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
  * @permissionScope Manage v3 catalog
@@ -817,6 +1012,7 @@ export interface QueryRibbonsOptions {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[] | undefined;
 }
@@ -905,6 +1101,8 @@ export interface RibbonsQueryBuilder {
  * @requiredField ribbons
  * @requiredField ribbons.name
  * @permissionId WIX_STORES.RIBBON_CREATE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -938,6 +1136,8 @@ export interface BulkCreateRibbonsOptions {
  * @requiredField ribbons.ribbon._id
  * @requiredField ribbons.ribbon.revision
  * @permissionId WIX_STORES.RIBBON_UPDATE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -961,6 +1161,7 @@ export interface BulkUpdateRibbonsOptions {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -971,6 +1172,8 @@ export interface BulkUpdateRibbonsOptions {
  * @documentationMaturity preview
  * @requiredField ribbonName
  * @permissionId WIX_STORES.RIBBON_GET_OR_CREATE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -988,6 +1191,7 @@ export interface GetOrCreateRibbonOptions {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -998,6 +1202,8 @@ export interface GetOrCreateRibbonOptions {
  * @documentationMaturity preview
  * @requiredField ribbonNames
  * @permissionId WIX_STORES.RIBBON_GET_OR_CREATE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog
@@ -1015,6 +1221,7 @@ export interface BulkGetOrCreateRibbonsOptions {
      * Fields to include in the response.
      *
      * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
      */
     fields?: RequestedFields[];
 }
@@ -1025,6 +1232,8 @@ export interface BulkGetOrCreateRibbonsOptions {
  * @documentationMaturity preview
  * @requiredField ribbonIds
  * @permissionId WIX_STORES.RIBBON_DELETE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Products
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
  * @permissionScope Ribbon write in v3 catalog