@wix/blog 1.0.113

package/build/es/src/blog-v3-tag.types.d.ts

@@ -0,0 +1,345 @@
+export interface Tag {
+    /**
+     * Tag ID.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Tag label.
+     *
+     *
+     * A blog cannot have two tags with the same label.
+     */
+    label?: string;
+    /** Tag slug. For example, '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.
+     * @readonly
+     */
+    url?: PageUrl;
+    /**
+     * Number of published posts with this tag.
+     * @readonly
+     */
+    publishedPostCount?: number;
+    /**
+     * ID of the tag translations.
+     *
+     *
+     * 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 PageUrl {
+    /** The base URL. For premium sites, this will be the domain. For free sites, this would be site URL (e.g mysite.wixsite.com/mysite) */
+    base?: string;
+    /** The path to that page - e.g /product-page/a-product */
+    path?: string;
+}
+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 {
+}

package/build/es/src/blog-v3-tag.types.js

@@ -0,0 +1,12 @@
+export var Field;
+(function (Field) {
+    Field["UNKNOWN"] = "UNKNOWN";
+    /** Includes Tag URL when present. */
+    Field["URL"] = "URL";
+})(Field || (Field = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+//# sourceMappingURL=blog-v3-tag.types.js.map

package/build/es/src/blog-v3-tag.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blog-v3-tag.types.js","sourceRoot":"","sources":["../../../src/blog-v3-tag.types.ts"],"names":[],"mappings":"AA8EA,MAAM,CAAN,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,qCAAqC;IACrC,oBAAW,CAAA;AACb,CAAC,EAJW,KAAK,KAAL,KAAK,QAIhB;AAsKD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}