npm - @wix/auto_sdk_blog_categories - Versions diffs - 1.0.5 → 1.0.6 - Mend

@wix/auto_sdk_blog_categories 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (126) hide show

package/build/{internal/cjs/src/blog-v3-category-categories.types.d.ts → meta.d.ts} RENAMED Viewed

@@ -1,4 +1,6 @@
-export interface Category {
+import { l as CreateCategoryRequest$1, m as CreateCategoryResponse$1, t as UpdateCategoryRequest$1, u as UpdateCategoryResponse$1, y as GetCategoryRequest$1, c as GetCategoryResponse$1, z as GetCategoryBySlugRequest$1, e as GetCategoryBySlugResponse$1, D as ListCategoriesRequest$1, f as ListCategoriesResponse$1, J as QueryCategoriesRequest$1, X as QueryCategoriesResponse$1, a0 as DeleteCategoryRequest$1, a1 as DeleteCategoryResponse$1 } from './blog-v3-category-categories.universal-CF5HyUlx.js';
+interface Category {
     /**
      * Category ID.
      * @immutable
@@ -66,7 +68,7 @@ export interface Category {
      */
     updatedDate?: Date | null;
 }
-export interface PageUrl {
+interface PageUrl {
     /** The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`. */
     base?: string;
     /** The relative path for the page within the site. For example, `/product-page/a-product`. */
@@ -77,13 +79,13 @@ export interface PageUrl {
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
  * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
  */
-export interface SeoSchema {
+interface SeoSchema {
     /** SEO tag information. */
     tags?: Tag[];
     /** SEO general settings. */
     settings?: Settings;
 }
-export interface Keyword {
+interface Keyword {
     /** Keyword value. */
     term?: string;
     /** Whether the keyword is the main focus keyword. */
@@ -94,7 +96,7 @@ export interface Keyword {
      */
     origin?: string | null;
 }
-export interface Tag {
+interface Tag {
     /**
      * SEO tag type.
      *
@@ -116,7 +118,7 @@ export interface Tag {
     /** Whether the tag is disabled. */
     disabled?: boolean;
 }
-export interface Settings {
+interface Settings {
     /**
      * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
      *
@@ -130,7 +132,7 @@ export interface Settings {
      */
     keywords?: Keyword[];
 }
-export interface Image {
+interface Image {
     /** WixMedia image ID. */
     id?: string;
     /** Image URL. */
@@ -153,40 +155,7 @@ export interface Image {
      */
     filename?: string | null;
 }
-export 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;
-}
-export 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;
-}
-export interface InitialCategoriesCopied {
-    /** Number of categories copied. */
-    count?: number;
-}
-export interface CreateCategoryRequest {
+interface CreateCategoryRequest {
     /** Category info. */
     category: Category;
     /**
@@ -199,106 +168,18 @@ export interface CreateCategoryRequest {
      */
     fieldsets?: Field[];
 }
-export declare enum Field {
+declare enum Field {
     UNKNOWN = "UNKNOWN",
     /** Includes Category url. */
     URL = "URL",
     /** Includes SEO data. */
     SEO = "SEO"
 }
-export interface CreateCategoryResponse {
+interface CreateCategoryResponse {
     /** Category info. */
     category?: Category;
 }
-export 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?: Field[];
-}
-export interface BulkCreateCategoriesResponse {
-    /** Categories created by bulk action. */
-    results?: BulkCategoryResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkCategoryResult {
-    /** Bulk actions metadata for category. */
-    itemMetadata?: ItemMetadata;
-    /** Optional created category. */
-    item?: Category;
-}
-export 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;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export 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;
-}
-export 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?: Field[];
-}
-export interface MaskedCategory {
-    /** Category */
-    category?: Category;
-    /** Field mask of fields to update. */
-    fieldMask?: string[];
-}
-export interface BulkUpdateCategoriesResponse {
-    /** Categories updated by bulk action. */
-    results?: BulkCategoryResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface UpdateCategoryRequest {
+interface UpdateCategoryRequest {
     /** Category info. */
     category: Category;
     /**
@@ -311,26 +192,11 @@ export interface UpdateCategoryRequest {
      */
     fieldsets?: Field[];
 }
-export interface UpdateCategoryResponse {
+interface UpdateCategoryResponse {
     /** Category info. */
     category?: Category;
 }
-export interface GetCategoriesCountByLanguageRequest {
-}
-export interface GetCategoriesCountByLanguageResponse {
-    /** The language and it's count. */
-    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.
-     * @format LANGUAGE_TAG
-     */
-    languageCode?: string | null;
-    /** The count of Categories for the language. */
-    categoryCount?: number | null;
-}
-export interface GetCategoryRequest {
+interface GetCategoryRequest {
     /**
      * Category ID.
      * @minLength 1
@@ -347,11 +213,11 @@ export interface GetCategoryRequest {
      */
     fieldsets?: Field[];
 }
-export interface GetCategoryResponse {
+interface GetCategoryResponse {
     /** Category info. */
     category?: Category;
 }
-export interface GetCategoryBySlugRequest {
+interface GetCategoryBySlugRequest {
     /**
      * Slug of the category to retrieve.
      * @minLength 1
@@ -374,11 +240,11 @@ export interface GetCategoryBySlugRequest {
      */
     language?: string | null;
 }
-export interface GetCategoryBySlugResponse {
+interface GetCategoryBySlugResponse {
     /** Category info. */
     category?: Category;
 }
-export interface ListCategoriesRequest {
+interface ListCategoriesRequest {
     /** Pagination options. */
     paging?: BlogPaging;
     /**
@@ -400,7 +266,7 @@ export interface ListCategoriesRequest {
      */
     language?: string | null;
 }
-export interface BlogPaging {
+interface BlogPaging {
     /**
      * Number of items to skip in the current sort order.
      *
@@ -423,13 +289,13 @@ export interface BlogPaging {
      */
     cursor?: string | null;
 }
-export interface ListCategoriesResponse {
+interface ListCategoriesResponse {
     /** List of categories. */
     categories?: Category[];
     /** Details on the paged set of results returned. */
     metaData?: MetaData;
 }
-export interface MetaData {
+interface MetaData {
     /** Number of items returned in this response. */
     count?: number;
     /** Requested offset. */
@@ -442,7 +308,7 @@ export interface MetaData {
      */
     cursor?: string | null;
 }
-export interface QueryCategoriesRequest {
+interface QueryCategoriesRequest {
     /** Query options. */
     query?: PlatformQuery;
     /**
@@ -455,7 +321,7 @@ export interface QueryCategoriesRequest {
      */
     fieldsets?: Field[];
 }
-export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** 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`. */
@@ -477,13 +343,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface PlatformQueryPagingMethodOneOf {
+interface PlatformQueryPagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** 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
@@ -492,11 +358,11 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface Paging {
+interface Paging {
     /**
      * Number of items to load.
      * @max 100
@@ -505,7 +371,7 @@ export interface Paging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Number of items to load.
      * @max 100
@@ -521,13 +387,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryCategoriesResponse {
+interface QueryCategoriesResponse {
     /** List of categories. */
     categories?: Category[];
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -539,7 +405,7 @@ export interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor pointing to next page in the list of results.
      * @maxLength 2000
@@ -551,20 +417,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface BulkDeleteCategoryRequest {
-    /**
-     * Category IDs.
-     * @minSize 1
-     * @maxSize 100
-     * @maxLength 38
-     */
-    categoryIds?: string[];
-    /** Should delete bypassing the trash-bin. */
-    permanent?: boolean;
-}
-export interface BulkDeleteCategoryResponse {
-}
-export interface DeleteCategoryRequest {
+interface DeleteCategoryRequest {
     /**
      * Category ID.
      * @minLength 1
@@ -572,147 +425,33 @@ export interface DeleteCategoryRequest {
      */
     categoryId: string;
 }
-export interface DeleteCategoryResponse {
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * 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 defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export 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;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export 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;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export 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;
-}
-export 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?: WebhookIdentityType;
-}
-/** @oneof */
-export 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;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
+interface DeleteCategoryResponse {
+}
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createCategory(): __PublicMethodMetaInfo<'POST', {}, CreateCategoryRequest$1, CreateCategoryRequest, CreateCategoryResponse$1, CreateCategoryResponse>;
+declare function updateCategory(): __PublicMethodMetaInfo<'PATCH', {
+    categoryId: string;
+}, UpdateCategoryRequest$1, UpdateCategoryRequest, UpdateCategoryResponse$1, UpdateCategoryResponse>;
+declare function getCategory(): __PublicMethodMetaInfo<'GET', {
+    categoryId: string;
+}, GetCategoryRequest$1, GetCategoryRequest, GetCategoryResponse$1, GetCategoryResponse>;
+declare function getCategoryBySlug(): __PublicMethodMetaInfo<'GET', {
+    slug: string;
+}, GetCategoryBySlugRequest$1, GetCategoryBySlugRequest, GetCategoryBySlugResponse$1, GetCategoryBySlugResponse>;
+declare function listCategories(): __PublicMethodMetaInfo<'GET', {}, ListCategoriesRequest$1, ListCategoriesRequest, ListCategoriesResponse$1, ListCategoriesResponse>;
+declare function queryCategories(): __PublicMethodMetaInfo<'POST', {}, QueryCategoriesRequest$1, QueryCategoriesRequest, QueryCategoriesResponse$1, QueryCategoriesResponse>;
+declare function deleteCategory(): __PublicMethodMetaInfo<'DELETE', {
+    categoryId: string;
+}, DeleteCategoryRequest$1, DeleteCategoryRequest, DeleteCategoryResponse$1, DeleteCategoryResponse>;
+export { type __PublicMethodMetaInfo, createCategory, deleteCategory, getCategory, getCategoryBySlug, listCategories, queryCategories, updateCategory };