@wix/auto_sdk_blog_posts 1.0.104 → 1.0.105

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 (37) hide show
  1. package/build/cjs/index.d.ts +15 -11
  2. package/build/cjs/index.js +36 -31
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +506 -499
  5. package/build/cjs/index.typings.js +26 -26
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +347 -347
  8. package/build/cjs/meta.js +20 -20
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +15 -11
  11. package/build/es/index.mjs +36 -31
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +506 -499
  14. package/build/es/index.typings.mjs +26 -26
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +347 -347
  17. package/build/es/meta.mjs +20 -20
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +15 -11
  20. package/build/internal/cjs/index.js +36 -31
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +506 -499
  23. package/build/internal/cjs/index.typings.js +26 -26
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +347 -347
  26. package/build/internal/cjs/meta.js +20 -20
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +15 -11
  29. package/build/internal/es/index.mjs +36 -31
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +506 -499
  32. package/build/internal/es/index.typings.mjs +26 -26
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +347 -347
  35. package/build/internal/es/meta.mjs +20 -20
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -2235,433 +2235,125 @@ interface PostUnlikedInitiatorOneOf {
2235
2235
  */
2236
2236
  anonymousVisitorId?: string | null;
2237
2237
  }
2238
- interface ListTemplatesRequest {
2239
- /**
2240
- * Filter post templates by given template category ids
2241
- * @maxSize 50
2242
- * @format GUID
2243
- */
2244
- categoryIds?: string[];
2245
- /**
2246
- * Filter post templates by provided language
2247
- * @format LANGUAGE_TAG
2248
- */
2249
- language?: string | null;
2250
- /** Returns post template categories when set to TRUE */
2251
- listTemplateCategories?: boolean;
2252
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2253
- sort?: GetPostTemplatesSortWithLiterals;
2254
- /** Pagination options. */
2255
- paging?: BlogPaging;
2256
- }
2257
- declare enum GetPostTemplatesSort {
2258
- /** Sort by ascending publishing date. */
2259
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2260
- /** Sort by descending publishing date. */
2261
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2262
- }
2263
- /** @enumType */
2264
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2265
- interface BlogPaging {
2266
- /**
2267
- * Number of items to skip in the current sort order.
2268
- *
2269
- *
2270
- * Default: `0`
2271
- */
2272
- offset?: number;
2273
- /**
2274
- * Number of items to return.
2275
- *
2276
- *
2277
- * Default:`50`
2278
- * @min 1
2279
- * @max 100
2280
- */
2281
- limit?: number;
2282
- /**
2283
- * Pointer to the next or previous page in the list of results.
2284
- * @maxLength 2000
2285
- */
2286
- cursor?: string | null;
2287
- }
2288
- interface ListTemplatesResponse {
2289
- /** Available post templates */
2290
- postTemplates?: Post[];
2291
- /** Details on the paged set of posts templates returned. */
2292
- postTemplatesMetaData?: MetaData;
2293
- /** Post template categories. This value is returned empty unless asked explicitly */
2294
- templateCategories?: Category[];
2295
- }
2296
- interface MetaData {
2297
- /** Number of items returned in this response. */
2298
- count?: number;
2299
- /** Requested offset. */
2300
- offset?: number;
2301
- /** Total number of items that match the query. */
2302
- total?: number;
2303
- /**
2304
- * Pointer to the next or previous page in the list of results.
2305
- * @maxLength 2000
2306
- */
2307
- cursor?: string | null;
2308
- }
2309
- interface Category {
2310
- /**
2311
- * Category ID.
2312
- * @immutable
2313
- * @maxLength 38
2314
- */
2315
- _id?: string;
2316
- /**
2317
- * Category label. Displayed in the Category Menu.
2318
- * @maxLength 35
2319
- */
2320
- label?: string;
2321
- /**
2322
- * Number of posts in the category.
2323
- * @readonly
2324
- */
2325
- postCount?: number;
2326
- /**
2327
- * The `url` of the page that lists every post with the specified category.
2328
- * @readonly
2329
- */
2330
- url?: string;
2331
- /**
2332
- * Category description.
2333
- * @maxLength 500
2334
- */
2335
- description?: string | null;
2336
- /**
2337
- * Category title.
2338
- * @maxLength 200
2339
- * @deprecated Category title.
2340
- * @targetRemovalDate 2025-07-16
2341
- */
2342
- title?: string;
2343
- /**
2344
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2345
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2346
- *
2347
- * Default: `-1`
2348
- */
2349
- displayPosition?: number | null;
2350
- /**
2351
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2352
- * @format GUID
2353
- */
2354
- translationId?: string | null;
2238
+ /** Get Blog Publications Count Stats request */
2239
+ interface QueryPublicationsCountStatsRequest {
2240
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2241
+ rangeStart?: Date | null;
2242
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2243
+ rangeEnd?: Date | null;
2244
+ /** Order of the returned results. */
2245
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2246
+ /** Number of months to include in the response. */
2247
+ months?: number;
2355
2248
  /**
2356
- * Category language.
2249
+ * Language filter
2357
2250
  *
2358
2251
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2359
- * @immutable
2360
- */
2361
- language?: string | null;
2362
- /**
2363
- * 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`.
2364
- * @maxLength 100
2365
- */
2366
- slug?: string;
2367
- /** SEO data. */
2368
- seoData?: SeoSchema;
2369
- /** Category cover image. */
2370
- coverImage?: string;
2371
- /**
2372
- * Date and time the Category was last updated.
2373
- * @readonly
2374
- */
2375
- _updatedDate?: Date | null;
2376
- }
2377
- interface CategoryTranslation {
2378
- /**
2379
- * Category ID.
2380
- * @format GUID
2381
- */
2382
- _id?: string;
2383
- /**
2384
- * Label displayed in the categories menu on the site.
2385
- * @maxLength 100
2386
- */
2387
- label?: string | null;
2388
- /**
2389
- * Language of the category.
2390
2252
  * @format LANGUAGE_TAG
2391
2253
  */
2392
2254
  language?: string | null;
2393
- /** URL of this category page. */
2394
- url?: string;
2395
- }
2396
- interface GetTemplateRequest {
2397
2255
  /**
2398
- * Post template id
2399
- * @format GUID
2256
+ * Timezone of the client.
2257
+ * @minLength 3
2258
+ * @maxLength 100
2400
2259
  */
2401
- postTemplateId?: string;
2260
+ timeZone?: string | null;
2402
2261
  }
2403
- interface GetTemplateResponse {
2404
- /** Post template */
2405
- postTemplate?: Post;
2262
+ declare enum QueryPublicationsCountStatsRequestOrder {
2263
+ UNKNOWN = "UNKNOWN",
2264
+ OLDEST = "OLDEST",
2265
+ NEWEST = "NEWEST"
2406
2266
  }
2407
- interface CreateDraftPostFromTemplateRequest {
2408
- /**
2409
- * Post template id
2410
- * @format GUID
2411
- */
2412
- postTemplateId?: string;
2267
+ /** @enumType */
2268
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2269
+ /** Get Blog Publications Count Stats response */
2270
+ interface QueryPublicationsCountStatsResponse {
2271
+ /** Chronologically ordered list of publications. */
2272
+ stats?: PeriodPublicationsCount[];
2413
2273
  }
2414
- interface CreateDraftPostFromTemplateResponse {
2415
- /** Created draft post */
2416
- draftPost?: DraftPost;
2274
+ /** Publications count for a specific time period */
2275
+ interface PeriodPublicationsCount {
2276
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2277
+ periodStart?: Date | null;
2278
+ /** Number of posts published during this month. */
2279
+ publicationsCount?: number;
2417
2280
  }
2418
- interface DraftPost {
2419
- /**
2420
- * Draft post ID.
2421
- * @readonly
2422
- * @maxLength 38
2423
- */
2424
- _id?: string;
2425
- /**
2426
- * Draft post title.
2427
- * @maxLength 200
2428
- */
2429
- title?: string;
2281
+ /** Get Blog Post Count Stats request */
2282
+ interface QueryPostCountStatsRequest {
2283
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2284
+ rangeStart?: Date | null;
2430
2285
  /**
2431
- * Draft post excerpt.
2286
+ * Order of returned results.
2432
2287
  *
2433
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2434
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2435
- * @maxLength 500
2436
- */
2437
- excerpt?: string | null;
2438
- /** Whether the draft post is marked as featured. */
2439
- featured?: boolean | null;
2440
- /**
2441
- * Category IDs of the draft post.
2442
- * @maxSize 10
2443
- * @maxLength 38
2444
- */
2445
- categoryIds?: string[];
2446
- /**
2447
- * Draft post owner's member ID.
2448
- * @format GUID
2449
- */
2450
- memberId?: string | null;
2451
- /**
2452
- * Hashtags in the post.
2453
- * @maxSize 100
2454
- * @maxLength 100
2455
- */
2456
- hashtags?: string[];
2457
- /** Whether commenting on the draft post is enabled. */
2458
- commentingEnabled?: boolean | null;
2459
- /**
2460
- * Estimated reading time of the draft post (calculated automatically).
2461
- * @readonly
2462
- */
2463
- minutesToRead?: number;
2464
- /** Image placed at the top of the blog page. */
2465
- heroImage?: string;
2466
- /**
2467
- * Tag IDs the draft post is tagged with.
2468
- * @maxSize 30
2469
- * @maxLength 38
2470
- */
2471
- tagIds?: string[];
2472
- /**
2473
- * IDs of posts related to this draft post.
2474
- * @maxSize 3
2475
- * @maxLength 38
2476
- */
2477
- relatedPostIds?: string[];
2478
- /**
2479
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2480
- * @maxSize 100
2481
- * @format GUID
2482
- */
2483
- pricingPlanIds?: string[];
2484
- /**
2485
- * ID of the draft post's translations.
2288
+ * - `OLDEST`: posts by date in ascending order.
2289
+ * - `NEWEST`: posts by date in descending order.
2486
2290
  *
2487
- * All translations of a single post share the same `translationId`.
2488
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2489
- * @format GUID
2291
+ * Default: `OLDEST`
2490
2292
  */
2491
- translationId?: string | null;
2293
+ order?: OrderWithLiterals;
2294
+ /** Number of months to include in response. */
2295
+ months?: number;
2492
2296
  /**
2493
- * Language the draft post is written in.
2297
+ * Language filter.
2494
2298
  *
2495
2299
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2300
+ * Pass a language to only receive the period post count for that specified language.
2496
2301
  * @format LANGUAGE_TAG
2497
2302
  */
2498
2303
  language?: string | null;
2499
2304
  /**
2500
- * Draft Post rich content.
2305
+ * Time zone to use when calculating the start of the month.
2501
2306
  *
2502
- * <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">
2503
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2504
- * </widget>
2505
- */
2506
- richContent?: RichContent;
2507
- /**
2508
- * Status of the draft post.
2509
- * @readonly
2510
- */
2511
- status?: StatusWithLiterals;
2512
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2513
- moderationDetails?: ModerationDetails;
2514
- /**
2515
- * Indicates if there are changes made to the draft post that have not yet been published.
2516
- * @readonly
2517
- */
2518
- hasUnpublishedChanges?: boolean;
2519
- /**
2520
- * Date the draft post was last edited.
2521
- * @readonly
2522
- */
2523
- editedDate?: Date | null;
2524
- /**
2525
- * Date the draft post is scheduled to be published.
2526
- * @readonly
2527
- */
2528
- scheduledPublishDate?: Date | null;
2529
- /** Date the post was first published. */
2530
- firstPublishedDate?: Date | null;
2531
- /** SEO data. */
2532
- seoData?: SeoSchema;
2533
- /**
2534
- * Draft post URL preview. What the URL will look like once the post is published.
2535
- * @readonly
2536
- */
2537
- url?: string;
2538
- /**
2539
- * Date the draft post was first created.
2540
- * @readonly
2541
- */
2542
- _createdDate?: Date | null;
2543
- /**
2544
- * SEO slug.
2307
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2308
+ * @minLength 3
2545
2309
  * @maxLength 100
2546
2310
  */
2547
- seoSlug?: string | null;
2548
- /** Post cover media. */
2549
- media?: Media;
2550
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
2551
- previewTextParagraph?: number | null;
2311
+ timeZone?: string | null;
2552
2312
  }
2553
- declare enum Origin {
2313
+ declare enum Order {
2554
2314
  UNKNOWN = "UNKNOWN",
2555
- /** Changed by admin */
2556
- ADMIN = "ADMIN",
2557
- /** Categories were changed */
2558
- ADD_CATEGORIES = "ADD_CATEGORIES",
2559
- /** Saved automatically */
2560
- AUTO_SAVE = "AUTO_SAVE",
2561
- /** Copied from template */
2562
- COPY_TEMPLATE = "COPY_TEMPLATE",
2563
- /** Imported */
2564
- IMPORT = "IMPORT",
2565
- /** Imported in bulk */
2566
- IMPORT_BULK = "IMPORT_BULK",
2567
- /** Imported with html import */
2568
- IMPORT_HTML = "IMPORT_HTML",
2569
- /** Patch import */
2570
- IMPORT_PATCH = "IMPORT_PATCH",
2571
- /** Changed language */
2572
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
2573
- /** Saved manually */
2574
- MANUAL_SAVE = "MANUAL_SAVE",
2575
- /** Affected by migration */
2576
- MIGRATION = "MIGRATION",
2577
- /** Affected by moderation */
2578
- MODERATION = "MODERATION",
2579
- /** Moved to trash */
2580
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
2581
- /** Pricing plans were changed */
2582
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
2583
- /** Was provisioned */
2584
- PROVISION = "PROVISION",
2585
- /** Was published */
2586
- PUBLISH = "PUBLISH",
2587
- /** Owner was reassigned */
2588
- REASSIGN_OWNER = "REASSIGN_OWNER",
2589
- /** Was reblogged */
2590
- REBLOG = "REBLOG",
2591
- /** Was restored */
2592
- RESTORE = "RESTORE",
2593
- /** Reverted to draft */
2594
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
2595
- /** Was translated */
2596
- TRANSLATION = "TRANSLATION",
2597
- /** Was unpublished */
2598
- UNPUBLISH = "UNPUBLISH",
2599
- /** Was unscheduled */
2600
- UNSCHEDULE = "UNSCHEDULE",
2601
- /** New edit session started which updated editing_session_id id */
2602
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
2603
- /** Was scheduled by Later */
2604
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
2605
- /** Was unscheduled by Later */
2606
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
2607
- /** Was published by Later */
2608
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
2609
- /** Was scheduled */
2610
- SCHEDULE = "SCHEDULE",
2611
- /** Was removed from moderation */
2612
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
2613
- /** Was rejected from moderation */
2614
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
2615
- /** Was approved in moderation */
2616
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
2617
- /** Tag was deleted */
2618
- DELETE_TAG = "DELETE_TAG",
2619
- /** Post was pinned */
2620
- PIN = "PIN",
2621
- /** Post was unpinned */
2622
- UNPIN = "UNPIN",
2623
- /** Saved automatically by AI tool. */
2624
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
2315
+ OLDEST = "OLDEST",
2316
+ NEWEST = "NEWEST"
2625
2317
  }
2626
2318
  /** @enumType */
2627
- 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';
2628
- declare enum Status {
2629
- UNKNOWN = "UNKNOWN",
2630
- /** Status indicating the draft post is published. */
2631
- PUBLISHED = "PUBLISHED",
2632
- /** Status indicating the draft post is unpublished. */
2633
- UNPUBLISHED = "UNPUBLISHED",
2634
- /** Status indicating the draft post is scheduled for publication. */
2635
- SCHEDULED = "SCHEDULED",
2636
- /** Status indicating the draft post is deleted. */
2637
- DELETED = "DELETED",
2638
- /** Status indicating the draft post is in review. */
2639
- IN_REVIEW = "IN_REVIEW"
2319
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2320
+ /** Get Blog Post Count Stats response */
2321
+ interface QueryPostCountStatsResponse {
2322
+ /** List of published post counts by month. */
2323
+ stats?: PeriodPostCount[];
2640
2324
  }
2641
- /** @enumType */
2642
- type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
2643
- interface DraftPostTranslation {
2325
+ /** Post count for a specific time period */
2326
+ interface PeriodPostCount {
2327
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2328
+ periodStart?: Date | null;
2329
+ /** Number of posts published during this month. */
2330
+ postCount?: number;
2331
+ }
2332
+ interface GetTotalPublicationsRequest {
2644
2333
  /**
2645
- * Post ID.
2646
- * @format GUID
2334
+ * Language filter
2335
+ * @minLength 2
2336
+ * @format LANGUAGE_TAG
2647
2337
  */
2648
- _id?: string;
2649
- /** Post status. */
2650
- status?: StatusWithLiterals;
2338
+ language?: string | null;
2339
+ }
2340
+ interface GetTotalPublicationsResponse {
2341
+ /** Total amount of publications. */
2342
+ total?: number;
2343
+ }
2344
+ interface GetTotalPostsRequest {
2651
2345
  /**
2652
- * Language the post is written in.
2346
+ * Language filter.
2347
+ *
2348
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2349
+ * Pass a language to receive the total amount of posts in that specified language.
2653
2350
  * @format LANGUAGE_TAG
2654
2351
  */
2655
2352
  language?: string | null;
2656
- /**
2657
- * Post slug. For example, 'post-slug'.
2658
- * @maxLength 100
2659
- */
2660
- slug?: string | null;
2661
- /** SEO data. */
2662
- seoData?: SeoSchema;
2663
- /** Post URL. */
2664
- url?: string;
2353
+ }
2354
+ interface GetTotalPostsResponse {
2355
+ /** Total amount of published posts. */
2356
+ total?: number;
2665
2357
  }
2666
2358
  interface DomainEvent extends DomainEventBodyOneOf {
2667
2359
  createdEvent?: EntityCreatedEvent;
@@ -2805,125 +2497,433 @@ declare enum WebhookIdentityType {
2805
2497
  }
2806
2498
  /** @enumType */
2807
2499
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2808
- /** Get Blog Publications Count Stats request */
2809
- interface QueryPublicationsCountStatsRequest {
2810
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2811
- rangeStart?: Date | null;
2812
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2813
- rangeEnd?: Date | null;
2814
- /** Order of the returned results. */
2815
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2816
- /** Number of months to include in the response. */
2817
- months?: number;
2500
+ interface ListTemplatesRequest {
2818
2501
  /**
2819
- * Language filter
2502
+ * Filter post templates by given template category ids
2503
+ * @maxSize 50
2504
+ * @format GUID
2505
+ */
2506
+ categoryIds?: string[];
2507
+ /**
2508
+ * Filter post templates by provided language
2509
+ * @format LANGUAGE_TAG
2510
+ */
2511
+ language?: string | null;
2512
+ /** Returns post template categories when set to TRUE */
2513
+ listTemplateCategories?: boolean;
2514
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2515
+ sort?: GetPostTemplatesSortWithLiterals;
2516
+ /** Pagination options. */
2517
+ paging?: BlogPaging;
2518
+ }
2519
+ declare enum GetPostTemplatesSort {
2520
+ /** Sort by ascending publishing date. */
2521
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2522
+ /** Sort by descending publishing date. */
2523
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2524
+ }
2525
+ /** @enumType */
2526
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2527
+ interface BlogPaging {
2528
+ /**
2529
+ * Number of items to skip in the current sort order.
2530
+ *
2531
+ *
2532
+ * Default: `0`
2533
+ */
2534
+ offset?: number;
2535
+ /**
2536
+ * Number of items to return.
2537
+ *
2538
+ *
2539
+ * Default:`50`
2540
+ * @min 1
2541
+ * @max 100
2542
+ */
2543
+ limit?: number;
2544
+ /**
2545
+ * Pointer to the next or previous page in the list of results.
2546
+ * @maxLength 2000
2547
+ */
2548
+ cursor?: string | null;
2549
+ }
2550
+ interface ListTemplatesResponse {
2551
+ /** Available post templates */
2552
+ postTemplates?: Post[];
2553
+ /** Details on the paged set of posts templates returned. */
2554
+ postTemplatesMetaData?: MetaData;
2555
+ /** Post template categories. This value is returned empty unless asked explicitly */
2556
+ templateCategories?: Category[];
2557
+ }
2558
+ interface MetaData {
2559
+ /** Number of items returned in this response. */
2560
+ count?: number;
2561
+ /** Requested offset. */
2562
+ offset?: number;
2563
+ /** Total number of items that match the query. */
2564
+ total?: number;
2565
+ /**
2566
+ * Pointer to the next or previous page in the list of results.
2567
+ * @maxLength 2000
2568
+ */
2569
+ cursor?: string | null;
2570
+ }
2571
+ interface Category {
2572
+ /**
2573
+ * Category ID.
2574
+ * @immutable
2575
+ * @maxLength 38
2576
+ */
2577
+ _id?: string;
2578
+ /**
2579
+ * Category label. Displayed in the Category Menu.
2580
+ * @maxLength 35
2581
+ */
2582
+ label?: string;
2583
+ /**
2584
+ * Number of posts in the category.
2585
+ * @readonly
2586
+ */
2587
+ postCount?: number;
2588
+ /**
2589
+ * The `url` of the page that lists every post with the specified category.
2590
+ * @readonly
2591
+ */
2592
+ url?: string;
2593
+ /**
2594
+ * Category description.
2595
+ * @maxLength 500
2596
+ */
2597
+ description?: string | null;
2598
+ /**
2599
+ * Category title.
2600
+ * @maxLength 200
2601
+ * @deprecated Category title.
2602
+ * @targetRemovalDate 2025-07-16
2603
+ */
2604
+ title?: string;
2605
+ /**
2606
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2607
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2608
+ *
2609
+ * Default: `-1`
2610
+ */
2611
+ displayPosition?: number | null;
2612
+ /**
2613
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2614
+ * @format GUID
2615
+ */
2616
+ translationId?: string | null;
2617
+ /**
2618
+ * Category language.
2820
2619
  *
2821
2620
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2621
+ * @immutable
2622
+ */
2623
+ language?: string | null;
2624
+ /**
2625
+ * 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`.
2626
+ * @maxLength 100
2627
+ */
2628
+ slug?: string;
2629
+ /** SEO data. */
2630
+ seoData?: SeoSchema;
2631
+ /** Category cover image. */
2632
+ coverImage?: string;
2633
+ /**
2634
+ * Date and time the Category was last updated.
2635
+ * @readonly
2636
+ */
2637
+ _updatedDate?: Date | null;
2638
+ }
2639
+ interface CategoryTranslation {
2640
+ /**
2641
+ * Category ID.
2642
+ * @format GUID
2643
+ */
2644
+ _id?: string;
2645
+ /**
2646
+ * Label displayed in the categories menu on the site.
2647
+ * @maxLength 100
2648
+ */
2649
+ label?: string | null;
2650
+ /**
2651
+ * Language of the category.
2822
2652
  * @format LANGUAGE_TAG
2823
2653
  */
2824
- language?: string | null;
2654
+ language?: string | null;
2655
+ /** URL of this category page. */
2656
+ url?: string;
2657
+ }
2658
+ interface GetTemplateRequest {
2659
+ /**
2660
+ * Post template id
2661
+ * @format GUID
2662
+ */
2663
+ postTemplateId?: string;
2664
+ }
2665
+ interface GetTemplateResponse {
2666
+ /** Post template */
2667
+ postTemplate?: Post;
2668
+ }
2669
+ interface CreateDraftPostFromTemplateRequest {
2670
+ /**
2671
+ * Post template id
2672
+ * @format GUID
2673
+ */
2674
+ postTemplateId?: string;
2675
+ }
2676
+ interface CreateDraftPostFromTemplateResponse {
2677
+ /** Created draft post */
2678
+ draftPost?: DraftPost;
2679
+ }
2680
+ interface DraftPost {
2681
+ /**
2682
+ * Draft post ID.
2683
+ * @readonly
2684
+ * @maxLength 38
2685
+ */
2686
+ _id?: string;
2687
+ /**
2688
+ * Draft post title.
2689
+ * @maxLength 200
2690
+ */
2691
+ title?: string;
2692
+ /**
2693
+ * Draft post excerpt.
2694
+ *
2695
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2696
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2697
+ * @maxLength 500
2698
+ */
2699
+ excerpt?: string | null;
2700
+ /** Whether the draft post is marked as featured. */
2701
+ featured?: boolean | null;
2702
+ /**
2703
+ * Category IDs of the draft post.
2704
+ * @maxSize 10
2705
+ * @maxLength 38
2706
+ */
2707
+ categoryIds?: string[];
2708
+ /**
2709
+ * Draft post owner's member ID.
2710
+ * @format GUID
2711
+ */
2712
+ memberId?: string | null;
2713
+ /**
2714
+ * Hashtags in the post.
2715
+ * @maxSize 100
2716
+ * @maxLength 100
2717
+ */
2718
+ hashtags?: string[];
2719
+ /** Whether commenting on the draft post is enabled. */
2720
+ commentingEnabled?: boolean | null;
2721
+ /**
2722
+ * Estimated reading time of the draft post (calculated automatically).
2723
+ * @readonly
2724
+ */
2725
+ minutesToRead?: number;
2726
+ /** Image placed at the top of the blog page. */
2727
+ heroImage?: string;
2728
+ /**
2729
+ * Tag IDs the draft post is tagged with.
2730
+ * @maxSize 30
2731
+ * @maxLength 38
2732
+ */
2733
+ tagIds?: string[];
2825
2734
  /**
2826
- * Timezone of the client.
2827
- * @minLength 3
2828
- * @maxLength 100
2735
+ * IDs of posts related to this draft post.
2736
+ * @maxSize 3
2737
+ * @maxLength 38
2829
2738
  */
2830
- timeZone?: string | null;
2831
- }
2832
- declare enum QueryPublicationsCountStatsRequestOrder {
2833
- UNKNOWN = "UNKNOWN",
2834
- OLDEST = "OLDEST",
2835
- NEWEST = "NEWEST"
2836
- }
2837
- /** @enumType */
2838
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2839
- /** Get Blog Publications Count Stats response */
2840
- interface QueryPublicationsCountStatsResponse {
2841
- /** Chronologically ordered list of publications. */
2842
- stats?: PeriodPublicationsCount[];
2843
- }
2844
- /** Publications count for a specific time period */
2845
- interface PeriodPublicationsCount {
2846
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2847
- periodStart?: Date | null;
2848
- /** Number of posts published during this month. */
2849
- publicationsCount?: number;
2850
- }
2851
- /** Get Blog Post Count Stats request */
2852
- interface QueryPostCountStatsRequest {
2853
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2854
- rangeStart?: Date | null;
2739
+ relatedPostIds?: string[];
2855
2740
  /**
2856
- * Order of returned results.
2857
- *
2858
- * - `OLDEST`: posts by date in ascending order.
2859
- * - `NEWEST`: posts by date in descending order.
2741
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2742
+ * @maxSize 100
2743
+ * @format GUID
2744
+ */
2745
+ pricingPlanIds?: string[];
2746
+ /**
2747
+ * ID of the draft post's translations.
2860
2748
  *
2861
- * Default: `OLDEST`
2749
+ * All translations of a single post share the same `translationId`.
2750
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2751
+ * @format GUID
2862
2752
  */
2863
- order?: OrderWithLiterals;
2864
- /** Number of months to include in response. */
2865
- months?: number;
2753
+ translationId?: string | null;
2866
2754
  /**
2867
- * Language filter.
2755
+ * Language the draft post is written in.
2868
2756
  *
2869
2757
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2870
- * Pass a language to only receive the period post count for that specified language.
2871
2758
  * @format LANGUAGE_TAG
2872
2759
  */
2873
2760
  language?: string | null;
2874
2761
  /**
2875
- * Time zone to use when calculating the start of the month.
2762
+ * Draft Post rich content.
2876
2763
  *
2877
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2878
- * @minLength 3
2764
+ * <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">
2765
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2766
+ * </widget>
2767
+ */
2768
+ richContent?: RichContent;
2769
+ /**
2770
+ * Status of the draft post.
2771
+ * @readonly
2772
+ */
2773
+ status?: StatusWithLiterals;
2774
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2775
+ moderationDetails?: ModerationDetails;
2776
+ /**
2777
+ * Indicates if there are changes made to the draft post that have not yet been published.
2778
+ * @readonly
2779
+ */
2780
+ hasUnpublishedChanges?: boolean;
2781
+ /**
2782
+ * Date the draft post was last edited.
2783
+ * @readonly
2784
+ */
2785
+ editedDate?: Date | null;
2786
+ /**
2787
+ * Date the draft post is scheduled to be published.
2788
+ * @readonly
2789
+ */
2790
+ scheduledPublishDate?: Date | null;
2791
+ /** Date the post was first published. */
2792
+ firstPublishedDate?: Date | null;
2793
+ /** SEO data. */
2794
+ seoData?: SeoSchema;
2795
+ /**
2796
+ * Draft post URL preview. What the URL will look like once the post is published.
2797
+ * @readonly
2798
+ */
2799
+ url?: string;
2800
+ /**
2801
+ * Date the draft post was first created.
2802
+ * @readonly
2803
+ */
2804
+ _createdDate?: Date | null;
2805
+ /**
2806
+ * SEO slug.
2879
2807
  * @maxLength 100
2880
2808
  */
2881
- timeZone?: string | null;
2809
+ seoSlug?: string | null;
2810
+ /** Post cover media. */
2811
+ media?: Media;
2812
+ /** Number of paragraphs to display in a paid content preview for non-paying users. */
2813
+ previewTextParagraph?: number | null;
2882
2814
  }
2883
- declare enum Order {
2815
+ declare enum Origin {
2884
2816
  UNKNOWN = "UNKNOWN",
2885
- OLDEST = "OLDEST",
2886
- NEWEST = "NEWEST"
2817
+ /** Changed by admin */
2818
+ ADMIN = "ADMIN",
2819
+ /** Categories were changed */
2820
+ ADD_CATEGORIES = "ADD_CATEGORIES",
2821
+ /** Saved automatically */
2822
+ AUTO_SAVE = "AUTO_SAVE",
2823
+ /** Copied from template */
2824
+ COPY_TEMPLATE = "COPY_TEMPLATE",
2825
+ /** Imported */
2826
+ IMPORT = "IMPORT",
2827
+ /** Imported in bulk */
2828
+ IMPORT_BULK = "IMPORT_BULK",
2829
+ /** Imported with html import */
2830
+ IMPORT_HTML = "IMPORT_HTML",
2831
+ /** Patch import */
2832
+ IMPORT_PATCH = "IMPORT_PATCH",
2833
+ /** Changed language */
2834
+ LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
2835
+ /** Saved manually */
2836
+ MANUAL_SAVE = "MANUAL_SAVE",
2837
+ /** Affected by migration */
2838
+ MIGRATION = "MIGRATION",
2839
+ /** Affected by moderation */
2840
+ MODERATION = "MODERATION",
2841
+ /** Moved to trash */
2842
+ MOVE_TO_TRASH = "MOVE_TO_TRASH",
2843
+ /** Pricing plans were changed */
2844
+ PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
2845
+ /** Was provisioned */
2846
+ PROVISION = "PROVISION",
2847
+ /** Was published */
2848
+ PUBLISH = "PUBLISH",
2849
+ /** Owner was reassigned */
2850
+ REASSIGN_OWNER = "REASSIGN_OWNER",
2851
+ /** Was reblogged */
2852
+ REBLOG = "REBLOG",
2853
+ /** Was restored */
2854
+ RESTORE = "RESTORE",
2855
+ /** Reverted to draft */
2856
+ REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
2857
+ /** Was translated */
2858
+ TRANSLATION = "TRANSLATION",
2859
+ /** Was unpublished */
2860
+ UNPUBLISH = "UNPUBLISH",
2861
+ /** Was unscheduled */
2862
+ UNSCHEDULE = "UNSCHEDULE",
2863
+ /** New edit session started which updated editing_session_id id */
2864
+ NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
2865
+ /** Was scheduled by Later */
2866
+ SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
2867
+ /** Was unscheduled by Later */
2868
+ SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
2869
+ /** Was published by Later */
2870
+ SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
2871
+ /** Was scheduled */
2872
+ SCHEDULE = "SCHEDULE",
2873
+ /** Was removed from moderation */
2874
+ REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
2875
+ /** Was rejected from moderation */
2876
+ REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
2877
+ /** Was approved in moderation */
2878
+ APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
2879
+ /** Tag was deleted */
2880
+ DELETE_TAG = "DELETE_TAG",
2881
+ /** Post was pinned */
2882
+ PIN = "PIN",
2883
+ /** Post was unpinned */
2884
+ UNPIN = "UNPIN",
2885
+ /** Saved automatically by AI tool. */
2886
+ AI_AUTO_SAVE = "AI_AUTO_SAVE"
2887
2887
  }
2888
2888
  /** @enumType */
2889
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2890
- /** Get Blog Post Count Stats response */
2891
- interface QueryPostCountStatsResponse {
2892
- /** List of published post counts by month. */
2893
- stats?: PeriodPostCount[];
2894
- }
2895
- /** Post count for a specific time period */
2896
- interface PeriodPostCount {
2897
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2898
- periodStart?: Date | null;
2899
- /** Number of posts published during this month. */
2900
- postCount?: number;
2889
+ 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';
2890
+ declare enum Status {
2891
+ UNKNOWN = "UNKNOWN",
2892
+ /** Status indicating the draft post is published. */
2893
+ PUBLISHED = "PUBLISHED",
2894
+ /** Status indicating the draft post is unpublished. */
2895
+ UNPUBLISHED = "UNPUBLISHED",
2896
+ /** Status indicating the draft post is scheduled for publication. */
2897
+ SCHEDULED = "SCHEDULED",
2898
+ /** Status indicating the draft post is deleted. */
2899
+ DELETED = "DELETED",
2900
+ /** Status indicating the draft post is in review. */
2901
+ IN_REVIEW = "IN_REVIEW"
2901
2902
  }
2902
- interface GetTotalPublicationsRequest {
2903
+ /** @enumType */
2904
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
2905
+ interface DraftPostTranslation {
2903
2906
  /**
2904
- * Language filter
2905
- * @minLength 2
2906
- * @format LANGUAGE_TAG
2907
+ * Post ID.
2908
+ * @format GUID
2907
2909
  */
2908
- language?: string | null;
2909
- }
2910
- interface GetTotalPublicationsResponse {
2911
- /** Total amount of publications. */
2912
- total?: number;
2913
- }
2914
- interface GetTotalPostsRequest {
2910
+ _id?: string;
2911
+ /** Post status. */
2912
+ status?: StatusWithLiterals;
2915
2913
  /**
2916
- * Language filter.
2917
- *
2918
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2919
- * Pass a language to receive the total amount of posts in that specified language.
2914
+ * Language the post is written in.
2920
2915
  * @format LANGUAGE_TAG
2921
2916
  */
2922
2917
  language?: string | null;
2923
- }
2924
- interface GetTotalPostsResponse {
2925
- /** Total amount of published posts. */
2926
- total?: number;
2918
+ /**
2919
+ * Post slug. For example, 'post-slug'.
2920
+ * @maxLength 100
2921
+ */
2922
+ slug?: string | null;
2923
+ /** SEO data. */
2924
+ seoData?: SeoSchema;
2925
+ /** Post URL. */
2926
+ url?: string;
2927
2927
  }
2928
2928
  interface GetTotalLikesPerMemberRequest {
2929
2929
  /**
@@ -3735,13 +3735,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
3735
3735
  /**
3736
3736
  * Retrieves the number of published posts per month within a specified time range.
3737
3737
  *
3738
- * The time range is set using the `rangeStart` and `months` properties.
3739
- * The time range always starts on the 1st day of the month set in `rangeStart` and
3740
- * includes the number of `months` following `rangeStart`.
3741
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
3742
- * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
3743
- * > Note: If there are no published posts in a month within the time range, 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.
3738
+ *
3739
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
3740
+ *
3741
+ * 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.
3742
+ *
3743
+ * >**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.
3744
3744
  * @public
3745
+ * @param options - Options specifying time frame, sort, and filter.
3745
3746
  * @permissionId BLOG.READ-PUBLICATION
3746
3747
  * @applicableIdentity APP
3747
3748
  * @returns Get Blog Post Count Stats response
@@ -3782,6 +3783,7 @@ interface QueryPostCountStatsOptions {
3782
3783
  /**
3783
3784
  * Retrieves the total amount of published posts of the blog.
3784
3785
  * @public
3786
+ * @param options - Language Options.
3785
3787
  * @permissionId BLOG.READ-PUBLICATION
3786
3788
  * @applicableIdentity APP
3787
3789
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -3802,12 +3804,12 @@ interface GetTotalPostsOptions {
3802
3804
  * @param postId - Post ID.
3803
3805
  * @public
3804
3806
  * @requiredField postId
3807
+ * @param options - Options specifying which fields to return.
3805
3808
  * @permissionId BLOG.READ-PUBLICATION
3806
3809
  * @applicableIdentity APP
3807
- * @returns Retrieved post info.
3808
3810
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
3809
3811
  */
3810
- declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
3812
+ 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.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `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>>;
3811
3813
  interface GetPostOptions {
3812
3814
  /**
3813
3815
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -3827,6 +3829,7 @@ interface GetPostOptions {
3827
3829
  * @param slug - Slug of the post to retrieve.
3828
3830
  * @public
3829
3831
  * @requiredField slug
3832
+ * @param options - Options specifying which fields to return.
3830
3833
  * @permissionId BLOG.READ-PUBLICATION
3831
3834
  * @applicableIdentity APP
3832
3835
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -3854,6 +3857,7 @@ interface GetPostBySlugOptions {
3854
3857
  * - `paging.limit` is `50`.
3855
3858
  * - `paging.offset` is `0`.
3856
3859
  * @public
3860
+ * @param options - Sort, filter, and paging options.
3857
3861
  * @permissionId BLOG.READ-PUBLICATION
3858
3862
  * @applicableIdentity APP
3859
3863
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -3924,23 +3928,26 @@ interface ListPostsOptions {
3924
3928
  fieldsets?: PostFieldFieldWithLiterals[];
3925
3929
  }
3926
3930
  /**
3927
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
3931
+ * Creates a query to retrieve a list of posts.
3928
3932
  *
3929
- * Query Posts runs with these defaults, which you can override:
3930
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
3931
- * - `paging.limit` is `50`.
3932
- * - `paging.offset` is `0`.
3933
3933
  *
3934
- * For field support for filters and sorting, see
3935
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3934
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
3935
+ *
3936
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
3937
+ *
3938
+ * 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.
3939
+ *
3940
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
3941
+ * + `limit(50)`
3942
+ * + `descending('firstPublishedDate')`
3943
+ *
3944
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
3945
+ *
3946
+ * To learn how to query posts, refer to the table below.
3936
3947
  *
3937
- * To learn about working with _Query_ endpoints, see
3938
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
3939
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
3940
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3941
- * For a detailed list of supported filters and sortable fields, see
3942
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3948
+ * 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`.
3943
3949
  * @public
3950
+ * @param options - Options specifying which fields to return.
3944
3951
  * @permissionId BLOG.READ-PUBLICATION
3945
3952
  * @applicableIdentity APP
3946
3953
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts