@wix/auto_sdk_blog_categories 1.0.21 → 1.0.23

package/build/cjs/meta.d.ts

@@ -156,6 +156,39 @@ interface Image {
      */
     filename?: string | null;
 }
+interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
+interface CategoryTranslation {
+    /**
+     * Category ID.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Label displayed in the categories menu on the site.
+     * @maxLength 100
+     */
+    label?: string | null;
+    /**
+     * Language of the category.
+     * @format LANGUAGE_TAG
+     */
+    language?: string | null;
+    /** URL of this category page. */
+    url?: PageUrl;
+}
+interface InitialCategoriesCopied {
+    /** Number of categories copied. */
+    count?: number;
+}
 interface CreateCategoryRequest {
     /** Category info. */
     category: Category;
@@ -182,6 +215,94 @@ interface CreateCategoryResponse {
     /** Category info. */
     category?: Category;
 }
+interface BulkCreateCategoriesRequest {
+    /**
+     * Categories to create.
+     * @minSize 1
+     * @maxSize 50
+     */
+    categories?: Category[];
+    /** Whether to return the full created category entities in the response. */
+    returnFullEntity?: boolean;
+    /**
+     * List of additional category fields to include in the response. By default
+     * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
+     *
+     * 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?: FieldWithLiterals[];
+}
+interface BulkCreateCategoriesResponse {
+    /** Categories created by bulk action. */
+    results?: BulkCategoryResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkCategoryResult {
+    /** Bulk actions metadata for category. */
+    itemMetadata?: ItemMetadata;
+    /** Optional created category. */
+    item?: Category;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    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. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdateCategoriesRequest {
+    /**
+     * Categories to update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    categories?: MaskedCategory[];
+    /** Whether to return the full created category entities in the response. */
+    returnFullEntity?: boolean;
+    /**
+     * List of additional category fields to include in the response. By default
+     * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
+     *
+     * 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?: FieldWithLiterals[];
+}
+interface MaskedCategory {
+    /** Category */
+    category?: Category;
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+}
+interface BulkUpdateCategoriesResponse {
+    /** Categories updated by bulk action. */
+    results?: BulkCategoryResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
 interface UpdateCategoryRequest {
     /** Category info. */
     category: Category;
@@ -199,6 +320,21 @@ interface UpdateCategoryResponse {
     /** Category info. */
     category?: Category;
 }
+interface GetCategoriesCountByLanguageRequest {
+}
+interface GetCategoriesCountByLanguageResponse {
+    /** The language and it's count. */
+    categoriesLanguageCount?: CategoryLanguageCount[];
+}
+interface CategoryLanguageCount {
+    /**
+     * 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;
+}
 interface GetCategoryRequest {
     /**
      * Category ID.
@@ -422,6 +558,19 @@ interface Cursors {
      */
     prev?: string | null;
 }
+interface BulkDeleteCategoryRequest {
+    /**
+     * Category IDs.
+     * @minSize 1
+     * @maxSize 100
+     * @maxLength 38
+     */
+    categoryIds?: string[];
+    /** Should delete bypassing the trash-bin. */
+    permanent?: boolean;
+}
+interface BulkDeleteCategoryResponse {
+}
 interface DeleteCategoryRequest {
     /**
      * Category ID.
@@ -432,6 +581,142 @@ interface DeleteCategoryRequest {
 }
 interface DeleteCategoryResponse {
 }
+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;
+    /**
+     * 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;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * 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.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * 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.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -459,4 +744,4 @@ declare function deleteCategory(): __PublicMethodMetaInfo<'DELETE', {
     categoryId: string;
 }, DeleteCategoryRequest$1, DeleteCategoryRequest, DeleteCategoryResponse$1, DeleteCategoryResponse>;
 
-export { type __PublicMethodMetaInfo, createCategory, deleteCategory, getCategory, getCategoryBySlug, listCategories, queryCategories, updateCategory };
+export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BlogPaging as BlogPagingOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCategoryResult as BulkCategoryResultOriginal, type BulkCreateCategoriesRequest as BulkCreateCategoriesRequestOriginal, type BulkCreateCategoriesResponse as BulkCreateCategoriesResponseOriginal, type BulkDeleteCategoryRequest as BulkDeleteCategoryRequestOriginal, type BulkDeleteCategoryResponse as BulkDeleteCategoryResponseOriginal, type BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequestOriginal, type BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponseOriginal, type CategoryLanguageCount as CategoryLanguageCountOriginal, type Category as CategoryOriginal, type CategoryTranslation as CategoryTranslationOriginal, type CreateCategoryRequest as CreateCategoryRequestOriginal, type CreateCategoryResponse as CreateCategoryResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteCategoryRequest as DeleteCategoryRequestOriginal, type DeleteCategoryResponse as DeleteCategoryResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Field as FieldOriginal, type FieldWithLiterals as FieldWithLiteralsOriginal, type FocalPoint as FocalPointOriginal, type GetCategoriesCountByLanguageRequest as GetCategoriesCountByLanguageRequestOriginal, type GetCategoriesCountByLanguageResponse as GetCategoriesCountByLanguageResponseOriginal, type GetCategoryBySlugRequest as GetCategoryBySlugRequestOriginal, type GetCategoryBySlugResponse as GetCategoryBySlugResponseOriginal, type GetCategoryRequest as GetCategoryRequestOriginal, type GetCategoryResponse as GetCategoryResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InitialCategoriesCopied as InitialCategoriesCopiedOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type ListCategoriesRequest as ListCategoriesRequestOriginal, type ListCategoriesResponse as ListCategoriesResponseOriginal, type MaskedCategory as MaskedCategoryOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type PageUrl as PageUrlOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, type QueryCategoriesRequest as QueryCategoriesRequestOriginal, type QueryCategoriesResponse as QueryCategoriesResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Tag as TagOriginal, type UpdateCategoryRequest as UpdateCategoryRequestOriginal, type UpdateCategoryResponse as UpdateCategoryResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createCategory, deleteCategory, getCategory, getCategoryBySlug, listCategories, queryCategories, updateCategory };

package/build/cjs/meta.js

@@ -20,6 +20,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // meta.ts
 var meta_exports = {};
 __export(meta_exports, {
+  FieldOriginal: () => Field,
+  SortOrderOriginal: () => SortOrder,
+  WebhookIdentityTypeOriginal: () => WebhookIdentityType,
   createCategory: () => createCategory2,
   deleteCategory: () => deleteCategory2,
   getCategory: () => getCategory2,
@@ -176,6 +179,9 @@ function createCategory(payload) {
       method: "POST",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.CreateCategory",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         { protoPath: "/v3/categories", data: serializedData, host }
       ),
@@ -228,6 +234,9 @@ function updateCategory(payload) {
       method: "PATCH",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.UpdateCategory",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         {
           protoPath: "/v3/categories/{category.id}",
@@ -264,6 +273,9 @@ function getCategory(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategory",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         { protoPath: "/v3/categories/{categoryId}", data: payload, host }
       ),
@@ -296,6 +308,9 @@ function getCategoryBySlug(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategoryBySlug",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         { protoPath: "/v3/categories/slugs/{slug}", data: payload, host }
       ),
@@ -328,6 +343,9 @@ function listCategories(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.ListCategories",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         { protoPath: "/v3/categories", data: payload, host }
       ),
@@ -360,6 +378,9 @@ function queryCategories(payload) {
       method: "POST",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.QueryCategories",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         { protoPath: "/v3/categories/query", data: payload, host }
       ),
@@ -392,6 +413,9 @@ function deleteCategory(payload) {
       method: "DELETE",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.CategoryService.DeleteCategory",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3CategoryServiceUrl(
         { protoPath: "/v3/categories/{categoryId}", data: payload, host }
       ),
@@ -402,6 +426,27 @@ function deleteCategory(payload) {
   return __deleteCategory;
 }
 
+// src/blog-v3-category-categories.types.ts
+var Field = /* @__PURE__ */ ((Field2) => {
+  Field2["UNKNOWN"] = "UNKNOWN";
+  Field2["URL"] = "URL";
+  Field2["SEO"] = "SEO";
+  return Field2;
+})(Field || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+
 // src/blog-v3-category-categories.meta.ts
 function createCategory2() {
   const payload = {};
@@ -531,6 +576,9 @@ function deleteCategory2() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  FieldOriginal,
+  SortOrderOriginal,
+  WebhookIdentityTypeOriginal,
   createCategory,
   deleteCategory,
   getCategory,