@wix/auto_sdk_blog_posts 1.0.132 → 1.0.133
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.
- package/build/cjs/index.d.ts +15 -11
- package/build/cjs/index.js +36 -31
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +515 -503
- package/build/cjs/index.typings.js +26 -26
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +358 -358
- package/build/cjs/meta.js +20 -20
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +15 -11
- package/build/es/index.mjs +36 -31
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +515 -503
- package/build/es/index.typings.mjs +26 -26
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +358 -358
- package/build/es/meta.mjs +20 -20
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +15 -11
- package/build/internal/cjs/index.js +36 -31
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +515 -503
- package/build/internal/cjs/index.typings.js +26 -26
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +358 -358
- package/build/internal/cjs/meta.js +20 -20
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +15 -11
- package/build/internal/es/index.mjs +36 -31
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +515 -503
- package/build/internal/es/index.typings.mjs +26 -26
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +358 -358
- package/build/internal/es/meta.mjs +20 -20
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2396,125 +2396,433 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2396
2396
|
*/
|
|
2397
2397
|
anonymousVisitorId?: string | null;
|
|
2398
2398
|
}
|
|
2399
|
-
|
|
2400
|
-
interface QueryPublicationsCountStatsRequest {
|
|
2401
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2402
|
-
rangeStart?: Date | null;
|
|
2403
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2404
|
-
rangeEnd?: Date | null;
|
|
2405
|
-
/** Order of the returned results. */
|
|
2406
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2407
|
-
/** Number of months to include in the response. */
|
|
2408
|
-
months?: number;
|
|
2399
|
+
interface ListTemplatesRequest {
|
|
2409
2400
|
/**
|
|
2410
|
-
*
|
|
2401
|
+
* Filter post templates by given template category ids
|
|
2402
|
+
* @maxSize 50
|
|
2403
|
+
* @format GUID
|
|
2404
|
+
*/
|
|
2405
|
+
categoryIds?: string[];
|
|
2406
|
+
/**
|
|
2407
|
+
* Filter post templates by provided language
|
|
2408
|
+
* @format LANGUAGE_TAG
|
|
2409
|
+
*/
|
|
2410
|
+
language?: string | null;
|
|
2411
|
+
/** Returns post template categories when set to TRUE */
|
|
2412
|
+
listTemplateCategories?: boolean;
|
|
2413
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2414
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2415
|
+
/** Pagination options. */
|
|
2416
|
+
paging?: BlogPaging;
|
|
2417
|
+
}
|
|
2418
|
+
declare enum GetPostTemplatesSort {
|
|
2419
|
+
/** Sort by ascending publishing date. */
|
|
2420
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2421
|
+
/** Sort by descending publishing date. */
|
|
2422
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2423
|
+
}
|
|
2424
|
+
/** @enumType */
|
|
2425
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2426
|
+
interface BlogPaging {
|
|
2427
|
+
/**
|
|
2428
|
+
* Number of items to skip in the current sort order.
|
|
2429
|
+
*
|
|
2430
|
+
*
|
|
2431
|
+
* Default: `0`
|
|
2432
|
+
*/
|
|
2433
|
+
offset?: number;
|
|
2434
|
+
/**
|
|
2435
|
+
* Number of items to return.
|
|
2436
|
+
*
|
|
2437
|
+
*
|
|
2438
|
+
* Default:`50`
|
|
2439
|
+
* @min 1
|
|
2440
|
+
* @max 100
|
|
2441
|
+
*/
|
|
2442
|
+
limit?: number;
|
|
2443
|
+
/**
|
|
2444
|
+
* Pointer to the next or previous page in the list of results.
|
|
2445
|
+
* @maxLength 2000
|
|
2446
|
+
*/
|
|
2447
|
+
cursor?: string | null;
|
|
2448
|
+
}
|
|
2449
|
+
interface ListTemplatesResponse {
|
|
2450
|
+
/** Available post templates */
|
|
2451
|
+
postTemplates?: Post[];
|
|
2452
|
+
/** Details on the paged set of posts templates returned. */
|
|
2453
|
+
postTemplatesMetaData?: MetaData;
|
|
2454
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2455
|
+
templateCategories?: Category[];
|
|
2456
|
+
}
|
|
2457
|
+
interface MetaData {
|
|
2458
|
+
/** Number of items returned in this response. */
|
|
2459
|
+
count?: number;
|
|
2460
|
+
/** Requested offset. */
|
|
2461
|
+
offset?: number;
|
|
2462
|
+
/** Total number of items that match the query. */
|
|
2463
|
+
total?: number;
|
|
2464
|
+
/**
|
|
2465
|
+
* Pointer to the next or previous page in the list of results.
|
|
2466
|
+
* @maxLength 2000
|
|
2467
|
+
*/
|
|
2468
|
+
cursor?: string | null;
|
|
2469
|
+
}
|
|
2470
|
+
interface Category {
|
|
2471
|
+
/**
|
|
2472
|
+
* Category ID.
|
|
2473
|
+
* @immutable
|
|
2474
|
+
* @maxLength 38
|
|
2475
|
+
*/
|
|
2476
|
+
_id?: string;
|
|
2477
|
+
/**
|
|
2478
|
+
* Category label. Displayed in the Category Menu.
|
|
2479
|
+
* @maxLength 35
|
|
2480
|
+
*/
|
|
2481
|
+
label?: string;
|
|
2482
|
+
/**
|
|
2483
|
+
* Number of posts in the category.
|
|
2484
|
+
* @readonly
|
|
2485
|
+
*/
|
|
2486
|
+
postCount?: number;
|
|
2487
|
+
/**
|
|
2488
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2489
|
+
* @readonly
|
|
2490
|
+
*/
|
|
2491
|
+
url?: string;
|
|
2492
|
+
/**
|
|
2493
|
+
* Category description.
|
|
2494
|
+
* @maxLength 500
|
|
2495
|
+
*/
|
|
2496
|
+
description?: string | null;
|
|
2497
|
+
/**
|
|
2498
|
+
* Category title.
|
|
2499
|
+
* @maxLength 200
|
|
2500
|
+
* @deprecated Category title.
|
|
2501
|
+
* @targetRemovalDate 2025-07-16
|
|
2502
|
+
*/
|
|
2503
|
+
title?: string;
|
|
2504
|
+
/**
|
|
2505
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2506
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2507
|
+
*
|
|
2508
|
+
* Default: `-1`
|
|
2509
|
+
*/
|
|
2510
|
+
displayPosition?: number | null;
|
|
2511
|
+
/**
|
|
2512
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2513
|
+
* @format GUID
|
|
2514
|
+
*/
|
|
2515
|
+
translationId?: string | null;
|
|
2516
|
+
/**
|
|
2517
|
+
* Category language.
|
|
2411
2518
|
*
|
|
2412
2519
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2413
|
-
* @
|
|
2520
|
+
* @immutable
|
|
2414
2521
|
*/
|
|
2415
2522
|
language?: string | null;
|
|
2416
2523
|
/**
|
|
2417
|
-
*
|
|
2418
|
-
* @minLength 3
|
|
2524
|
+
* 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`.
|
|
2419
2525
|
* @maxLength 100
|
|
2420
2526
|
*/
|
|
2421
|
-
|
|
2527
|
+
slug?: string;
|
|
2528
|
+
/** SEO data. */
|
|
2529
|
+
seoData?: SeoSchema;
|
|
2530
|
+
/** Category cover image. */
|
|
2531
|
+
coverImage?: string;
|
|
2532
|
+
/**
|
|
2533
|
+
* Date and time the Category was last updated.
|
|
2534
|
+
* @readonly
|
|
2535
|
+
*/
|
|
2536
|
+
_updatedDate?: Date | null;
|
|
2422
2537
|
}
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2538
|
+
interface CategoryTranslation {
|
|
2539
|
+
/**
|
|
2540
|
+
* Category ID.
|
|
2541
|
+
* @format GUID
|
|
2542
|
+
*/
|
|
2543
|
+
_id?: string;
|
|
2544
|
+
/**
|
|
2545
|
+
* Label displayed in the categories menu on the site.
|
|
2546
|
+
* @maxLength 100
|
|
2547
|
+
*/
|
|
2548
|
+
label?: string | null;
|
|
2549
|
+
/**
|
|
2550
|
+
* Language of the category.
|
|
2551
|
+
* @format LANGUAGE_TAG
|
|
2552
|
+
*/
|
|
2553
|
+
language?: string | null;
|
|
2554
|
+
/** URL of this category page. */
|
|
2555
|
+
url?: string;
|
|
2427
2556
|
}
|
|
2428
|
-
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
|
|
2557
|
+
interface GetTemplateRequest {
|
|
2558
|
+
/**
|
|
2559
|
+
* Post template id
|
|
2560
|
+
* @format GUID
|
|
2561
|
+
*/
|
|
2562
|
+
postTemplateId?: string;
|
|
2434
2563
|
}
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
periodStart?: Date | null;
|
|
2439
|
-
/** Number of posts published during this month. */
|
|
2440
|
-
publicationsCount?: number;
|
|
2564
|
+
interface GetTemplateResponse {
|
|
2565
|
+
/** Post template */
|
|
2566
|
+
postTemplate?: Post;
|
|
2441
2567
|
}
|
|
2442
|
-
|
|
2443
|
-
interface QueryPostCountStatsRequest {
|
|
2444
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2445
|
-
rangeStart?: Date | null;
|
|
2568
|
+
interface CreateDraftPostFromTemplateRequest {
|
|
2446
2569
|
/**
|
|
2447
|
-
*
|
|
2570
|
+
* Post template id
|
|
2571
|
+
* @format GUID
|
|
2572
|
+
*/
|
|
2573
|
+
postTemplateId?: string;
|
|
2574
|
+
}
|
|
2575
|
+
interface CreateDraftPostFromTemplateResponse {
|
|
2576
|
+
/** Created draft post */
|
|
2577
|
+
draftPost?: DraftPost;
|
|
2578
|
+
}
|
|
2579
|
+
interface DraftPost {
|
|
2580
|
+
/**
|
|
2581
|
+
* Draft post ID.
|
|
2582
|
+
* @readonly
|
|
2583
|
+
* @maxLength 38
|
|
2584
|
+
*/
|
|
2585
|
+
_id?: string;
|
|
2586
|
+
/**
|
|
2587
|
+
* Draft post title.
|
|
2588
|
+
* @maxLength 200
|
|
2589
|
+
*/
|
|
2590
|
+
title?: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* Draft post excerpt.
|
|
2448
2593
|
*
|
|
2449
|
-
*
|
|
2450
|
-
*
|
|
2594
|
+
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
2595
|
+
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
2596
|
+
* @maxLength 500
|
|
2597
|
+
*/
|
|
2598
|
+
excerpt?: string | null;
|
|
2599
|
+
/** Whether the draft post is marked as featured. */
|
|
2600
|
+
featured?: boolean | null;
|
|
2601
|
+
/**
|
|
2602
|
+
* Category IDs of the draft post.
|
|
2603
|
+
* @maxSize 10
|
|
2604
|
+
* @maxLength 38
|
|
2605
|
+
*/
|
|
2606
|
+
categoryIds?: string[];
|
|
2607
|
+
/**
|
|
2608
|
+
* Draft post owner's member ID.
|
|
2609
|
+
* @format GUID
|
|
2610
|
+
*/
|
|
2611
|
+
memberId?: string | null;
|
|
2612
|
+
/**
|
|
2613
|
+
* Hashtags in the post.
|
|
2614
|
+
* @maxSize 100
|
|
2615
|
+
* @maxLength 100
|
|
2616
|
+
*/
|
|
2617
|
+
hashtags?: string[];
|
|
2618
|
+
/** Whether commenting on the draft post is enabled. */
|
|
2619
|
+
commentingEnabled?: boolean | null;
|
|
2620
|
+
/**
|
|
2621
|
+
* Estimated reading time of the draft post (calculated automatically).
|
|
2622
|
+
* @readonly
|
|
2623
|
+
*/
|
|
2624
|
+
minutesToRead?: number;
|
|
2625
|
+
/** Image placed at the top of the blog page. */
|
|
2626
|
+
heroImage?: string;
|
|
2627
|
+
/**
|
|
2628
|
+
* Tag IDs the draft post is tagged with.
|
|
2629
|
+
* @maxSize 30
|
|
2630
|
+
* @maxLength 38
|
|
2631
|
+
*/
|
|
2632
|
+
tagIds?: string[];
|
|
2633
|
+
/**
|
|
2634
|
+
* IDs of posts related to this draft post.
|
|
2635
|
+
* @maxSize 3
|
|
2636
|
+
* @maxLength 38
|
|
2637
|
+
*/
|
|
2638
|
+
relatedPostIds?: string[];
|
|
2639
|
+
/**
|
|
2640
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
2641
|
+
* @maxSize 100
|
|
2642
|
+
* @format GUID
|
|
2643
|
+
*/
|
|
2644
|
+
pricingPlanIds?: string[];
|
|
2645
|
+
/**
|
|
2646
|
+
* ID of the draft post's translations.
|
|
2451
2647
|
*
|
|
2452
|
-
*
|
|
2648
|
+
* All translations of a single post share the same `translationId`.
|
|
2649
|
+
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
2650
|
+
* @format GUID
|
|
2453
2651
|
*/
|
|
2454
|
-
|
|
2455
|
-
/** Number of months to include in response. */
|
|
2456
|
-
months?: number;
|
|
2652
|
+
translationId?: string | null;
|
|
2457
2653
|
/**
|
|
2458
|
-
* Language
|
|
2654
|
+
* Language the draft post is written in.
|
|
2459
2655
|
*
|
|
2460
2656
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2461
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
2462
2657
|
* @format LANGUAGE_TAG
|
|
2463
2658
|
*/
|
|
2464
2659
|
language?: string | null;
|
|
2465
2660
|
/**
|
|
2466
|
-
*
|
|
2661
|
+
* Draft Post rich content.
|
|
2467
2662
|
*
|
|
2468
|
-
*
|
|
2469
|
-
*
|
|
2663
|
+
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
|
2664
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2665
|
+
* </widget>
|
|
2666
|
+
*/
|
|
2667
|
+
richContent?: RichContent;
|
|
2668
|
+
/**
|
|
2669
|
+
* Status of the draft post.
|
|
2670
|
+
* @readonly
|
|
2671
|
+
*/
|
|
2672
|
+
status?: StatusWithLiterals;
|
|
2673
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
2674
|
+
moderationDetails?: ModerationDetails;
|
|
2675
|
+
/**
|
|
2676
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
2677
|
+
* @readonly
|
|
2678
|
+
*/
|
|
2679
|
+
hasUnpublishedChanges?: boolean;
|
|
2680
|
+
/**
|
|
2681
|
+
* Date the draft post was last edited.
|
|
2682
|
+
* @readonly
|
|
2683
|
+
*/
|
|
2684
|
+
editedDate?: Date | null;
|
|
2685
|
+
/**
|
|
2686
|
+
* Date the draft post is scheduled to be published.
|
|
2687
|
+
* @readonly
|
|
2688
|
+
*/
|
|
2689
|
+
scheduledPublishDate?: Date | null;
|
|
2690
|
+
/** Date the post was first published. */
|
|
2691
|
+
firstPublishedDate?: Date | null;
|
|
2692
|
+
/** SEO data. */
|
|
2693
|
+
seoData?: SeoSchema;
|
|
2694
|
+
/**
|
|
2695
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
|
2696
|
+
* @readonly
|
|
2697
|
+
*/
|
|
2698
|
+
url?: string;
|
|
2699
|
+
/**
|
|
2700
|
+
* Date the draft post was first created.
|
|
2701
|
+
* @readonly
|
|
2702
|
+
*/
|
|
2703
|
+
_createdDate?: Date | null;
|
|
2704
|
+
/**
|
|
2705
|
+
* SEO slug.
|
|
2470
2706
|
* @maxLength 100
|
|
2471
2707
|
*/
|
|
2472
|
-
|
|
2708
|
+
seoSlug?: string | null;
|
|
2709
|
+
/** Post cover media. */
|
|
2710
|
+
media?: Media;
|
|
2711
|
+
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2712
|
+
previewTextParagraph?: number | null;
|
|
2473
2713
|
}
|
|
2474
|
-
declare enum
|
|
2714
|
+
declare enum Origin {
|
|
2475
2715
|
UNKNOWN = "UNKNOWN",
|
|
2476
|
-
|
|
2477
|
-
|
|
2716
|
+
/** Changed by admin */
|
|
2717
|
+
ADMIN = "ADMIN",
|
|
2718
|
+
/** Categories were changed */
|
|
2719
|
+
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
2720
|
+
/** Saved automatically */
|
|
2721
|
+
AUTO_SAVE = "AUTO_SAVE",
|
|
2722
|
+
/** Copied from template */
|
|
2723
|
+
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
2724
|
+
/** Imported */
|
|
2725
|
+
IMPORT = "IMPORT",
|
|
2726
|
+
/** Imported in bulk */
|
|
2727
|
+
IMPORT_BULK = "IMPORT_BULK",
|
|
2728
|
+
/** Imported with html import */
|
|
2729
|
+
IMPORT_HTML = "IMPORT_HTML",
|
|
2730
|
+
/** Patch import */
|
|
2731
|
+
IMPORT_PATCH = "IMPORT_PATCH",
|
|
2732
|
+
/** Changed language */
|
|
2733
|
+
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
2734
|
+
/** Saved manually */
|
|
2735
|
+
MANUAL_SAVE = "MANUAL_SAVE",
|
|
2736
|
+
/** Affected by migration */
|
|
2737
|
+
MIGRATION = "MIGRATION",
|
|
2738
|
+
/** Affected by moderation */
|
|
2739
|
+
MODERATION = "MODERATION",
|
|
2740
|
+
/** Moved to trash */
|
|
2741
|
+
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
2742
|
+
/** Pricing plans were changed */
|
|
2743
|
+
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
2744
|
+
/** Was provisioned */
|
|
2745
|
+
PROVISION = "PROVISION",
|
|
2746
|
+
/** Was published */
|
|
2747
|
+
PUBLISH = "PUBLISH",
|
|
2748
|
+
/** Owner was reassigned */
|
|
2749
|
+
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
2750
|
+
/** Was reblogged */
|
|
2751
|
+
REBLOG = "REBLOG",
|
|
2752
|
+
/** Was restored */
|
|
2753
|
+
RESTORE = "RESTORE",
|
|
2754
|
+
/** Reverted to draft */
|
|
2755
|
+
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
2756
|
+
/** Was translated */
|
|
2757
|
+
TRANSLATION = "TRANSLATION",
|
|
2758
|
+
/** Was unpublished */
|
|
2759
|
+
UNPUBLISH = "UNPUBLISH",
|
|
2760
|
+
/** Was unscheduled */
|
|
2761
|
+
UNSCHEDULE = "UNSCHEDULE",
|
|
2762
|
+
/** New edit session started which updated editing_session_id id */
|
|
2763
|
+
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
2764
|
+
/** Was scheduled by Later */
|
|
2765
|
+
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
2766
|
+
/** Was unscheduled by Later */
|
|
2767
|
+
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
2768
|
+
/** Was published by Later */
|
|
2769
|
+
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
2770
|
+
/** Was scheduled */
|
|
2771
|
+
SCHEDULE = "SCHEDULE",
|
|
2772
|
+
/** Was removed from moderation */
|
|
2773
|
+
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
2774
|
+
/** Was rejected from moderation */
|
|
2775
|
+
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
2776
|
+
/** Was approved in moderation */
|
|
2777
|
+
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
2778
|
+
/** Tag was deleted */
|
|
2779
|
+
DELETE_TAG = "DELETE_TAG",
|
|
2780
|
+
/** Post was pinned */
|
|
2781
|
+
PIN = "PIN",
|
|
2782
|
+
/** Post was unpinned */
|
|
2783
|
+
UNPIN = "UNPIN",
|
|
2784
|
+
/** Saved automatically by AI tool. */
|
|
2785
|
+
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2478
2786
|
}
|
|
2479
2787
|
/** @enumType */
|
|
2480
|
-
type
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
/**
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2788
|
+
type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
|
2789
|
+
declare enum Status {
|
|
2790
|
+
UNKNOWN = "UNKNOWN",
|
|
2791
|
+
/** Status indicating the draft post is published. */
|
|
2792
|
+
PUBLISHED = "PUBLISHED",
|
|
2793
|
+
/** Status indicating the draft post is unpublished. */
|
|
2794
|
+
UNPUBLISHED = "UNPUBLISHED",
|
|
2795
|
+
/** Status indicating the draft post is scheduled for publication. */
|
|
2796
|
+
SCHEDULED = "SCHEDULED",
|
|
2797
|
+
/** Status indicating the draft post is deleted. */
|
|
2798
|
+
DELETED = "DELETED",
|
|
2799
|
+
/** Status indicating the draft post is in review. */
|
|
2800
|
+
IN_REVIEW = "IN_REVIEW"
|
|
2492
2801
|
}
|
|
2493
|
-
|
|
2802
|
+
/** @enumType */
|
|
2803
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
2804
|
+
interface DraftPostTranslation {
|
|
2494
2805
|
/**
|
|
2495
|
-
*
|
|
2496
|
-
* @
|
|
2497
|
-
* @format LANGUAGE_TAG
|
|
2806
|
+
* Post ID.
|
|
2807
|
+
* @format GUID
|
|
2498
2808
|
*/
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
/** Total amount of publications. */
|
|
2503
|
-
total?: number;
|
|
2504
|
-
}
|
|
2505
|
-
interface GetTotalPostsRequest {
|
|
2809
|
+
_id?: string;
|
|
2810
|
+
/** Post status. */
|
|
2811
|
+
status?: StatusWithLiterals;
|
|
2506
2812
|
/**
|
|
2507
|
-
* Language
|
|
2508
|
-
*
|
|
2509
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2510
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
2813
|
+
* Language the post is written in.
|
|
2511
2814
|
* @format LANGUAGE_TAG
|
|
2512
2815
|
*/
|
|
2513
2816
|
language?: string | null;
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2817
|
+
/**
|
|
2818
|
+
* Post slug. For example, 'post-slug'.
|
|
2819
|
+
* @maxLength 100
|
|
2820
|
+
*/
|
|
2821
|
+
slug?: string | null;
|
|
2822
|
+
/** SEO data. */
|
|
2823
|
+
seoData?: SeoSchema;
|
|
2824
|
+
/** Post URL. */
|
|
2825
|
+
url?: string;
|
|
2518
2826
|
}
|
|
2519
2827
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2520
2828
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -2664,438 +2972,130 @@ interface AccountInfo {
|
|
|
2664
2972
|
*/
|
|
2665
2973
|
parentAccountId?: string | null;
|
|
2666
2974
|
/**
|
|
2667
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2668
|
-
* @format GUID
|
|
2669
|
-
*/
|
|
2670
|
-
siteId?: string | null;
|
|
2671
|
-
}
|
|
2672
|
-
interface ListTemplatesRequest {
|
|
2673
|
-
/**
|
|
2674
|
-
* Filter post templates by given template category ids
|
|
2675
|
-
* @maxSize 50
|
|
2676
|
-
* @format GUID
|
|
2677
|
-
*/
|
|
2678
|
-
categoryIds?: string[];
|
|
2679
|
-
/**
|
|
2680
|
-
* Filter post templates by provided language
|
|
2681
|
-
* @format LANGUAGE_TAG
|
|
2682
|
-
*/
|
|
2683
|
-
language?: string | null;
|
|
2684
|
-
/** Returns post template categories when set to TRUE */
|
|
2685
|
-
listTemplateCategories?: boolean;
|
|
2686
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2687
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2688
|
-
/** Pagination options. */
|
|
2689
|
-
paging?: BlogPaging;
|
|
2690
|
-
}
|
|
2691
|
-
declare enum GetPostTemplatesSort {
|
|
2692
|
-
/** Sort by ascending publishing date. */
|
|
2693
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2694
|
-
/** Sort by descending publishing date. */
|
|
2695
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2696
|
-
}
|
|
2697
|
-
/** @enumType */
|
|
2698
|
-
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2699
|
-
interface BlogPaging {
|
|
2700
|
-
/**
|
|
2701
|
-
* Number of items to skip in the current sort order.
|
|
2702
|
-
*
|
|
2703
|
-
*
|
|
2704
|
-
* Default: `0`
|
|
2705
|
-
*/
|
|
2706
|
-
offset?: number;
|
|
2707
|
-
/**
|
|
2708
|
-
* Number of items to return.
|
|
2709
|
-
*
|
|
2710
|
-
*
|
|
2711
|
-
* Default:`50`
|
|
2712
|
-
* @min 1
|
|
2713
|
-
* @max 100
|
|
2714
|
-
*/
|
|
2715
|
-
limit?: number;
|
|
2716
|
-
/**
|
|
2717
|
-
* Pointer to the next or previous page in the list of results.
|
|
2718
|
-
* @maxLength 2000
|
|
2719
|
-
*/
|
|
2720
|
-
cursor?: string | null;
|
|
2721
|
-
}
|
|
2722
|
-
interface ListTemplatesResponse {
|
|
2723
|
-
/** Available post templates */
|
|
2724
|
-
postTemplates?: Post[];
|
|
2725
|
-
/** Details on the paged set of posts templates returned. */
|
|
2726
|
-
postTemplatesMetaData?: MetaData;
|
|
2727
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2728
|
-
templateCategories?: Category[];
|
|
2729
|
-
}
|
|
2730
|
-
interface MetaData {
|
|
2731
|
-
/** Number of items returned in this response. */
|
|
2732
|
-
count?: number;
|
|
2733
|
-
/** Requested offset. */
|
|
2734
|
-
offset?: number;
|
|
2735
|
-
/** Total number of items that match the query. */
|
|
2736
|
-
total?: number;
|
|
2737
|
-
/**
|
|
2738
|
-
* Pointer to the next or previous page in the list of results.
|
|
2739
|
-
* @maxLength 2000
|
|
2740
|
-
*/
|
|
2741
|
-
cursor?: string | null;
|
|
2742
|
-
}
|
|
2743
|
-
interface Category {
|
|
2744
|
-
/**
|
|
2745
|
-
* Category ID.
|
|
2746
|
-
* @immutable
|
|
2747
|
-
* @maxLength 38
|
|
2748
|
-
*/
|
|
2749
|
-
_id?: string;
|
|
2750
|
-
/**
|
|
2751
|
-
* Category label. Displayed in the Category Menu.
|
|
2752
|
-
* @maxLength 35
|
|
2753
|
-
*/
|
|
2754
|
-
label?: string;
|
|
2755
|
-
/**
|
|
2756
|
-
* Number of posts in the category.
|
|
2757
|
-
* @readonly
|
|
2758
|
-
*/
|
|
2759
|
-
postCount?: number;
|
|
2760
|
-
/**
|
|
2761
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2762
|
-
* @readonly
|
|
2763
|
-
*/
|
|
2764
|
-
url?: string;
|
|
2765
|
-
/**
|
|
2766
|
-
* Category description.
|
|
2767
|
-
* @maxLength 500
|
|
2768
|
-
*/
|
|
2769
|
-
description?: string | null;
|
|
2770
|
-
/**
|
|
2771
|
-
* Category title.
|
|
2772
|
-
* @maxLength 200
|
|
2773
|
-
* @deprecated Category title.
|
|
2774
|
-
* @targetRemovalDate 2025-07-16
|
|
2775
|
-
*/
|
|
2776
|
-
title?: string;
|
|
2777
|
-
/**
|
|
2778
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2779
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2780
|
-
*
|
|
2781
|
-
* Default: `-1`
|
|
2782
|
-
*/
|
|
2783
|
-
displayPosition?: number | null;
|
|
2784
|
-
/**
|
|
2785
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2786
|
-
* @format GUID
|
|
2787
|
-
*/
|
|
2788
|
-
translationId?: string | null;
|
|
2789
|
-
/**
|
|
2790
|
-
* Category language.
|
|
2791
|
-
*
|
|
2792
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2793
|
-
* @immutable
|
|
2794
|
-
*/
|
|
2795
|
-
language?: string | null;
|
|
2796
|
-
/**
|
|
2797
|
-
* 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`.
|
|
2798
|
-
* @maxLength 100
|
|
2799
|
-
*/
|
|
2800
|
-
slug?: string;
|
|
2801
|
-
/** SEO data. */
|
|
2802
|
-
seoData?: SeoSchema;
|
|
2803
|
-
/** Category cover image. */
|
|
2804
|
-
coverImage?: string;
|
|
2805
|
-
/**
|
|
2806
|
-
* Date and time the Category was last updated.
|
|
2807
|
-
* @readonly
|
|
2808
|
-
*/
|
|
2809
|
-
_updatedDate?: Date | null;
|
|
2810
|
-
}
|
|
2811
|
-
interface CategoryTranslation {
|
|
2812
|
-
/**
|
|
2813
|
-
* Category ID.
|
|
2814
|
-
* @format GUID
|
|
2815
|
-
*/
|
|
2816
|
-
_id?: string;
|
|
2817
|
-
/**
|
|
2818
|
-
* Label displayed in the categories menu on the site.
|
|
2819
|
-
* @maxLength 100
|
|
2820
|
-
*/
|
|
2821
|
-
label?: string | null;
|
|
2822
|
-
/**
|
|
2823
|
-
* Language of the category.
|
|
2824
|
-
* @format LANGUAGE_TAG
|
|
2825
|
-
*/
|
|
2826
|
-
language?: string | null;
|
|
2827
|
-
/** URL of this category page. */
|
|
2828
|
-
url?: string;
|
|
2829
|
-
}
|
|
2830
|
-
interface GetTemplateRequest {
|
|
2831
|
-
/**
|
|
2832
|
-
* Post template id
|
|
2833
|
-
* @format GUID
|
|
2834
|
-
*/
|
|
2835
|
-
postTemplateId?: string;
|
|
2836
|
-
}
|
|
2837
|
-
interface GetTemplateResponse {
|
|
2838
|
-
/** Post template */
|
|
2839
|
-
postTemplate?: Post;
|
|
2840
|
-
}
|
|
2841
|
-
interface CreateDraftPostFromTemplateRequest {
|
|
2842
|
-
/**
|
|
2843
|
-
* Post template id
|
|
2844
|
-
* @format GUID
|
|
2845
|
-
*/
|
|
2846
|
-
postTemplateId?: string;
|
|
2847
|
-
}
|
|
2848
|
-
interface CreateDraftPostFromTemplateResponse {
|
|
2849
|
-
/** Created draft post */
|
|
2850
|
-
draftPost?: DraftPost;
|
|
2851
|
-
}
|
|
2852
|
-
interface DraftPost {
|
|
2853
|
-
/**
|
|
2854
|
-
* Draft post ID.
|
|
2855
|
-
* @readonly
|
|
2856
|
-
* @maxLength 38
|
|
2857
|
-
*/
|
|
2858
|
-
_id?: string;
|
|
2859
|
-
/**
|
|
2860
|
-
* Draft post title.
|
|
2861
|
-
* @maxLength 200
|
|
2862
|
-
*/
|
|
2863
|
-
title?: string;
|
|
2864
|
-
/**
|
|
2865
|
-
* Draft post excerpt.
|
|
2866
|
-
*
|
|
2867
|
-
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
2868
|
-
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
2869
|
-
* @maxLength 500
|
|
2870
|
-
*/
|
|
2871
|
-
excerpt?: string | null;
|
|
2872
|
-
/** Whether the draft post is marked as featured. */
|
|
2873
|
-
featured?: boolean | null;
|
|
2874
|
-
/**
|
|
2875
|
-
* Category IDs of the draft post.
|
|
2876
|
-
* @maxSize 10
|
|
2877
|
-
* @maxLength 38
|
|
2878
|
-
*/
|
|
2879
|
-
categoryIds?: string[];
|
|
2880
|
-
/**
|
|
2881
|
-
* Draft post owner's member ID.
|
|
2882
|
-
* @format GUID
|
|
2883
|
-
*/
|
|
2884
|
-
memberId?: string | null;
|
|
2885
|
-
/**
|
|
2886
|
-
* Hashtags in the post.
|
|
2887
|
-
* @maxSize 100
|
|
2888
|
-
* @maxLength 100
|
|
2889
|
-
*/
|
|
2890
|
-
hashtags?: string[];
|
|
2891
|
-
/** Whether commenting on the draft post is enabled. */
|
|
2892
|
-
commentingEnabled?: boolean | null;
|
|
2893
|
-
/**
|
|
2894
|
-
* Estimated reading time of the draft post (calculated automatically).
|
|
2895
|
-
* @readonly
|
|
2896
|
-
*/
|
|
2897
|
-
minutesToRead?: number;
|
|
2898
|
-
/** Image placed at the top of the blog page. */
|
|
2899
|
-
heroImage?: string;
|
|
2900
|
-
/**
|
|
2901
|
-
* Tag IDs the draft post is tagged with.
|
|
2902
|
-
* @maxSize 30
|
|
2903
|
-
* @maxLength 38
|
|
2904
|
-
*/
|
|
2905
|
-
tagIds?: string[];
|
|
2906
|
-
/**
|
|
2907
|
-
* IDs of posts related to this draft post.
|
|
2908
|
-
* @maxSize 3
|
|
2909
|
-
* @maxLength 38
|
|
2910
|
-
*/
|
|
2911
|
-
relatedPostIds?: string[];
|
|
2912
|
-
/**
|
|
2913
|
-
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
2914
|
-
* @maxSize 100
|
|
2915
|
-
* @format GUID
|
|
2916
|
-
*/
|
|
2917
|
-
pricingPlanIds?: string[];
|
|
2918
|
-
/**
|
|
2919
|
-
* ID of the draft post's translations.
|
|
2920
|
-
*
|
|
2921
|
-
* All translations of a single post share the same `translationId`.
|
|
2922
|
-
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
2975
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2923
2976
|
* @format GUID
|
|
2924
2977
|
*/
|
|
2925
|
-
|
|
2978
|
+
siteId?: string | null;
|
|
2979
|
+
}
|
|
2980
|
+
/** Get Blog Publications Count Stats request */
|
|
2981
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2982
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2983
|
+
rangeStart?: Date | null;
|
|
2984
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2985
|
+
rangeEnd?: Date | null;
|
|
2986
|
+
/** Order of the returned results. */
|
|
2987
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2988
|
+
/** Number of months to include in the response. */
|
|
2989
|
+
months?: number;
|
|
2926
2990
|
/**
|
|
2927
|
-
* Language
|
|
2991
|
+
* Language filter
|
|
2928
2992
|
*
|
|
2929
2993
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2930
2994
|
* @format LANGUAGE_TAG
|
|
2931
2995
|
*/
|
|
2932
2996
|
language?: string | null;
|
|
2933
2997
|
/**
|
|
2934
|
-
*
|
|
2935
|
-
*
|
|
2936
|
-
*
|
|
2937
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2938
|
-
* </widget>
|
|
2939
|
-
*/
|
|
2940
|
-
richContent?: RichContent;
|
|
2941
|
-
/**
|
|
2942
|
-
* Status of the draft post.
|
|
2943
|
-
* @readonly
|
|
2944
|
-
*/
|
|
2945
|
-
status?: StatusWithLiterals;
|
|
2946
|
-
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
2947
|
-
moderationDetails?: ModerationDetails;
|
|
2948
|
-
/**
|
|
2949
|
-
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
2950
|
-
* @readonly
|
|
2951
|
-
*/
|
|
2952
|
-
hasUnpublishedChanges?: boolean;
|
|
2953
|
-
/**
|
|
2954
|
-
* Date the draft post was last edited.
|
|
2955
|
-
* @readonly
|
|
2956
|
-
*/
|
|
2957
|
-
editedDate?: Date | null;
|
|
2958
|
-
/**
|
|
2959
|
-
* Date the draft post is scheduled to be published.
|
|
2960
|
-
* @readonly
|
|
2998
|
+
* Timezone of the client.
|
|
2999
|
+
* @minLength 3
|
|
3000
|
+
* @maxLength 100
|
|
2961
3001
|
*/
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
3002
|
+
timeZone?: string | null;
|
|
3003
|
+
}
|
|
3004
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3005
|
+
UNKNOWN = "UNKNOWN",
|
|
3006
|
+
OLDEST = "OLDEST",
|
|
3007
|
+
NEWEST = "NEWEST"
|
|
3008
|
+
}
|
|
3009
|
+
/** @enumType */
|
|
3010
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3011
|
+
/** Get Blog Publications Count Stats response */
|
|
3012
|
+
interface QueryPublicationsCountStatsResponse {
|
|
3013
|
+
/** Chronologically ordered list of publications. */
|
|
3014
|
+
stats?: PeriodPublicationsCount[];
|
|
3015
|
+
}
|
|
3016
|
+
/** Publications count for a specific time period */
|
|
3017
|
+
interface PeriodPublicationsCount {
|
|
3018
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3019
|
+
periodStart?: Date | null;
|
|
3020
|
+
/** Number of posts published during this month. */
|
|
3021
|
+
publicationsCount?: number;
|
|
3022
|
+
}
|
|
3023
|
+
/** Get Blog Post Count Stats request */
|
|
3024
|
+
interface QueryPostCountStatsRequest {
|
|
3025
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3026
|
+
rangeStart?: Date | null;
|
|
2967
3027
|
/**
|
|
2968
|
-
*
|
|
2969
|
-
*
|
|
3028
|
+
* Order of returned results.
|
|
3029
|
+
*
|
|
3030
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
3031
|
+
* - `NEWEST`: posts by date in descending order.
|
|
3032
|
+
*
|
|
3033
|
+
* Default: `OLDEST`
|
|
2970
3034
|
*/
|
|
2971
|
-
|
|
3035
|
+
order?: OrderWithLiterals;
|
|
3036
|
+
/** Number of months to include in response. */
|
|
3037
|
+
months?: number;
|
|
2972
3038
|
/**
|
|
2973
|
-
*
|
|
2974
|
-
*
|
|
3039
|
+
* Language filter.
|
|
3040
|
+
*
|
|
3041
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3042
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
3043
|
+
* @format LANGUAGE_TAG
|
|
2975
3044
|
*/
|
|
2976
|
-
|
|
3045
|
+
language?: string | null;
|
|
2977
3046
|
/**
|
|
2978
|
-
*
|
|
3047
|
+
* Time zone to use when calculating the start of the month.
|
|
3048
|
+
*
|
|
3049
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3050
|
+
* @minLength 3
|
|
2979
3051
|
* @maxLength 100
|
|
2980
3052
|
*/
|
|
2981
|
-
|
|
2982
|
-
/** Post cover media. */
|
|
2983
|
-
media?: Media;
|
|
2984
|
-
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2985
|
-
previewTextParagraph?: number | null;
|
|
3053
|
+
timeZone?: string | null;
|
|
2986
3054
|
}
|
|
2987
|
-
declare enum
|
|
3055
|
+
declare enum Order {
|
|
2988
3056
|
UNKNOWN = "UNKNOWN",
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
/** Categories were changed */
|
|
2992
|
-
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
2993
|
-
/** Saved automatically */
|
|
2994
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
2995
|
-
/** Copied from template */
|
|
2996
|
-
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
2997
|
-
/** Imported */
|
|
2998
|
-
IMPORT = "IMPORT",
|
|
2999
|
-
/** Imported in bulk */
|
|
3000
|
-
IMPORT_BULK = "IMPORT_BULK",
|
|
3001
|
-
/** Imported with html import */
|
|
3002
|
-
IMPORT_HTML = "IMPORT_HTML",
|
|
3003
|
-
/** Patch import */
|
|
3004
|
-
IMPORT_PATCH = "IMPORT_PATCH",
|
|
3005
|
-
/** Changed language */
|
|
3006
|
-
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
3007
|
-
/** Saved manually */
|
|
3008
|
-
MANUAL_SAVE = "MANUAL_SAVE",
|
|
3009
|
-
/** Affected by migration */
|
|
3010
|
-
MIGRATION = "MIGRATION",
|
|
3011
|
-
/** Affected by moderation */
|
|
3012
|
-
MODERATION = "MODERATION",
|
|
3013
|
-
/** Moved to trash */
|
|
3014
|
-
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
3015
|
-
/** Pricing plans were changed */
|
|
3016
|
-
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
3017
|
-
/** Was provisioned */
|
|
3018
|
-
PROVISION = "PROVISION",
|
|
3019
|
-
/** Was published */
|
|
3020
|
-
PUBLISH = "PUBLISH",
|
|
3021
|
-
/** Owner was reassigned */
|
|
3022
|
-
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
3023
|
-
/** Was reblogged */
|
|
3024
|
-
REBLOG = "REBLOG",
|
|
3025
|
-
/** Was restored */
|
|
3026
|
-
RESTORE = "RESTORE",
|
|
3027
|
-
/** Reverted to draft */
|
|
3028
|
-
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
3029
|
-
/** Was translated */
|
|
3030
|
-
TRANSLATION = "TRANSLATION",
|
|
3031
|
-
/** Was unpublished */
|
|
3032
|
-
UNPUBLISH = "UNPUBLISH",
|
|
3033
|
-
/** Was unscheduled */
|
|
3034
|
-
UNSCHEDULE = "UNSCHEDULE",
|
|
3035
|
-
/** New edit session started which updated editing_session_id id */
|
|
3036
|
-
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
3037
|
-
/** Was scheduled by Later */
|
|
3038
|
-
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
3039
|
-
/** Was unscheduled by Later */
|
|
3040
|
-
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
3041
|
-
/** Was published by Later */
|
|
3042
|
-
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
3043
|
-
/** Was scheduled */
|
|
3044
|
-
SCHEDULE = "SCHEDULE",
|
|
3045
|
-
/** Was removed from moderation */
|
|
3046
|
-
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
3047
|
-
/** Was rejected from moderation */
|
|
3048
|
-
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
3049
|
-
/** Was approved in moderation */
|
|
3050
|
-
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
3051
|
-
/** Tag was deleted */
|
|
3052
|
-
DELETE_TAG = "DELETE_TAG",
|
|
3053
|
-
/** Post was pinned */
|
|
3054
|
-
PIN = "PIN",
|
|
3055
|
-
/** Post was unpinned */
|
|
3056
|
-
UNPIN = "UNPIN",
|
|
3057
|
-
/** Saved automatically by AI tool. */
|
|
3058
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
3057
|
+
OLDEST = "OLDEST",
|
|
3058
|
+
NEWEST = "NEWEST"
|
|
3059
3059
|
}
|
|
3060
3060
|
/** @enumType */
|
|
3061
|
-
type
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
/**
|
|
3065
|
-
|
|
3066
|
-
/** Status indicating the draft post is unpublished. */
|
|
3067
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
3068
|
-
/** Status indicating the draft post is scheduled for publication. */
|
|
3069
|
-
SCHEDULED = "SCHEDULED",
|
|
3070
|
-
/** Status indicating the draft post is deleted. */
|
|
3071
|
-
DELETED = "DELETED",
|
|
3072
|
-
/** Status indicating the draft post is in review. */
|
|
3073
|
-
IN_REVIEW = "IN_REVIEW"
|
|
3061
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3062
|
+
/** Get Blog Post Count Stats response */
|
|
3063
|
+
interface QueryPostCountStatsResponse {
|
|
3064
|
+
/** List of published post counts by month. */
|
|
3065
|
+
stats?: PeriodPostCount[];
|
|
3074
3066
|
}
|
|
3075
|
-
/**
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
/** Post status. */
|
|
3084
|
-
status?: StatusWithLiterals;
|
|
3067
|
+
/** Post count for a specific time period */
|
|
3068
|
+
interface PeriodPostCount {
|
|
3069
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3070
|
+
periodStart?: Date | null;
|
|
3071
|
+
/** Number of posts published during this month. */
|
|
3072
|
+
postCount?: number;
|
|
3073
|
+
}
|
|
3074
|
+
interface GetTotalPublicationsRequest {
|
|
3085
3075
|
/**
|
|
3086
|
-
* Language
|
|
3076
|
+
* Language filter
|
|
3077
|
+
* @minLength 2
|
|
3087
3078
|
* @format LANGUAGE_TAG
|
|
3088
3079
|
*/
|
|
3089
3080
|
language?: string | null;
|
|
3081
|
+
}
|
|
3082
|
+
interface GetTotalPublicationsResponse {
|
|
3083
|
+
/** Total amount of publications. */
|
|
3084
|
+
total?: number;
|
|
3085
|
+
}
|
|
3086
|
+
interface GetTotalPostsRequest {
|
|
3090
3087
|
/**
|
|
3091
|
-
*
|
|
3092
|
-
*
|
|
3088
|
+
* Language filter.
|
|
3089
|
+
*
|
|
3090
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3091
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
3092
|
+
* @format LANGUAGE_TAG
|
|
3093
3093
|
*/
|
|
3094
|
-
|
|
3095
|
-
|
|
3096
|
-
|
|
3097
|
-
/**
|
|
3098
|
-
|
|
3094
|
+
language?: string | null;
|
|
3095
|
+
}
|
|
3096
|
+
interface GetTotalPostsResponse {
|
|
3097
|
+
/** Total amount of published posts. */
|
|
3098
|
+
total?: number;
|
|
3099
3099
|
}
|
|
3100
3100
|
interface GetTotalLikesPerMemberRequest {
|
|
3101
3101
|
/**
|
|
@@ -3888,13 +3888,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3888
3888
|
/**
|
|
3889
3889
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3890
3890
|
*
|
|
3891
|
-
*
|
|
3892
|
-
* The
|
|
3893
|
-
*
|
|
3894
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3895
|
-
*
|
|
3896
|
-
*
|
|
3891
|
+
*
|
|
3892
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
3893
|
+
*
|
|
3894
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
3895
|
+
*
|
|
3896
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
3897
3897
|
* @public
|
|
3898
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3898
3899
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3899
3900
|
* @applicableIdentity APP
|
|
3900
3901
|
* @returns Get Blog Post Count Stats response
|
|
@@ -3935,6 +3936,7 @@ interface QueryPostCountStatsOptions {
|
|
|
3935
3936
|
/**
|
|
3936
3937
|
* Retrieves the total amount of published posts of the blog.
|
|
3937
3938
|
* @public
|
|
3939
|
+
* @param options - Language Options.
|
|
3938
3940
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3939
3941
|
* @applicableIdentity APP
|
|
3940
3942
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -3955,12 +3957,12 @@ interface GetTotalPostsOptions {
|
|
|
3955
3957
|
* @param postId - Post ID.
|
|
3956
3958
|
* @public
|
|
3957
3959
|
* @requiredField postId
|
|
3960
|
+
* @param options - Options specifying which fields to return.
|
|
3958
3961
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3959
3962
|
* @applicableIdentity APP
|
|
3960
|
-
* @returns Retrieved post info.
|
|
3961
3963
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3962
3964
|
*/
|
|
3963
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
3965
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
|
3964
3966
|
interface GetPostOptions {
|
|
3965
3967
|
/**
|
|
3966
3968
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3980,6 +3982,7 @@ interface GetPostOptions {
|
|
|
3980
3982
|
* @param slug - Slug of the post to retrieve.
|
|
3981
3983
|
* @public
|
|
3982
3984
|
* @requiredField slug
|
|
3985
|
+
* @param options - Options specifying which fields to return.
|
|
3983
3986
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3984
3987
|
* @applicableIdentity APP
|
|
3985
3988
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4007,6 +4010,7 @@ interface GetPostBySlugOptions {
|
|
|
4007
4010
|
* - `paging.limit` is `50`.
|
|
4008
4011
|
* - `paging.offset` is `0`.
|
|
4009
4012
|
* @public
|
|
4013
|
+
* @param options - Sort, filter, and paging options.
|
|
4010
4014
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4011
4015
|
* @applicableIdentity APP
|
|
4012
4016
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4077,18 +4081,26 @@ interface ListPostsOptions {
|
|
|
4077
4081
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4078
4082
|
}
|
|
4079
4083
|
/**
|
|
4080
|
-
*
|
|
4084
|
+
* Creates a query to retrieve a list of posts.
|
|
4081
4085
|
*
|
|
4082
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4083
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4084
|
-
* - `paging.limit` is `50`.
|
|
4085
|
-
* - `paging.offset` is `0`.
|
|
4086
4086
|
*
|
|
4087
|
-
*
|
|
4088
|
-
*
|
|
4089
|
-
*
|
|
4090
|
-
*
|
|
4087
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4088
|
+
*
|
|
4089
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4090
|
+
*
|
|
4091
|
+
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
4092
|
+
*
|
|
4093
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4094
|
+
* + `limit(50)`
|
|
4095
|
+
* + `descending('firstPublishedDate')`
|
|
4096
|
+
*
|
|
4097
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4098
|
+
*
|
|
4099
|
+
* To learn how to query posts, refer to the table below.
|
|
4100
|
+
*
|
|
4101
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
|
|
4091
4102
|
* @public
|
|
4103
|
+
* @param options - Options specifying which fields to return.
|
|
4092
4104
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4093
4105
|
* @applicableIdentity APP
|
|
4094
4106
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|