@wix/auto_sdk_blog_categories 1.0.1 → 1.0.3

package/build/cjs/src/blog-v3-category-categories.types.d.ts

@@ -1,7 +1,14 @@
 export interface Category {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @immutable
+     * @maxLength 38
+     */
     id?: string;
-    /** Category label. Displayed in the Category Menu. */
+    /**
+     * Category label. Displayed in the Category Menu.
+     * @maxLength 35
+     */
     label?: string;
     /**
      * Number of posts in the category.
@@ -13,10 +20,14 @@ export interface Category {
      * @readonly
      */
     url?: PageUrl;
-    /** Category description. */
+    /**
+     * Category description.
+     * @maxLength 500
+     */
     description?: string | null;
     /**
      * Category title.
+     * @maxLength 200
      * @deprecated Category title.
      * @targetRemovalDate 2025-07-16
      */
@@ -28,21 +39,23 @@ export interface Category {
      * Default: `-1`
      */
     displayPosition?: number | null;
-    /** ID of the category's translations. All translations of a single category share the same `translationId`. */
+    /**
+     * ID of the category's translations. All translations of a single category share the same `translationId`.
+     * @format GUID
+     */
     translationId?: string | null;
     /**
      * Category language.
      *
      * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * @immutable
      */
     language?: string | null;
-    /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */
-    slug?: string;
     /**
-     * Reserved for internal use.
-     * @readonly
+     * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
+     * @maxLength 100
      */
-    internalId?: string | null;
+    slug?: string;
     /** SEO data. */
     seoData?: SeoSchema;
     /** Category cover image. */
@@ -75,7 +88,10 @@ export interface Keyword {
     term?: string;
     /** Whether the keyword is the main focus keyword. */
     isMain?: boolean;
-    /** The source that added the keyword terms to the SEO settings. */
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
     origin?: string | null;
 }
 export interface Tag {
@@ -108,7 +124,10 @@ export interface Settings {
      * Default: `false` (Auto Redirect is enabled.)
      */
     preventAutoRedirect?: boolean;
-    /** User-selected keyword terms for a specific page. */
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
     keywords?: Keyword[];
 }
 export interface Image {
@@ -145,11 +164,20 @@ export interface FocalPoint {
     width?: number | null;
 }
 export interface CategoryTranslation {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     id?: string;
-    /** Label displayed in the categories menu on the site. */
+    /**
+     * Label displayed in the categories menu on the site.
+     * @maxLength 100
+     */
     label?: string | null;
-    /** Language of the category. */
+    /**
+     * Language of the category.
+     * @format LANGUAGE_TAG
+     */
     language?: string | null;
     /** URL of this category page. */
     url?: PageUrl;
@@ -167,6 +195,7 @@ export interface CreateCategoryRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
 }
@@ -174,11 +203,6 @@ export declare enum Field {
     UNKNOWN = "UNKNOWN",
     /** Includes Category url. */
     URL = "URL",
-    /**
-     * Includes internal id field.
-     * Reserved for internal use
-     */
-    INTERNAL_ID = "INTERNAL_ID",
     /** Includes SEO data. */
     SEO = "SEO"
 }
@@ -187,7 +211,11 @@ export interface CreateCategoryResponse {
     category?: Category;
 }
 export interface BulkCreateCategoriesRequest {
-    /** Categories to create. */
+    /**
+     * Categories to create.
+     * @minSize 1
+     * @maxSize 50
+     */
     categories?: Category[];
     /** Whether to return the full created category entities in the response. */
     returnFullEntity?: boolean;
@@ -197,6 +225,7 @@ export interface BulkCreateCategoriesRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
 }
@@ -239,7 +268,11 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface BulkUpdateCategoriesRequest {
-    /** Categories to update. */
+    /**
+     * Categories to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     categories?: MaskedCategory[];
     /** Whether to return the full created category entities in the response. */
     returnFullEntity?: boolean;
@@ -249,6 +282,7 @@ export interface BulkUpdateCategoriesRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
 }
@@ -273,6 +307,7 @@ export interface UpdateCategoryRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
 }
@@ -287,13 +322,20 @@ export interface GetCategoriesCountByLanguageResponse {
     categoriesLanguageCount?: CategoryLanguageCount[];
 }
 export interface CategoryLanguageCount {
-    /** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
+    /**
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * @format LANGUAGE_TAG
+     */
     languageCode?: string | null;
     /** The count of Categories for the language. */
     categoryCount?: number | null;
 }
 export interface GetCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @minLength 1
+     * @maxLength 38
+     */
     categoryId: string;
     /**
      * List of additional category fields to include in the response. By default
@@ -301,6 +343,7 @@ export interface GetCategoryRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
 }
@@ -309,7 +352,11 @@ export interface GetCategoryResponse {
     category?: Category;
 }
 export interface GetCategoryBySlugRequest {
-    /** Slug of the category to retrieve. */
+    /**
+     * Slug of the category to retrieve.
+     * @minLength 1
+     * @maxLength 100
+     */
     slug: string;
     /**
      * List of additional category fields to include in the response. By default
@@ -317,11 +364,13 @@ export interface GetCategoryBySlugRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
     /**
      * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
      * Language of the category to retrieve.
+     * @format LANGUAGE_TAG
      */
     language?: string | null;
 }
@@ -338,6 +387,7 @@ export interface ListCategoriesRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
     /**
@@ -346,6 +396,7 @@ export interface ListCategoriesRequest {
      * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
      * Pass a language to only receive categories that are in that language.
      * If omitted, categories in all languages are returned.
+     * @format LANGUAGE_TAG
      */
     language?: string | null;
 }
@@ -362,9 +413,14 @@ export interface BlogPaging {
      *
      *
      * Default:`50`
+     * @min 1
+     * @max 100
      */
     limit?: number;
-    /** Pointer to the next or previous page in the list of results. */
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * @maxLength 2000
+     */
     cursor?: string | null;
 }
 export interface ListCategoriesResponse {
@@ -380,7 +436,10 @@ export interface MetaData {
     offset?: number;
     /** Total number of items that match the query. */
     total?: number;
-    /** Pointer to the next or previous page in the list of results. */
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * @maxLength 2000
+     */
     cursor?: string | null;
 }
 export interface QueryCategoriesRequest {
@@ -392,6 +451,7 @@ export interface QueryCategoriesRequest {
      *
      * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
      * retrieve the url field in the response in addition to the category’s base fields.
+     * @maxSize 10
      */
     fieldsets?: Field[];
 }
@@ -412,6 +472,7 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 3
      */
     sort?: Sorting[];
 }
@@ -423,7 +484,10 @@ export interface PlatformQueryPagingMethodOneOf {
     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;
@@ -433,13 +497,19 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface Paging {
-    /** Number of items to load. */
+    /**
+     * Number of items to load.
+     * @max 100
+     */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Number of items to load. */
+    /**
+     * Number of items to load.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
@@ -447,6 +517,7 @@ export interface CursorPaging {
      * You can get the relevant cursor token
      * from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 2000
      */
     cursor?: string | null;
 }
@@ -469,13 +540,24 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
+    /**
+     * Cursor pointing to next page in the list of results.
+     * @maxLength 2000
+     */
     next?: string | null;
-    /** Cursor pointing to previous page in the list of results. */
+    /**
+     * Cursor pointing to previous page in the list of results.
+     * @maxLength 2000
+     */
     prev?: string | null;
 }
 export interface BulkDeleteCategoryRequest {
-    /** Category IDs. */
+    /**
+     * Category IDs.
+     * @minSize 1
+     * @maxSize 100
+     * @maxLength 38
+     */
     categoryIds?: string[];
     /** Should delete bypassing the trash-bin. */
     permanent?: boolean;
@@ -483,7 +565,11 @@ export interface BulkDeleteCategoryRequest {
 export interface BulkDeleteCategoryResponse {
 }
 export interface DeleteCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @minLength 1
+     * @maxLength 38
+     */
     categoryId: string;
 }
 export interface DeleteCategoryResponse {
@@ -561,9 +647,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 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;
@@ -571,26 +663,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/blog-v3-category-categories.types.js

@@ -6,11 +6,6 @@ var Field;
     Field["UNKNOWN"] = "UNKNOWN";
     /** Includes Category url. */
     Field["URL"] = "URL";
-    /**
-     * Includes internal id field.
-     * Reserved for internal use
-     */
-    Field["INTERNAL_ID"] = "INTERNAL_ID";
     /** Includes SEO data. */
     Field["SEO"] = "SEO";
 })(Field || (exports.Field = Field = {}));

package/build/cjs/src/blog-v3-category-categories.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"blog-v3-category-categories.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category-categories.types.ts"],"names":[],"mappings":";;;AAuLA,IAAY,KAWX;AAXD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,6BAA6B;IAC7B,oBAAW,CAAA;IACX;;;OAGG;IACH,oCAA2B,CAAA;IAC3B,yBAAyB;IACzB,oBAAW,CAAA;AACb,CAAC,EAXW,KAAK,qBAAL,KAAK,QAWhB;AAkRD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAoLD,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":"blog-v3-category-categories.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category-categories.types.ts"],"names":[],"mappings":";;;AAoNA,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,6BAA6B;IAC7B,oBAAW,CAAA;IACX,yBAAyB;IACzB,oBAAW,CAAA;AACb,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AA0TD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAwOD,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"}