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

@wix/auto_sdk_blog_categories 1.0.6 → 1.0.8

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 (130) hide show

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

@@ -0,0 +1,718 @@
+export interface Category {
+    /**
+     * Category ID.
+     * @immutable
+     * @maxLength 38
+     */
+    id?: string;
+    /**
+     * Category label. Displayed in the Category Menu.
+     * @maxLength 35
+     */
+    label?: string;
+    /**
+     * Number of posts in the category.
+     * @readonly
+     */
+    postCount?: number;
+    /**
+     * The `url` of the page that lists every post with the specified category.
+     * @readonly
+     */
+    url?: PageUrl;
+    /**
+     * Category description.
+     * @maxLength 500
+     */
+    description?: string | null;
+    /**
+     * Category title.
+     * @maxLength 200
+     * @deprecated Category title.
+     * @targetRemovalDate 2025-07-16
+     */
+    title?: string;
+    /**
+     * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
+     * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
+     *
+     * Default: `-1`
+     */
+    displayPosition?: number | null;
+    /**
+     * 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`.
+     * @maxLength 100
+     */
+    slug?: string;
+    /** SEO data. */
+    seoData?: SeoSchema;
+    /** Category cover image. */
+    coverImage?: Image;
+    /**
+     * Date and time the Category was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+export 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`. */
+    path?: string;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * 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 {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Keyword {
+    /** Keyword value. */
+    term?: string;
+    /** Whether the keyword is the main focus keyword. */
+    isMain?: boolean;
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
+    origin?: string | null;
+}
+export interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
+     * For example: `{"name": "description", "content": "the description itself"}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /**
+     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     *
+     *
+     * Default: `false` (Auto Redirect is enabled.)
+     */
+    preventAutoRedirect?: boolean;
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
+    keywords?: Keyword[];
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    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 {
+    /** Category info. */
+    category: Category;
+    /**
+     * 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 declare enum Field {
+    UNKNOWN = "UNKNOWN",
+    /** Includes category URL. */
+    URL = "URL",
+    /** Includes SEO data. */
+    SEO = "SEO"
+}
+export 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 {
+    /** Category info. */
+    category: Category;
+    /**
+     * 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 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 {
+    /**
+     * Category ID.
+     * @minLength 1
+     * @maxLength 38
+     */
+    categoryId: string;
+    /**
+     * 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 GetCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface GetCategoryBySlugRequest {
+    /**
+     * Slug of the category to retrieve.
+     * @minLength 1
+     * @maxLength 100
+     */
+    slug: string;
+    /**
+     * 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[];
+    /**
+     * 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;
+}
+export interface GetCategoryBySlugResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface ListCategoriesRequest {
+    /** Pagination options. */
+    paging?: BlogPaging;
+    /**
+     * 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[];
+    /**
+     * Language filter.
+     *
+     * 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;
+}
+export interface BlogPaging {
+    /**
+     * Number of items to skip in the current sort order.
+     *
+     *
+     * Default: `0`
+     */
+    offset?: number;
+    /**
+     * Number of items to return.
+     *
+     *
+     * Default:`50`
+     * @min 1
+     * @max 100
+     */
+    limit?: number;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * @maxLength 2000
+     */
+    cursor?: string | null;
+}
+export interface ListCategoriesResponse {
+    /** List of categories. */
+    categories?: Category[];
+    /** Details on the paged set of results returned. */
+    metaData?: MetaData;
+}
+export interface MetaData {
+    /** Number of items returned in this response. */
+    count?: number;
+    /** Requested offset. */
+    offset?: number;
+    /** Total number of items that match the query. */
+    total?: number;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * @maxLength 2000
+     */
+    cursor?: string | null;
+}
+export interface QueryCategoriesRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+    /**
+     * 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 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`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 3
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export 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 {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /**
+     * 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.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * 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;
+}
+export interface QueryCategoriesResponse {
+    /** List of categories. */
+    categories?: Category[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /**
+     * 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.
+     * @maxLength 2000
+     */
+    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 {
+    /**
+     * Category ID.
+     * @minLength 1
+     * @maxLength 38
+     */
+    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"
+}