@wix/auto_sdk_stores_ribbons-v-3 1.0.0 → 1.0.2

package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.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;
@@ -417,9 +530,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;
@@ -427,26 +546,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 {

package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"stores-catalog-v3-ribbon-ribbons-v-3.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v3-ribbon-ribbons-v-3.types.ts"],"names":[],"mappings":";;;AAyHA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sEAAmD,CAAA;IACnD,oEAAiD,CAAA;AACnD,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B;AAyED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,uBAAuB;IACvB,wBAAW,CAAA;IACX,wBAAwB;IACxB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA2SD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"stores-catalog-v3-ribbon-ribbons-v-3.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v3-ribbon-ribbons-v-3.types.ts"],"names":[],"mappings":";;;AA0KA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sEAAmD,CAAA;IACnD,oEAAiD,CAAA;AACnD,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B;AAkFD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,uBAAuB;IACvB,wBAAW,CAAA;IACX,wBAAwB;IACxB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAgYD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}