@wix/auto_sdk_blog_posts 1.0.131 → 1.0.133

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2389,125 +2389,433 @@ interface PostUnlikedInitiatorOneOf {
2389
2389
  */
2390
2390
  anonymousVisitorId?: string | null;
2391
2391
  }
2392
- /** Get Blog Publications Count Stats request */
2393
- interface QueryPublicationsCountStatsRequest {
2394
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2395
- rangeStart?: Date | null;
2396
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2397
- rangeEnd?: Date | null;
2398
- /** Order of the returned results. */
2399
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2400
- /** Number of months to include in the response. */
2401
- months?: number;
2392
+ interface ListTemplatesRequest {
2402
2393
  /**
2403
- * Language filter
2394
+ * Filter post templates by given template category ids
2395
+ * @maxSize 50
2396
+ * @format GUID
2397
+ */
2398
+ categoryIds?: string[];
2399
+ /**
2400
+ * Filter post templates by provided language
2401
+ * @format LANGUAGE_TAG
2402
+ */
2403
+ language?: string | null;
2404
+ /** Returns post template categories when set to TRUE */
2405
+ listTemplateCategories?: boolean;
2406
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2407
+ sort?: GetPostTemplatesSortWithLiterals;
2408
+ /** Pagination options. */
2409
+ paging?: BlogPaging;
2410
+ }
2411
+ declare enum GetPostTemplatesSort {
2412
+ /** Sort by ascending publishing date. */
2413
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2414
+ /** Sort by descending publishing date. */
2415
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2416
+ }
2417
+ /** @enumType */
2418
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2419
+ interface BlogPaging {
2420
+ /**
2421
+ * Number of items to skip in the current sort order.
2422
+ *
2423
+ *
2424
+ * Default: `0`
2425
+ */
2426
+ offset?: number;
2427
+ /**
2428
+ * Number of items to return.
2429
+ *
2430
+ *
2431
+ * Default:`50`
2432
+ * @min 1
2433
+ * @max 100
2434
+ */
2435
+ limit?: number;
2436
+ /**
2437
+ * Pointer to the next or previous page in the list of results.
2438
+ * @maxLength 2000
2439
+ */
2440
+ cursor?: string | null;
2441
+ }
2442
+ interface ListTemplatesResponse {
2443
+ /** Available post templates */
2444
+ postTemplates?: Post[];
2445
+ /** Details on the paged set of posts templates returned. */
2446
+ postTemplatesMetaData?: MetaData;
2447
+ /** Post template categories. This value is returned empty unless asked explicitly */
2448
+ templateCategories?: Category[];
2449
+ }
2450
+ interface MetaData {
2451
+ /** Number of items returned in this response. */
2452
+ count?: number;
2453
+ /** Requested offset. */
2454
+ offset?: number;
2455
+ /** Total number of items that match the query. */
2456
+ total?: number;
2457
+ /**
2458
+ * Pointer to the next or previous page in the list of results.
2459
+ * @maxLength 2000
2460
+ */
2461
+ cursor?: string | null;
2462
+ }
2463
+ interface Category {
2464
+ /**
2465
+ * Category ID.
2466
+ * @immutable
2467
+ * @maxLength 38
2468
+ */
2469
+ _id?: string;
2470
+ /**
2471
+ * Category label. Displayed in the Category Menu.
2472
+ * @maxLength 35
2473
+ */
2474
+ label?: string;
2475
+ /**
2476
+ * Number of posts in the category.
2477
+ * @readonly
2478
+ */
2479
+ postCount?: number;
2480
+ /**
2481
+ * The `url` of the page that lists every post with the specified category.
2482
+ * @readonly
2483
+ */
2484
+ url?: string;
2485
+ /**
2486
+ * Category description.
2487
+ * @maxLength 500
2488
+ */
2489
+ description?: string | null;
2490
+ /**
2491
+ * Category title.
2492
+ * @maxLength 200
2493
+ * @deprecated Category title.
2494
+ * @targetRemovalDate 2025-07-16
2495
+ */
2496
+ title?: string;
2497
+ /**
2498
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2499
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2500
+ *
2501
+ * Default: `-1`
2502
+ */
2503
+ displayPosition?: number | null;
2504
+ /**
2505
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2506
+ * @format GUID
2507
+ */
2508
+ translationId?: string | null;
2509
+ /**
2510
+ * Category language.
2404
2511
  *
2405
2512
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2406
- * @format LANGUAGE_TAG
2513
+ * @immutable
2407
2514
  */
2408
2515
  language?: string | null;
2409
2516
  /**
2410
- * Timezone of the client.
2411
- * @minLength 3
2517
+ * 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`.
2412
2518
  * @maxLength 100
2413
2519
  */
2414
- timeZone?: string | null;
2520
+ slug?: string;
2521
+ /** SEO data. */
2522
+ seoData?: SeoSchema;
2523
+ /** Category cover image. */
2524
+ coverImage?: string;
2525
+ /**
2526
+ * Date and time the Category was last updated.
2527
+ * @readonly
2528
+ */
2529
+ _updatedDate?: Date | null;
2415
2530
  }
2416
- declare enum QueryPublicationsCountStatsRequestOrder {
2417
- UNKNOWN = "UNKNOWN",
2418
- OLDEST = "OLDEST",
2419
- NEWEST = "NEWEST"
2531
+ interface CategoryTranslation {
2532
+ /**
2533
+ * Category ID.
2534
+ * @format GUID
2535
+ */
2536
+ _id?: string;
2537
+ /**
2538
+ * Label displayed in the categories menu on the site.
2539
+ * @maxLength 100
2540
+ */
2541
+ label?: string | null;
2542
+ /**
2543
+ * Language of the category.
2544
+ * @format LANGUAGE_TAG
2545
+ */
2546
+ language?: string | null;
2547
+ /** URL of this category page. */
2548
+ url?: string;
2420
2549
  }
2421
- /** @enumType */
2422
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2423
- /** Get Blog Publications Count Stats response */
2424
- interface QueryPublicationsCountStatsResponse {
2425
- /** Chronologically ordered list of publications. */
2426
- stats?: PeriodPublicationsCount[];
2550
+ interface GetTemplateRequest {
2551
+ /**
2552
+ * Post template id
2553
+ * @format GUID
2554
+ */
2555
+ postTemplateId?: string;
2427
2556
  }
2428
- /** Publications count for a specific time period */
2429
- interface PeriodPublicationsCount {
2430
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2431
- periodStart?: Date | null;
2432
- /** Number of posts published during this month. */
2433
- publicationsCount?: number;
2557
+ interface GetTemplateResponse {
2558
+ /** Post template */
2559
+ postTemplate?: Post;
2434
2560
  }
2435
- /** Get Blog Post Count Stats request */
2436
- interface QueryPostCountStatsRequest {
2437
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2438
- rangeStart?: Date | null;
2561
+ interface CreateDraftPostFromTemplateRequest {
2439
2562
  /**
2440
- * Order of returned results.
2563
+ * Post template id
2564
+ * @format GUID
2565
+ */
2566
+ postTemplateId?: string;
2567
+ }
2568
+ interface CreateDraftPostFromTemplateResponse {
2569
+ /** Created draft post */
2570
+ draftPost?: DraftPost;
2571
+ }
2572
+ interface DraftPost {
2573
+ /**
2574
+ * Draft post ID.
2575
+ * @readonly
2576
+ * @maxLength 38
2577
+ */
2578
+ _id?: string;
2579
+ /**
2580
+ * Draft post title.
2581
+ * @maxLength 200
2582
+ */
2583
+ title?: string;
2584
+ /**
2585
+ * Draft post excerpt.
2441
2586
  *
2442
- * - `OLDEST`: posts by date in ascending order.
2443
- * - `NEWEST`: posts by date in descending order.
2587
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2588
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2589
+ * @maxLength 500
2590
+ */
2591
+ excerpt?: string | null;
2592
+ /** Whether the draft post is marked as featured. */
2593
+ featured?: boolean | null;
2594
+ /**
2595
+ * Category IDs of the draft post.
2596
+ * @maxSize 10
2597
+ * @maxLength 38
2598
+ */
2599
+ categoryIds?: string[];
2600
+ /**
2601
+ * Draft post owner's member ID.
2602
+ * @format GUID
2603
+ */
2604
+ memberId?: string | null;
2605
+ /**
2606
+ * Hashtags in the post.
2607
+ * @maxSize 100
2608
+ * @maxLength 100
2609
+ */
2610
+ hashtags?: string[];
2611
+ /** Whether commenting on the draft post is enabled. */
2612
+ commentingEnabled?: boolean | null;
2613
+ /**
2614
+ * Estimated reading time of the draft post (calculated automatically).
2615
+ * @readonly
2616
+ */
2617
+ minutesToRead?: number;
2618
+ /** Image placed at the top of the blog page. */
2619
+ heroImage?: string;
2620
+ /**
2621
+ * Tag IDs the draft post is tagged with.
2622
+ * @maxSize 30
2623
+ * @maxLength 38
2624
+ */
2625
+ tagIds?: string[];
2626
+ /**
2627
+ * IDs of posts related to this draft post.
2628
+ * @maxSize 3
2629
+ * @maxLength 38
2630
+ */
2631
+ relatedPostIds?: string[];
2632
+ /**
2633
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2634
+ * @maxSize 100
2635
+ * @format GUID
2636
+ */
2637
+ pricingPlanIds?: string[];
2638
+ /**
2639
+ * ID of the draft post's translations.
2444
2640
  *
2445
- * Default: `OLDEST`
2641
+ * All translations of a single post share the same `translationId`.
2642
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2643
+ * @format GUID
2446
2644
  */
2447
- order?: OrderWithLiterals;
2448
- /** Number of months to include in response. */
2449
- months?: number;
2645
+ translationId?: string | null;
2450
2646
  /**
2451
- * Language filter.
2647
+ * Language the draft post is written in.
2452
2648
  *
2453
2649
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2454
- * Pass a language to only receive the period post count for that specified language.
2455
2650
  * @format LANGUAGE_TAG
2456
2651
  */
2457
2652
  language?: string | null;
2458
2653
  /**
2459
- * Time zone to use when calculating the start of the month.
2654
+ * Draft Post rich content.
2460
2655
  *
2461
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2462
- * @minLength 3
2656
+ * <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">
2657
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2658
+ * </widget>
2659
+ */
2660
+ richContent?: RichContent;
2661
+ /**
2662
+ * Status of the draft post.
2663
+ * @readonly
2664
+ */
2665
+ status?: StatusWithLiterals;
2666
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2667
+ moderationDetails?: ModerationDetails;
2668
+ /**
2669
+ * Indicates if there are changes made to the draft post that have not yet been published.
2670
+ * @readonly
2671
+ */
2672
+ hasUnpublishedChanges?: boolean;
2673
+ /**
2674
+ * Date the draft post was last edited.
2675
+ * @readonly
2676
+ */
2677
+ editedDate?: Date | null;
2678
+ /**
2679
+ * Date the draft post is scheduled to be published.
2680
+ * @readonly
2681
+ */
2682
+ scheduledPublishDate?: Date | null;
2683
+ /** Date the post was first published. */
2684
+ firstPublishedDate?: Date | null;
2685
+ /** SEO data. */
2686
+ seoData?: SeoSchema;
2687
+ /**
2688
+ * Draft post URL preview. What the URL will look like once the post is published.
2689
+ * @readonly
2690
+ */
2691
+ url?: string;
2692
+ /**
2693
+ * Date the draft post was first created.
2694
+ * @readonly
2695
+ */
2696
+ _createdDate?: Date | null;
2697
+ /**
2698
+ * SEO slug.
2463
2699
  * @maxLength 100
2464
2700
  */
2465
- timeZone?: string | null;
2701
+ seoSlug?: string | null;
2702
+ /** Post cover media. */
2703
+ media?: Media;
2704
+ /** Number of paragraphs to display in a paid content preview for non-paying users. */
2705
+ previewTextParagraph?: number | null;
2466
2706
  }
2467
- declare enum Order {
2707
+ declare enum Origin {
2468
2708
  UNKNOWN = "UNKNOWN",
2469
- OLDEST = "OLDEST",
2470
- NEWEST = "NEWEST"
2709
+ /** Changed by admin */
2710
+ ADMIN = "ADMIN",
2711
+ /** Categories were changed */
2712
+ ADD_CATEGORIES = "ADD_CATEGORIES",
2713
+ /** Saved automatically */
2714
+ AUTO_SAVE = "AUTO_SAVE",
2715
+ /** Copied from template */
2716
+ COPY_TEMPLATE = "COPY_TEMPLATE",
2717
+ /** Imported */
2718
+ IMPORT = "IMPORT",
2719
+ /** Imported in bulk */
2720
+ IMPORT_BULK = "IMPORT_BULK",
2721
+ /** Imported with html import */
2722
+ IMPORT_HTML = "IMPORT_HTML",
2723
+ /** Patch import */
2724
+ IMPORT_PATCH = "IMPORT_PATCH",
2725
+ /** Changed language */
2726
+ LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
2727
+ /** Saved manually */
2728
+ MANUAL_SAVE = "MANUAL_SAVE",
2729
+ /** Affected by migration */
2730
+ MIGRATION = "MIGRATION",
2731
+ /** Affected by moderation */
2732
+ MODERATION = "MODERATION",
2733
+ /** Moved to trash */
2734
+ MOVE_TO_TRASH = "MOVE_TO_TRASH",
2735
+ /** Pricing plans were changed */
2736
+ PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
2737
+ /** Was provisioned */
2738
+ PROVISION = "PROVISION",
2739
+ /** Was published */
2740
+ PUBLISH = "PUBLISH",
2741
+ /** Owner was reassigned */
2742
+ REASSIGN_OWNER = "REASSIGN_OWNER",
2743
+ /** Was reblogged */
2744
+ REBLOG = "REBLOG",
2745
+ /** Was restored */
2746
+ RESTORE = "RESTORE",
2747
+ /** Reverted to draft */
2748
+ REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
2749
+ /** Was translated */
2750
+ TRANSLATION = "TRANSLATION",
2751
+ /** Was unpublished */
2752
+ UNPUBLISH = "UNPUBLISH",
2753
+ /** Was unscheduled */
2754
+ UNSCHEDULE = "UNSCHEDULE",
2755
+ /** New edit session started which updated editing_session_id id */
2756
+ NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
2757
+ /** Was scheduled by Later */
2758
+ SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
2759
+ /** Was unscheduled by Later */
2760
+ SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
2761
+ /** Was published by Later */
2762
+ SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
2763
+ /** Was scheduled */
2764
+ SCHEDULE = "SCHEDULE",
2765
+ /** Was removed from moderation */
2766
+ REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
2767
+ /** Was rejected from moderation */
2768
+ REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
2769
+ /** Was approved in moderation */
2770
+ APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
2771
+ /** Tag was deleted */
2772
+ DELETE_TAG = "DELETE_TAG",
2773
+ /** Post was pinned */
2774
+ PIN = "PIN",
2775
+ /** Post was unpinned */
2776
+ UNPIN = "UNPIN",
2777
+ /** Saved automatically by AI tool. */
2778
+ AI_AUTO_SAVE = "AI_AUTO_SAVE"
2471
2779
  }
2472
2780
  /** @enumType */
2473
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2474
- /** Get Blog Post Count Stats response */
2475
- interface QueryPostCountStatsResponse {
2476
- /** List of published post counts by month. */
2477
- stats?: PeriodPostCount[];
2478
- }
2479
- /** Post count for a specific time period */
2480
- interface PeriodPostCount {
2481
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2482
- periodStart?: Date | null;
2483
- /** Number of posts published during this month. */
2484
- postCount?: number;
2781
+ 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';
2782
+ declare enum Status {
2783
+ UNKNOWN = "UNKNOWN",
2784
+ /** Status indicating the draft post is published. */
2785
+ PUBLISHED = "PUBLISHED",
2786
+ /** Status indicating the draft post is unpublished. */
2787
+ UNPUBLISHED = "UNPUBLISHED",
2788
+ /** Status indicating the draft post is scheduled for publication. */
2789
+ SCHEDULED = "SCHEDULED",
2790
+ /** Status indicating the draft post is deleted. */
2791
+ DELETED = "DELETED",
2792
+ /** Status indicating the draft post is in review. */
2793
+ IN_REVIEW = "IN_REVIEW"
2485
2794
  }
2486
- interface GetTotalPublicationsRequest {
2795
+ /** @enumType */
2796
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
2797
+ interface DraftPostTranslation {
2487
2798
  /**
2488
- * Language filter
2489
- * @minLength 2
2490
- * @format LANGUAGE_TAG
2799
+ * Post ID.
2800
+ * @format GUID
2491
2801
  */
2492
- language?: string | null;
2493
- }
2494
- interface GetTotalPublicationsResponse {
2495
- /** Total amount of publications. */
2496
- total?: number;
2497
- }
2498
- interface GetTotalPostsRequest {
2802
+ _id?: string;
2803
+ /** Post status. */
2804
+ status?: StatusWithLiterals;
2499
2805
  /**
2500
- * Language filter.
2501
- *
2502
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2503
- * Pass a language to receive the total amount of posts in that specified language.
2806
+ * Language the post is written in.
2504
2807
  * @format LANGUAGE_TAG
2505
2808
  */
2506
2809
  language?: string | null;
2507
- }
2508
- interface GetTotalPostsResponse {
2509
- /** Total amount of published posts. */
2510
- total?: number;
2810
+ /**
2811
+ * Post slug. For example, 'post-slug'.
2812
+ * @maxLength 100
2813
+ */
2814
+ slug?: string | null;
2815
+ /** SEO data. */
2816
+ seoData?: SeoSchema;
2817
+ /** Post URL. */
2818
+ url?: string;
2511
2819
  }
2512
2820
  interface DomainEvent extends DomainEventBodyOneOf {
2513
2821
  createdEvent?: EntityCreatedEvent;
@@ -2650,445 +2958,137 @@ interface AccountInfo {
2650
2958
  * ID of the Wix account associated with the event.
2651
2959
  * @format GUID
2652
2960
  */
2653
- accountId?: string | null;
2654
- /**
2655
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2656
- * @format GUID
2657
- */
2658
- parentAccountId?: string | null;
2659
- /**
2660
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2661
- * @format GUID
2662
- */
2663
- siteId?: string | null;
2664
- }
2665
- interface ListTemplatesRequest {
2666
- /**
2667
- * Filter post templates by given template category ids
2668
- * @maxSize 50
2669
- * @format GUID
2670
- */
2671
- categoryIds?: string[];
2672
- /**
2673
- * Filter post templates by provided language
2674
- * @format LANGUAGE_TAG
2675
- */
2676
- language?: string | null;
2677
- /** Returns post template categories when set to TRUE */
2678
- listTemplateCategories?: boolean;
2679
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2680
- sort?: GetPostTemplatesSortWithLiterals;
2681
- /** Pagination options. */
2682
- paging?: BlogPaging;
2683
- }
2684
- declare enum GetPostTemplatesSort {
2685
- /** Sort by ascending publishing date. */
2686
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2687
- /** Sort by descending publishing date. */
2688
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2689
- }
2690
- /** @enumType */
2691
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2692
- interface BlogPaging {
2693
- /**
2694
- * Number of items to skip in the current sort order.
2695
- *
2696
- *
2697
- * Default: `0`
2698
- */
2699
- offset?: number;
2700
- /**
2701
- * Number of items to return.
2702
- *
2703
- *
2704
- * Default:`50`
2705
- * @min 1
2706
- * @max 100
2707
- */
2708
- limit?: number;
2709
- /**
2710
- * Pointer to the next or previous page in the list of results.
2711
- * @maxLength 2000
2712
- */
2713
- cursor?: string | null;
2714
- }
2715
- interface ListTemplatesResponse {
2716
- /** Available post templates */
2717
- postTemplates?: Post[];
2718
- /** Details on the paged set of posts templates returned. */
2719
- postTemplatesMetaData?: MetaData;
2720
- /** Post template categories. This value is returned empty unless asked explicitly */
2721
- templateCategories?: Category[];
2722
- }
2723
- interface MetaData {
2724
- /** Number of items returned in this response. */
2725
- count?: number;
2726
- /** Requested offset. */
2727
- offset?: number;
2728
- /** Total number of items that match the query. */
2729
- total?: number;
2730
- /**
2731
- * Pointer to the next or previous page in the list of results.
2732
- * @maxLength 2000
2733
- */
2734
- cursor?: string | null;
2735
- }
2736
- interface Category {
2737
- /**
2738
- * Category ID.
2739
- * @immutable
2740
- * @maxLength 38
2741
- */
2742
- _id?: string;
2743
- /**
2744
- * Category label. Displayed in the Category Menu.
2745
- * @maxLength 35
2746
- */
2747
- label?: string;
2748
- /**
2749
- * Number of posts in the category.
2750
- * @readonly
2751
- */
2752
- postCount?: number;
2753
- /**
2754
- * The `url` of the page that lists every post with the specified category.
2755
- * @readonly
2756
- */
2757
- url?: string;
2758
- /**
2759
- * Category description.
2760
- * @maxLength 500
2761
- */
2762
- description?: string | null;
2763
- /**
2764
- * Category title.
2765
- * @maxLength 200
2766
- * @deprecated Category title.
2767
- * @targetRemovalDate 2025-07-16
2768
- */
2769
- title?: string;
2770
- /**
2771
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2772
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2773
- *
2774
- * Default: `-1`
2775
- */
2776
- displayPosition?: number | null;
2777
- /**
2778
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2779
- * @format GUID
2780
- */
2781
- translationId?: string | null;
2782
- /**
2783
- * Category language.
2784
- *
2785
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2786
- * @immutable
2787
- */
2788
- language?: string | null;
2789
- /**
2790
- * 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`.
2791
- * @maxLength 100
2792
- */
2793
- slug?: string;
2794
- /** SEO data. */
2795
- seoData?: SeoSchema;
2796
- /** Category cover image. */
2797
- coverImage?: string;
2798
- /**
2799
- * Date and time the Category was last updated.
2800
- * @readonly
2801
- */
2802
- _updatedDate?: Date | null;
2803
- }
2804
- interface CategoryTranslation {
2805
- /**
2806
- * Category ID.
2807
- * @format GUID
2808
- */
2809
- _id?: string;
2810
- /**
2811
- * Label displayed in the categories menu on the site.
2812
- * @maxLength 100
2813
- */
2814
- label?: string | null;
2815
- /**
2816
- * Language of the category.
2817
- * @format LANGUAGE_TAG
2818
- */
2819
- language?: string | null;
2820
- /** URL of this category page. */
2821
- url?: string;
2822
- }
2823
- interface GetTemplateRequest {
2824
- /**
2825
- * Post template id
2826
- * @format GUID
2827
- */
2828
- postTemplateId?: string;
2829
- }
2830
- interface GetTemplateResponse {
2831
- /** Post template */
2832
- postTemplate?: Post;
2833
- }
2834
- interface CreateDraftPostFromTemplateRequest {
2835
- /**
2836
- * Post template id
2837
- * @format GUID
2838
- */
2839
- postTemplateId?: string;
2840
- }
2841
- interface CreateDraftPostFromTemplateResponse {
2842
- /** Created draft post */
2843
- draftPost?: DraftPost;
2844
- }
2845
- interface DraftPost {
2846
- /**
2847
- * Draft post ID.
2848
- * @readonly
2849
- * @maxLength 38
2850
- */
2851
- _id?: string;
2852
- /**
2853
- * Draft post title.
2854
- * @maxLength 200
2855
- */
2856
- title?: string;
2857
- /**
2858
- * Draft post excerpt.
2859
- *
2860
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2861
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2862
- * @maxLength 500
2863
- */
2864
- excerpt?: string | null;
2865
- /** Whether the draft post is marked as featured. */
2866
- featured?: boolean | null;
2867
- /**
2868
- * Category IDs of the draft post.
2869
- * @maxSize 10
2870
- * @maxLength 38
2871
- */
2872
- categoryIds?: string[];
2873
- /**
2874
- * Draft post owner's member ID.
2875
- * @format GUID
2876
- */
2877
- memberId?: string | null;
2878
- /**
2879
- * Hashtags in the post.
2880
- * @maxSize 100
2881
- * @maxLength 100
2882
- */
2883
- hashtags?: string[];
2884
- /** Whether commenting on the draft post is enabled. */
2885
- commentingEnabled?: boolean | null;
2886
- /**
2887
- * Estimated reading time of the draft post (calculated automatically).
2888
- * @readonly
2889
- */
2890
- minutesToRead?: number;
2891
- /** Image placed at the top of the blog page. */
2892
- heroImage?: string;
2893
- /**
2894
- * Tag IDs the draft post is tagged with.
2895
- * @maxSize 30
2896
- * @maxLength 38
2897
- */
2898
- tagIds?: string[];
2899
- /**
2900
- * IDs of posts related to this draft post.
2901
- * @maxSize 3
2902
- * @maxLength 38
2903
- */
2904
- relatedPostIds?: string[];
2961
+ accountId?: string | null;
2905
2962
  /**
2906
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2907
- * @maxSize 100
2963
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2908
2964
  * @format GUID
2909
2965
  */
2910
- pricingPlanIds?: string[];
2966
+ parentAccountId?: string | null;
2911
2967
  /**
2912
- * ID of the draft post's translations.
2913
- *
2914
- * All translations of a single post share the same `translationId`.
2915
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2968
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2916
2969
  * @format GUID
2917
2970
  */
2918
- translationId?: string | null;
2971
+ siteId?: string | null;
2972
+ }
2973
+ /** Get Blog Publications Count Stats request */
2974
+ interface QueryPublicationsCountStatsRequest {
2975
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2976
+ rangeStart?: Date | null;
2977
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2978
+ rangeEnd?: Date | null;
2979
+ /** Order of the returned results. */
2980
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2981
+ /** Number of months to include in the response. */
2982
+ months?: number;
2919
2983
  /**
2920
- * Language the draft post is written in.
2984
+ * Language filter
2921
2985
  *
2922
2986
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2923
2987
  * @format LANGUAGE_TAG
2924
2988
  */
2925
2989
  language?: string | null;
2926
2990
  /**
2927
- * Draft Post rich content.
2928
- *
2929
- * <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">
2930
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2931
- * </widget>
2932
- */
2933
- richContent?: RichContent;
2934
- /**
2935
- * Status of the draft post.
2936
- * @readonly
2937
- */
2938
- status?: StatusWithLiterals;
2939
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2940
- moderationDetails?: ModerationDetails;
2941
- /**
2942
- * Indicates if there are changes made to the draft post that have not yet been published.
2943
- * @readonly
2944
- */
2945
- hasUnpublishedChanges?: boolean;
2946
- /**
2947
- * Date the draft post was last edited.
2948
- * @readonly
2949
- */
2950
- editedDate?: Date | null;
2951
- /**
2952
- * Date the draft post is scheduled to be published.
2953
- * @readonly
2991
+ * Timezone of the client.
2992
+ * @minLength 3
2993
+ * @maxLength 100
2954
2994
  */
2955
- scheduledPublishDate?: Date | null;
2956
- /** Date the post was first published. */
2957
- firstPublishedDate?: Date | null;
2958
- /** SEO data. */
2959
- seoData?: SeoSchema;
2995
+ timeZone?: string | null;
2996
+ }
2997
+ declare enum QueryPublicationsCountStatsRequestOrder {
2998
+ UNKNOWN = "UNKNOWN",
2999
+ OLDEST = "OLDEST",
3000
+ NEWEST = "NEWEST"
3001
+ }
3002
+ /** @enumType */
3003
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3004
+ /** Get Blog Publications Count Stats response */
3005
+ interface QueryPublicationsCountStatsResponse {
3006
+ /** Chronologically ordered list of publications. */
3007
+ stats?: PeriodPublicationsCount[];
3008
+ }
3009
+ /** Publications count for a specific time period */
3010
+ interface PeriodPublicationsCount {
3011
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3012
+ periodStart?: Date | null;
3013
+ /** Number of posts published during this month. */
3014
+ publicationsCount?: number;
3015
+ }
3016
+ /** Get Blog Post Count Stats request */
3017
+ interface QueryPostCountStatsRequest {
3018
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3019
+ rangeStart?: Date | null;
2960
3020
  /**
2961
- * Draft post URL preview. What the URL will look like once the post is published.
2962
- * @readonly
3021
+ * Order of returned results.
3022
+ *
3023
+ * - `OLDEST`: posts by date in ascending order.
3024
+ * - `NEWEST`: posts by date in descending order.
3025
+ *
3026
+ * Default: `OLDEST`
2963
3027
  */
2964
- url?: string;
3028
+ order?: OrderWithLiterals;
3029
+ /** Number of months to include in response. */
3030
+ months?: number;
2965
3031
  /**
2966
- * Date the draft post was first created.
2967
- * @readonly
3032
+ * Language filter.
3033
+ *
3034
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3035
+ * Pass a language to only receive the period post count for that specified language.
3036
+ * @format LANGUAGE_TAG
2968
3037
  */
2969
- _createdDate?: Date | null;
3038
+ language?: string | null;
2970
3039
  /**
2971
- * SEO slug.
3040
+ * Time zone to use when calculating the start of the month.
3041
+ *
3042
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3043
+ * @minLength 3
2972
3044
  * @maxLength 100
2973
3045
  */
2974
- seoSlug?: string | null;
2975
- /** Post cover media. */
2976
- media?: Media;
2977
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
2978
- previewTextParagraph?: number | null;
3046
+ timeZone?: string | null;
2979
3047
  }
2980
- declare enum Origin {
3048
+ declare enum Order {
2981
3049
  UNKNOWN = "UNKNOWN",
2982
- /** Changed by admin */
2983
- ADMIN = "ADMIN",
2984
- /** Categories were changed */
2985
- ADD_CATEGORIES = "ADD_CATEGORIES",
2986
- /** Saved automatically */
2987
- AUTO_SAVE = "AUTO_SAVE",
2988
- /** Copied from template */
2989
- COPY_TEMPLATE = "COPY_TEMPLATE",
2990
- /** Imported */
2991
- IMPORT = "IMPORT",
2992
- /** Imported in bulk */
2993
- IMPORT_BULK = "IMPORT_BULK",
2994
- /** Imported with html import */
2995
- IMPORT_HTML = "IMPORT_HTML",
2996
- /** Patch import */
2997
- IMPORT_PATCH = "IMPORT_PATCH",
2998
- /** Changed language */
2999
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
3000
- /** Saved manually */
3001
- MANUAL_SAVE = "MANUAL_SAVE",
3002
- /** Affected by migration */
3003
- MIGRATION = "MIGRATION",
3004
- /** Affected by moderation */
3005
- MODERATION = "MODERATION",
3006
- /** Moved to trash */
3007
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
3008
- /** Pricing plans were changed */
3009
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
3010
- /** Was provisioned */
3011
- PROVISION = "PROVISION",
3012
- /** Was published */
3013
- PUBLISH = "PUBLISH",
3014
- /** Owner was reassigned */
3015
- REASSIGN_OWNER = "REASSIGN_OWNER",
3016
- /** Was reblogged */
3017
- REBLOG = "REBLOG",
3018
- /** Was restored */
3019
- RESTORE = "RESTORE",
3020
- /** Reverted to draft */
3021
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
3022
- /** Was translated */
3023
- TRANSLATION = "TRANSLATION",
3024
- /** Was unpublished */
3025
- UNPUBLISH = "UNPUBLISH",
3026
- /** Was unscheduled */
3027
- UNSCHEDULE = "UNSCHEDULE",
3028
- /** New edit session started which updated editing_session_id id */
3029
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
3030
- /** Was scheduled by Later */
3031
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
3032
- /** Was unscheduled by Later */
3033
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
3034
- /** Was published by Later */
3035
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
3036
- /** Was scheduled */
3037
- SCHEDULE = "SCHEDULE",
3038
- /** Was removed from moderation */
3039
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
3040
- /** Was rejected from moderation */
3041
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
3042
- /** Was approved in moderation */
3043
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
3044
- /** Tag was deleted */
3045
- DELETE_TAG = "DELETE_TAG",
3046
- /** Post was pinned */
3047
- PIN = "PIN",
3048
- /** Post was unpinned */
3049
- UNPIN = "UNPIN",
3050
- /** Saved automatically by AI tool. */
3051
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
3050
+ OLDEST = "OLDEST",
3051
+ NEWEST = "NEWEST"
3052
3052
  }
3053
3053
  /** @enumType */
3054
- 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';
3055
- declare enum Status {
3056
- UNKNOWN = "UNKNOWN",
3057
- /** Status indicating the draft post is published. */
3058
- PUBLISHED = "PUBLISHED",
3059
- /** Status indicating the draft post is unpublished. */
3060
- UNPUBLISHED = "UNPUBLISHED",
3061
- /** Status indicating the draft post is scheduled for publication. */
3062
- SCHEDULED = "SCHEDULED",
3063
- /** Status indicating the draft post is deleted. */
3064
- DELETED = "DELETED",
3065
- /** Status indicating the draft post is in review. */
3066
- IN_REVIEW = "IN_REVIEW"
3054
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3055
+ /** Get Blog Post Count Stats response */
3056
+ interface QueryPostCountStatsResponse {
3057
+ /** List of published post counts by month. */
3058
+ stats?: PeriodPostCount[];
3067
3059
  }
3068
- /** @enumType */
3069
- type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
3070
- interface DraftPostTranslation {
3071
- /**
3072
- * Post ID.
3073
- * @format GUID
3074
- */
3075
- _id?: string;
3076
- /** Post status. */
3077
- status?: StatusWithLiterals;
3060
+ /** Post count for a specific time period */
3061
+ interface PeriodPostCount {
3062
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3063
+ periodStart?: Date | null;
3064
+ /** Number of posts published during this month. */
3065
+ postCount?: number;
3066
+ }
3067
+ interface GetTotalPublicationsRequest {
3078
3068
  /**
3079
- * Language the post is written in.
3069
+ * Language filter
3070
+ * @minLength 2
3080
3071
  * @format LANGUAGE_TAG
3081
3072
  */
3082
3073
  language?: string | null;
3074
+ }
3075
+ interface GetTotalPublicationsResponse {
3076
+ /** Total amount of publications. */
3077
+ total?: number;
3078
+ }
3079
+ interface GetTotalPostsRequest {
3083
3080
  /**
3084
- * Post slug. For example, 'post-slug'.
3085
- * @maxLength 100
3081
+ * Language filter.
3082
+ *
3083
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3084
+ * Pass a language to receive the total amount of posts in that specified language.
3085
+ * @format LANGUAGE_TAG
3086
3086
  */
3087
- slug?: string | null;
3088
- /** SEO data. */
3089
- seoData?: SeoSchema;
3090
- /** Post URL. */
3091
- url?: string;
3087
+ language?: string | null;
3088
+ }
3089
+ interface GetTotalPostsResponse {
3090
+ /** Total amount of published posts. */
3091
+ total?: number;
3092
3092
  }
3093
3093
  interface GetTotalLikesPerMemberRequest {
3094
3094
  /**
@@ -4349,12 +4349,10 @@ type PostQuery = {
4349
4349
  }[];
4350
4350
  };
4351
4351
  declare const utils: {
4352
- query: {
4353
- /** @enumType */
4354
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4355
- Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4356
- Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
4357
- };
4352
+ /** @enumType */
4353
+ QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4354
+ Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4355
+ Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
4358
4356
  };
4359
4357
  /**
4360
4358
  * Retrieves a post's metrics.