@wix/auto_sdk_blog_posts 1.0.101 → 1.0.103

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