@wix/blog 1.0.113

package/build/cjs/src/blog-v3-tag.universal.d.ts

@@ -0,0 +1,512 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Tag {
+    /**
+     * Tag ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Tag label.
+     *
+     *
+     * A blog cannot have two tags with the same label.
+     */
+    label?: string;
+    /**
+     * Part of a tag's URL that refers to a specific tag.
+     *
+     *
+     * For example, `'https:/example.com/tags/{my-tag-slug}'`.
+     */
+    slug?: string;
+    /**
+     * Date the tag was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date the tag was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Number of posts with this tag, including unpublished draft posts.
+     * @readonly
+     */
+    postCount?: number;
+    /**
+     * Tag URL.
+     *
+     *
+     * The `url` directs you to a page that lists every post with the specified tag.
+     * @readonly
+     */
+    url?: string;
+    /**
+     * Number of published posts with this tag.
+     * @readonly
+     */
+    publishedPostCount?: number;
+    /**
+     * ID of the tag's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single tag will share the same `translationId`.
+     * @readonly
+     */
+    translationId?: string | null;
+    /**
+     * Tag language.
+     *
+     *
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * @readonly
+     */
+    language?: string | null;
+}
+export interface GetOrCreateTagRequest {
+    /** Tag name. Unique per blog. */
+    label?: string;
+    /** Tag language. */
+    language?: string;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export declare enum Field {
+    UNKNOWN = "UNKNOWN",
+    /** Includes Tag URL when present. */
+    URL = "URL"
+}
+export interface GetOrCreateTagResponse {
+    /** Tag info. */
+    tag?: Tag;
+}
+export interface CreateTagRequest {
+    /** Tag label. Unique per blog. */
+    label: string;
+    /** Tag language. */
+    language?: string;
+    /** Preferred tag slug. For example, 'tag-slug'. */
+    slug?: string | null;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface CreateTagResponse {
+    /** Tag info. */
+    tag?: Tag;
+}
+export interface UpdateTagRequest {
+    /** Tag info. */
+    tag?: Tag;
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface UpdateTagResponse {
+    /** Tag info. */
+    tag?: Tag;
+}
+export interface BulkCreateTagsRequest {
+    /** Tags to create. */
+    tags?: Tag[];
+    /** Whether to return the full created tag entities in the response. */
+    returnFullEntity?: boolean;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface BulkCreateTagsResponse {
+    /** Tags created by bulk action. */
+    results?: BulkTagResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkTagResult {
+    /** Bulk actions metadata for tag. */
+    itemMetadata?: ItemMetadata;
+    /** Optional created tag. */
+    item?: Tag;
+}
+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 {
+    code?: string;
+    description?: string;
+    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 GetTagByLabelRequest {
+    /** Tag label. */
+    label: string;
+    /** Tag language. */
+    language?: string | null;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetTagByLabelResponse {
+    /** Tag info. */
+    tag?: Tag;
+}
+export interface GetTagRequest {
+    /** Tag ID. */
+    tagId: string;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetTagResponse {
+    /** Tag info. */
+    tag?: Tag;
+}
+export interface GetTagBySlugRequest {
+    /** Slug of the tag to retrieve. */
+    slug: string;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetTagBySlugResponse {
+    /** Tag info. */
+    tag?: Tag;
+}
+export interface QueryTagsRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface TagsFieldSet {
+    /** Includes tag URL when TRUE. Defaults to FALSE. */
+    includeUrl?: boolean;
+}
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+    /**
+     * 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"}]`
+     */
+    sort?: Sorting[];
+    /** 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;
+}
+/** @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 CursorPaging {
+    /** Number of items to load. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface QueryTagsResponse {
+    /** List of tags. */
+    tags?: Tag[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadataV2;
+}
+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. */
+    cursor?: string | null;
+}
+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. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface ListTagsRequest extends ListTagsRequestPagingMethodOneOf {
+    /** Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort). */
+    sort?: Sorting[];
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+    /** 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 `sort`. */
+    cursorPaging?: CursorPaging;
+}
+/** @oneof */
+export interface ListTagsRequestPagingMethodOneOf {
+    /** 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 `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface ListTagsResponse {
+    /** List of tags. */
+    tags?: Tag[];
+    /** Details on the paged set of results returned. */
+    metaData?: MetaData;
+}
+export interface DeleteTagRequest {
+    /** Tag ID. */
+    tagId: string;
+}
+export interface DeleteTagResponse {
+}
+/**
+ * Creates a new tag with the provided label if the tag does not exist.
+ * @param label - Tag label. Unique per blog.
+ * @public
+ * @requiredField label
+ */
+export declare function createTag(label: string, options?: CreateTagOptions): Promise<CreateTagResponse>;
+export interface CreateTagOptions {
+    /** Tag language. */
+    language?: string;
+    /** Preferred tag slug. For example, 'tag-slug'. */
+    slug?: string | null;
+    /**
+     * List of tag fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core tag properties.
+     * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Gets a tag by the specified label.
+ *
+ * The `getTagByLabel()` function returns a Promise that resolves to a tag whose label matches the specified label.
+ * @param label - Tag label.
+ * @public
+ * @requiredField GetTagByLabelRequest
+ * @requiredField label
+ * @param options - Options specifying which additional fields to return.
+ */
+export declare function getTagByLabel(label: string, options?: GetTagByLabelOptions): Promise<GetTagByLabelResponse>;
+export interface GetTagByLabelOptions {
+    /** Tag language. */
+    language?: string | null;
+    /**
+     * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.
+     *
+     * Supported Values:
+     *  `"URL"`
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Gets a tag by the specified ID.
+ *
+ *
+ * The `getTag()` function returns a Promise that resolves to a tag whose ID matches the specified ID.
+ * @param tagId - Tag ID.
+ * @public
+ * @requiredField tagId
+ * @param options - Options specifying which additional fields to return.
+ */
+export declare function getTag(tagId: string, options?: GetTagOptions): Promise<GetTagResponse>;
+export interface GetTagOptions {
+    /**
+     * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.
+     *
+     * Supported Values:
+     *  `"URL"`
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Gets a tag by the specified slug.
+ *
+ *
+ * The `getTagBySlug()` function returns a Promise that resolves to a tag whose slug matches the specified slug.
+ *
+ * The `slug` is the end of a tag's URL that refers to a specific tag. For example, if a tag's URL is `https://example.com/blog/tag/{my-tag-slug}`, the slug is `my-tag-slug`. The slug is case-sensitive and derived from the tag's `label`.
+ * @param slug - Slug of the tag to retrieve.
+ * @public
+ * @requiredField slug
+ * @param options - Options specifying which additional fields to return.
+ */
+export declare function getTagBySlug(slug: string, options?: GetTagBySlugOptions): Promise<GetTagBySlugResponse>;
+export interface GetTagBySlugOptions {
+    /**
+     * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.
+     *
+     * Supported Values:
+     *  `"URL"`
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Creates a query to retrieve a list of tags.
+ *
+ *
+ * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `TagsQueryBuilder` functions onto the query. `TagsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTags()` returns.
+ *
+ * `queryTags()` runs with these `TagsQueryBuilder` defaults that can be overridden:
+ * - `limit(50)`
+ * - `ascending('_id')`
+ *
+ * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/post/queryposts).
+ * @public */
+export declare function queryTags(): TagsQueryBuilder;
+interface QueryOffsetResult {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface TagsQueryResult extends QueryOffsetResult {
+    items: Tag[];
+    query: TagsQueryBuilder;
+    next: () => Promise<TagsQueryResult>;
+    prev: () => Promise<TagsQueryResult>;
+}
+export interface TagsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: string, value: any) => TagsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: string, value: any) => TagsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: string, value: any) => TagsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: string, value: any) => TagsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: string, value: any) => TagsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: string, value: any) => TagsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: string, value: string) => TagsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: string[]) => TagsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: string[]) => TagsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => TagsQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results. */
+    skip: (skip: number) => TagsQueryBuilder;
+    find: () => Promise<TagsQueryResult>;
+}
+/**
+ * Deletes a tag.
+ * @param tagId - Tag ID.
+ * @public
+ * @requiredField tagId
+ */
+export declare function deleteTag(tagId: string): Promise<void>;
+export {};