@wix/auto_sdk_blog_posts 1.0.130 → 1.0.131

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 +1 -1
  2. package/build/cjs/index.js +30 -21
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +538 -521
  5. package/build/cjs/index.typings.js +30 -21
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +374 -360
  8. package/build/cjs/meta.js +27 -20
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1 -1
  11. package/build/es/index.mjs +29 -21
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +538 -521
  14. package/build/es/index.typings.mjs +29 -21
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +374 -360
  17. package/build/es/meta.mjs +26 -20
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +1 -1
  20. package/build/internal/cjs/index.js +30 -21
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +538 -521
  23. package/build/internal/cjs/index.typings.js +30 -21
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +374 -360
  26. package/build/internal/cjs/meta.js +27 -20
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +1 -1
  29. package/build/internal/es/index.mjs +29 -21
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +538 -521
  32. package/build/internal/es/index.typings.mjs +29 -21
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +374 -360
  35. package/build/internal/es/meta.mjs +26 -20
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +4 -4
@@ -2025,6 +2025,8 @@ interface LayoutData {
2025
2025
  containerData?: PluginContainerData;
2026
2026
  /** Defines where selected design propertied applies to */
2027
2027
  designTarget?: DesignTargetWithLiterals;
2028
+ /** Banner configuration. When present, this layout is displayed as a banner. */
2029
+ banner?: Banner;
2028
2030
  }
2029
2031
  declare enum Scaling {
2030
2032
  /** Auto image scaling */
@@ -2058,6 +2060,14 @@ declare enum ImagePosition {
2058
2060
  }
2059
2061
  /** @enumType */
2060
2062
  type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
2063
+ declare enum BannerOrigin {
2064
+ /** Banner originated from an image */
2065
+ IMAGE = "IMAGE",
2066
+ /** Banner originated from a layout */
2067
+ LAYOUT = "LAYOUT"
2068
+ }
2069
+ /** @enumType */
2070
+ type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2061
2071
  interface BackgroundImage {
2062
2072
  /** Background image. */
2063
2073
  media?: V1Media;
@@ -2094,6 +2104,10 @@ declare enum DesignTarget {
2094
2104
  }
2095
2105
  /** @enumType */
2096
2106
  type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
2107
+ interface Banner {
2108
+ /** Origin of the banner */
2109
+ origin?: BannerOriginWithLiterals;
2110
+ }
2097
2111
  interface LayoutCellData {
2098
2112
  /** Size of the cell in 12 columns grid. */
2099
2113
  colSpan?: number | null;
@@ -2382,135 +2396,408 @@ interface PostUnlikedInitiatorOneOf {
2382
2396
  */
2383
2397
  anonymousVisitorId?: string | null;
2384
2398
  }
2385
- interface ListTemplatesRequest {
2386
- /**
2387
- * Filter post templates by given template category ids
2388
- * @maxSize 50
2389
- * @format GUID
2390
- */
2391
- categoryIds?: string[];
2399
+ /** Get Blog Publications Count Stats request */
2400
+ interface QueryPublicationsCountStatsRequest {
2401
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2402
+ rangeStart?: Date | null;
2403
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2404
+ rangeEnd?: Date | null;
2405
+ /** Order of the returned results. */
2406
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2407
+ /** Number of months to include in the response. */
2408
+ months?: number;
2392
2409
  /**
2393
- * Filter post templates by provided language
2410
+ * Language filter
2411
+ *
2412
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2394
2413
  * @format LANGUAGE_TAG
2395
2414
  */
2396
2415
  language?: string | null;
2397
- /** Returns post template categories when set to TRUE */
2398
- listTemplateCategories?: boolean;
2399
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2400
- sort?: GetPostTemplatesSortWithLiterals;
2401
- /** Pagination options. */
2402
- paging?: BlogPaging;
2416
+ /**
2417
+ * Timezone of the client.
2418
+ * @minLength 3
2419
+ * @maxLength 100
2420
+ */
2421
+ timeZone?: string | null;
2403
2422
  }
2404
- declare enum GetPostTemplatesSort {
2405
- /** Sort by ascending publishing date. */
2406
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2407
- /** Sort by descending publishing date. */
2408
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2423
+ declare enum QueryPublicationsCountStatsRequestOrder {
2424
+ UNKNOWN = "UNKNOWN",
2425
+ OLDEST = "OLDEST",
2426
+ NEWEST = "NEWEST"
2409
2427
  }
2410
2428
  /** @enumType */
2411
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2412
- interface BlogPaging {
2429
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2430
+ /** Get Blog Publications Count Stats response */
2431
+ interface QueryPublicationsCountStatsResponse {
2432
+ /** Chronologically ordered list of publications. */
2433
+ stats?: PeriodPublicationsCount[];
2434
+ }
2435
+ /** Publications count for a specific time period */
2436
+ interface PeriodPublicationsCount {
2437
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2438
+ periodStart?: Date | null;
2439
+ /** Number of posts published during this month. */
2440
+ publicationsCount?: number;
2441
+ }
2442
+ /** Get Blog Post Count Stats request */
2443
+ interface QueryPostCountStatsRequest {
2444
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2445
+ rangeStart?: Date | null;
2413
2446
  /**
2414
- * Number of items to skip in the current sort order.
2447
+ * Order of returned results.
2415
2448
  *
2449
+ * - `OLDEST`: posts by date in ascending order.
2450
+ * - `NEWEST`: posts by date in descending order.
2416
2451
  *
2417
- * Default: `0`
2452
+ * Default: `OLDEST`
2418
2453
  */
2419
- offset?: number;
2454
+ order?: OrderWithLiterals;
2455
+ /** Number of months to include in response. */
2456
+ months?: number;
2420
2457
  /**
2421
- * Number of items to return.
2422
- *
2458
+ * Language filter.
2423
2459
  *
2424
- * Default:`50`
2425
- * @min 1
2426
- * @max 100
2460
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2461
+ * Pass a language to only receive the period post count for that specified language.
2462
+ * @format LANGUAGE_TAG
2427
2463
  */
2428
- limit?: number;
2464
+ language?: string | null;
2429
2465
  /**
2430
- * Pointer to the next or previous page in the list of results.
2431
- * @maxLength 2000
2466
+ * Time zone to use when calculating the start of the month.
2467
+ *
2468
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2469
+ * @minLength 3
2470
+ * @maxLength 100
2432
2471
  */
2433
- cursor?: string | null;
2472
+ timeZone?: string | null;
2434
2473
  }
2435
- interface ListTemplatesResponse {
2436
- /** Available post templates */
2437
- postTemplates?: Post[];
2438
- /** Details on the paged set of posts templates returned. */
2439
- postTemplatesMetaData?: MetaData;
2440
- /** Post template categories. This value is returned empty unless asked explicitly */
2441
- templateCategories?: Category[];
2474
+ declare enum Order {
2475
+ UNKNOWN = "UNKNOWN",
2476
+ OLDEST = "OLDEST",
2477
+ NEWEST = "NEWEST"
2442
2478
  }
2443
- interface MetaData {
2444
- /** Number of items returned in this response. */
2445
- count?: number;
2446
- /** Requested offset. */
2447
- offset?: number;
2448
- /** Total number of items that match the query. */
2449
- total?: number;
2479
+ /** @enumType */
2480
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2481
+ /** Get Blog Post Count Stats response */
2482
+ interface QueryPostCountStatsResponse {
2483
+ /** List of published post counts by month. */
2484
+ stats?: PeriodPostCount[];
2485
+ }
2486
+ /** Post count for a specific time period */
2487
+ interface PeriodPostCount {
2488
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2489
+ periodStart?: Date | null;
2490
+ /** Number of posts published during this month. */
2491
+ postCount?: number;
2492
+ }
2493
+ interface GetTotalPublicationsRequest {
2450
2494
  /**
2451
- * Pointer to the next or previous page in the list of results.
2452
- * @maxLength 2000
2495
+ * Language filter
2496
+ * @minLength 2
2497
+ * @format LANGUAGE_TAG
2453
2498
  */
2454
- cursor?: string | null;
2499
+ language?: string | null;
2455
2500
  }
2456
- interface Category {
2501
+ interface GetTotalPublicationsResponse {
2502
+ /** Total amount of publications. */
2503
+ total?: number;
2504
+ }
2505
+ interface GetTotalPostsRequest {
2457
2506
  /**
2458
- * Category ID.
2459
- * @immutable
2460
- * @maxLength 38
2507
+ * Language filter.
2508
+ *
2509
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2510
+ * Pass a language to receive the total amount of posts in that specified language.
2511
+ * @format LANGUAGE_TAG
2461
2512
  */
2513
+ language?: string | null;
2514
+ }
2515
+ interface GetTotalPostsResponse {
2516
+ /** Total amount of published posts. */
2517
+ total?: number;
2518
+ }
2519
+ interface DomainEvent extends DomainEventBodyOneOf {
2520
+ createdEvent?: EntityCreatedEvent;
2521
+ updatedEvent?: EntityUpdatedEvent;
2522
+ deletedEvent?: EntityDeletedEvent;
2523
+ actionEvent?: ActionEvent;
2524
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2462
2525
  _id?: string;
2463
2526
  /**
2464
- * Category label. Displayed in the Category Menu.
2465
- * @maxLength 35
2466
- */
2467
- label?: string;
2468
- /**
2469
- * Number of posts in the category.
2470
- * @readonly
2527
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2528
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2471
2529
  */
2472
- postCount?: number;
2530
+ entityFqdn?: string;
2473
2531
  /**
2474
- * The `url` of the page that lists every post with the specified category.
2475
- * @readonly
2532
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2533
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2476
2534
  */
2477
- url?: string;
2535
+ slug?: string;
2536
+ /** ID of the entity associated with the event. */
2537
+ entityId?: string;
2538
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2539
+ eventTime?: Date | null;
2478
2540
  /**
2479
- * Category description.
2480
- * @maxLength 500
2541
+ * Whether the event was triggered as a result of a privacy regulation application
2542
+ * (for example, GDPR).
2481
2543
  */
2482
- description?: string | null;
2544
+ triggeredByAnonymizeRequest?: boolean | null;
2545
+ /** If present, indicates the action that triggered the event. */
2546
+ originatedFrom?: string | null;
2483
2547
  /**
2484
- * Category title.
2485
- * @maxLength 200
2486
- * @deprecated Category title.
2487
- * @targetRemovalDate 2025-07-16
2548
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2549
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2488
2550
  */
2489
- title?: string;
2551
+ entityEventSequence?: string | null;
2552
+ }
2553
+ /** @oneof */
2554
+ interface DomainEventBodyOneOf {
2555
+ createdEvent?: EntityCreatedEvent;
2556
+ updatedEvent?: EntityUpdatedEvent;
2557
+ deletedEvent?: EntityDeletedEvent;
2558
+ actionEvent?: ActionEvent;
2559
+ }
2560
+ interface EntityCreatedEvent {
2561
+ entity?: string;
2562
+ }
2563
+ interface RestoreInfo {
2564
+ deletedDate?: Date | null;
2565
+ }
2566
+ interface EntityUpdatedEvent {
2490
2567
  /**
2491
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2492
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2493
- *
2494
- * Default: `-1`
2568
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2569
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2570
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2495
2571
  */
2496
- displayPosition?: number | null;
2572
+ currentEntity?: string;
2573
+ }
2574
+ interface EntityDeletedEvent {
2575
+ /** Entity that was deleted. */
2576
+ deletedEntity?: string | null;
2577
+ }
2578
+ interface ActionEvent {
2579
+ body?: string;
2580
+ }
2581
+ interface MessageEnvelope {
2497
2582
  /**
2498
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2583
+ * App instance ID.
2499
2584
  * @format GUID
2500
2585
  */
2501
- translationId?: string | null;
2586
+ instanceId?: string | null;
2502
2587
  /**
2503
- * Category language.
2504
- *
2505
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2506
- * @immutable
2588
+ * Event type.
2589
+ * @maxLength 150
2507
2590
  */
2508
- language?: string | null;
2591
+ eventType?: string;
2592
+ /** The identification type and identity data. */
2593
+ identity?: IdentificationData;
2594
+ /** Stringify payload. */
2595
+ data?: string;
2596
+ /** Details related to the account */
2597
+ accountInfo?: AccountInfo;
2598
+ }
2599
+ interface IdentificationData extends IdentificationDataIdOneOf {
2509
2600
  /**
2510
- * 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`.
2511
- * @maxLength 100
2601
+ * ID of a site visitor that has not logged in to the site.
2602
+ * @format GUID
2512
2603
  */
2513
- slug?: string;
2604
+ anonymousVisitorId?: string;
2605
+ /**
2606
+ * ID of a site visitor that has logged in to the site.
2607
+ * @format GUID
2608
+ */
2609
+ memberId?: string;
2610
+ /**
2611
+ * ID of a Wix user (site owner, contributor, etc.).
2612
+ * @format GUID
2613
+ */
2614
+ wixUserId?: string;
2615
+ /**
2616
+ * ID of an app.
2617
+ * @format GUID
2618
+ */
2619
+ appId?: string;
2620
+ /** @readonly */
2621
+ identityType?: WebhookIdentityTypeWithLiterals;
2622
+ }
2623
+ /** @oneof */
2624
+ interface IdentificationDataIdOneOf {
2625
+ /**
2626
+ * ID of a site visitor that has not logged in to the site.
2627
+ * @format GUID
2628
+ */
2629
+ anonymousVisitorId?: string;
2630
+ /**
2631
+ * ID of a site visitor that has logged in to the site.
2632
+ * @format GUID
2633
+ */
2634
+ memberId?: string;
2635
+ /**
2636
+ * ID of a Wix user (site owner, contributor, etc.).
2637
+ * @format GUID
2638
+ */
2639
+ wixUserId?: string;
2640
+ /**
2641
+ * ID of an app.
2642
+ * @format GUID
2643
+ */
2644
+ appId?: string;
2645
+ }
2646
+ declare enum WebhookIdentityType {
2647
+ UNKNOWN = "UNKNOWN",
2648
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2649
+ MEMBER = "MEMBER",
2650
+ WIX_USER = "WIX_USER",
2651
+ APP = "APP"
2652
+ }
2653
+ /** @enumType */
2654
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2655
+ interface AccountInfo {
2656
+ /**
2657
+ * ID of the Wix account associated with the event.
2658
+ * @format GUID
2659
+ */
2660
+ accountId?: string | null;
2661
+ /**
2662
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2663
+ * @format GUID
2664
+ */
2665
+ parentAccountId?: string | null;
2666
+ /**
2667
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2668
+ * @format GUID
2669
+ */
2670
+ siteId?: string | null;
2671
+ }
2672
+ interface ListTemplatesRequest {
2673
+ /**
2674
+ * Filter post templates by given template category ids
2675
+ * @maxSize 50
2676
+ * @format GUID
2677
+ */
2678
+ categoryIds?: string[];
2679
+ /**
2680
+ * Filter post templates by provided language
2681
+ * @format LANGUAGE_TAG
2682
+ */
2683
+ language?: string | null;
2684
+ /** Returns post template categories when set to TRUE */
2685
+ listTemplateCategories?: boolean;
2686
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2687
+ sort?: GetPostTemplatesSortWithLiterals;
2688
+ /** Pagination options. */
2689
+ paging?: BlogPaging;
2690
+ }
2691
+ declare enum GetPostTemplatesSort {
2692
+ /** Sort by ascending publishing date. */
2693
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2694
+ /** Sort by descending publishing date. */
2695
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2696
+ }
2697
+ /** @enumType */
2698
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2699
+ interface BlogPaging {
2700
+ /**
2701
+ * Number of items to skip in the current sort order.
2702
+ *
2703
+ *
2704
+ * Default: `0`
2705
+ */
2706
+ offset?: number;
2707
+ /**
2708
+ * Number of items to return.
2709
+ *
2710
+ *
2711
+ * Default:`50`
2712
+ * @min 1
2713
+ * @max 100
2714
+ */
2715
+ limit?: number;
2716
+ /**
2717
+ * Pointer to the next or previous page in the list of results.
2718
+ * @maxLength 2000
2719
+ */
2720
+ cursor?: string | null;
2721
+ }
2722
+ interface ListTemplatesResponse {
2723
+ /** Available post templates */
2724
+ postTemplates?: Post[];
2725
+ /** Details on the paged set of posts templates returned. */
2726
+ postTemplatesMetaData?: MetaData;
2727
+ /** Post template categories. This value is returned empty unless asked explicitly */
2728
+ templateCategories?: Category[];
2729
+ }
2730
+ interface MetaData {
2731
+ /** Number of items returned in this response. */
2732
+ count?: number;
2733
+ /** Requested offset. */
2734
+ offset?: number;
2735
+ /** Total number of items that match the query. */
2736
+ total?: number;
2737
+ /**
2738
+ * Pointer to the next or previous page in the list of results.
2739
+ * @maxLength 2000
2740
+ */
2741
+ cursor?: string | null;
2742
+ }
2743
+ interface Category {
2744
+ /**
2745
+ * Category ID.
2746
+ * @immutable
2747
+ * @maxLength 38
2748
+ */
2749
+ _id?: string;
2750
+ /**
2751
+ * Category label. Displayed in the Category Menu.
2752
+ * @maxLength 35
2753
+ */
2754
+ label?: string;
2755
+ /**
2756
+ * Number of posts in the category.
2757
+ * @readonly
2758
+ */
2759
+ postCount?: number;
2760
+ /**
2761
+ * The `url` of the page that lists every post with the specified category.
2762
+ * @readonly
2763
+ */
2764
+ url?: string;
2765
+ /**
2766
+ * Category description.
2767
+ * @maxLength 500
2768
+ */
2769
+ description?: string | null;
2770
+ /**
2771
+ * Category title.
2772
+ * @maxLength 200
2773
+ * @deprecated Category title.
2774
+ * @targetRemovalDate 2025-07-16
2775
+ */
2776
+ title?: string;
2777
+ /**
2778
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2779
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2780
+ *
2781
+ * Default: `-1`
2782
+ */
2783
+ displayPosition?: number | null;
2784
+ /**
2785
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2786
+ * @format GUID
2787
+ */
2788
+ translationId?: string | null;
2789
+ /**
2790
+ * Category language.
2791
+ *
2792
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2793
+ * @immutable
2794
+ */
2795
+ language?: string | null;
2796
+ /**
2797
+ * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
2798
+ * @maxLength 100
2799
+ */
2800
+ slug?: string;
2514
2801
  /** SEO data. */
2515
2802
  seoData?: SeoSchema;
2516
2803
  /** Category cover image. */
@@ -2621,467 +2908,194 @@ interface DraftPost {
2621
2908
  * @maxSize 3
2622
2909
  * @maxLength 38
2623
2910
  */
2624
- relatedPostIds?: string[];
2625
- /**
2626
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2627
- * @maxSize 100
2628
- * @format GUID
2629
- */
2630
- pricingPlanIds?: string[];
2631
- /**
2632
- * ID of the draft post's translations.
2633
- *
2634
- * All translations of a single post share the same `translationId`.
2635
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2636
- * @format GUID
2637
- */
2638
- translationId?: string | null;
2639
- /**
2640
- * Language the draft post is written in.
2641
- *
2642
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2643
- * @format LANGUAGE_TAG
2644
- */
2645
- language?: string | null;
2646
- /**
2647
- * Draft Post rich content.
2648
- *
2649
- * <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">
2650
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2651
- * </widget>
2652
- */
2653
- richContent?: RichContent;
2654
- /**
2655
- * Status of the draft post.
2656
- * @readonly
2657
- */
2658
- status?: StatusWithLiterals;
2659
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2660
- moderationDetails?: ModerationDetails;
2661
- /**
2662
- * Indicates if there are changes made to the draft post that have not yet been published.
2663
- * @readonly
2664
- */
2665
- hasUnpublishedChanges?: boolean;
2666
- /**
2667
- * Date the draft post was last edited.
2668
- * @readonly
2669
- */
2670
- editedDate?: Date | null;
2671
- /**
2672
- * Date the draft post is scheduled to be published.
2673
- * @readonly
2674
- */
2675
- scheduledPublishDate?: Date | null;
2676
- /** Date the post was first published. */
2677
- firstPublishedDate?: Date | null;
2678
- /** SEO data. */
2679
- seoData?: SeoSchema;
2680
- /**
2681
- * Draft post URL preview. What the URL will look like once the post is published.
2682
- * @readonly
2683
- */
2684
- url?: string;
2685
- /**
2686
- * Date the draft post was first created.
2687
- * @readonly
2688
- */
2689
- _createdDate?: Date | null;
2690
- /**
2691
- * SEO slug.
2692
- * @maxLength 100
2693
- */
2694
- seoSlug?: string | null;
2695
- /** Post cover media. */
2696
- media?: Media;
2697
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
2698
- previewTextParagraph?: number | null;
2699
- }
2700
- declare enum Origin {
2701
- UNKNOWN = "UNKNOWN",
2702
- /** Changed by admin */
2703
- ADMIN = "ADMIN",
2704
- /** Categories were changed */
2705
- ADD_CATEGORIES = "ADD_CATEGORIES",
2706
- /** Saved automatically */
2707
- AUTO_SAVE = "AUTO_SAVE",
2708
- /** Copied from template */
2709
- COPY_TEMPLATE = "COPY_TEMPLATE",
2710
- /** Imported */
2711
- IMPORT = "IMPORT",
2712
- /** Imported in bulk */
2713
- IMPORT_BULK = "IMPORT_BULK",
2714
- /** Imported with html import */
2715
- IMPORT_HTML = "IMPORT_HTML",
2716
- /** Patch import */
2717
- IMPORT_PATCH = "IMPORT_PATCH",
2718
- /** Changed language */
2719
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
2720
- /** Saved manually */
2721
- MANUAL_SAVE = "MANUAL_SAVE",
2722
- /** Affected by migration */
2723
- MIGRATION = "MIGRATION",
2724
- /** Affected by moderation */
2725
- MODERATION = "MODERATION",
2726
- /** Moved to trash */
2727
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
2728
- /** Pricing plans were changed */
2729
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
2730
- /** Was provisioned */
2731
- PROVISION = "PROVISION",
2732
- /** Was published */
2733
- PUBLISH = "PUBLISH",
2734
- /** Owner was reassigned */
2735
- REASSIGN_OWNER = "REASSIGN_OWNER",
2736
- /** Was reblogged */
2737
- REBLOG = "REBLOG",
2738
- /** Was restored */
2739
- RESTORE = "RESTORE",
2740
- /** Reverted to draft */
2741
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
2742
- /** Was translated */
2743
- TRANSLATION = "TRANSLATION",
2744
- /** Was unpublished */
2745
- UNPUBLISH = "UNPUBLISH",
2746
- /** Was unscheduled */
2747
- UNSCHEDULE = "UNSCHEDULE",
2748
- /** New edit session started which updated editing_session_id id */
2749
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
2750
- /** Was scheduled by Later */
2751
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
2752
- /** Was unscheduled by Later */
2753
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
2754
- /** Was published by Later */
2755
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
2756
- /** Was scheduled */
2757
- SCHEDULE = "SCHEDULE",
2758
- /** Was removed from moderation */
2759
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
2760
- /** Was rejected from moderation */
2761
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
2762
- /** Was approved in moderation */
2763
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
2764
- /** Tag was deleted */
2765
- DELETE_TAG = "DELETE_TAG",
2766
- /** Post was pinned */
2767
- PIN = "PIN",
2768
- /** Post was unpinned */
2769
- UNPIN = "UNPIN",
2770
- /** Saved automatically by AI tool. */
2771
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
2772
- }
2773
- /** @enumType */
2774
- 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';
2775
- declare enum Status {
2776
- UNKNOWN = "UNKNOWN",
2777
- /** Status indicating the draft post is published. */
2778
- PUBLISHED = "PUBLISHED",
2779
- /** Status indicating the draft post is unpublished. */
2780
- UNPUBLISHED = "UNPUBLISHED",
2781
- /** Status indicating the draft post is scheduled for publication. */
2782
- SCHEDULED = "SCHEDULED",
2783
- /** Status indicating the draft post is deleted. */
2784
- DELETED = "DELETED",
2785
- /** Status indicating the draft post is in review. */
2786
- IN_REVIEW = "IN_REVIEW"
2787
- }
2788
- /** @enumType */
2789
- type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
2790
- interface DraftPostTranslation {
2791
- /**
2792
- * Post ID.
2793
- * @format GUID
2794
- */
2795
- _id?: string;
2796
- /** Post status. */
2797
- status?: StatusWithLiterals;
2798
- /**
2799
- * Language the post is written in.
2800
- * @format LANGUAGE_TAG
2801
- */
2802
- language?: string | null;
2803
- /**
2804
- * Post slug. For example, 'post-slug'.
2805
- * @maxLength 100
2806
- */
2807
- slug?: string | null;
2808
- /** SEO data. */
2809
- seoData?: SeoSchema;
2810
- /** Post URL. */
2811
- url?: string;
2812
- }
2813
- interface DomainEvent extends DomainEventBodyOneOf {
2814
- createdEvent?: EntityCreatedEvent;
2815
- updatedEvent?: EntityUpdatedEvent;
2816
- deletedEvent?: EntityDeletedEvent;
2817
- actionEvent?: ActionEvent;
2818
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2819
- _id?: string;
2820
- /**
2821
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2822
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2823
- */
2824
- entityFqdn?: string;
2825
- /**
2826
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2827
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2828
- */
2829
- slug?: string;
2830
- /** ID of the entity associated with the event. */
2831
- entityId?: string;
2832
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2833
- eventTime?: Date | null;
2834
- /**
2835
- * Whether the event was triggered as a result of a privacy regulation application
2836
- * (for example, GDPR).
2837
- */
2838
- triggeredByAnonymizeRequest?: boolean | null;
2839
- /** If present, indicates the action that triggered the event. */
2840
- originatedFrom?: string | null;
2841
- /**
2842
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2843
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2844
- */
2845
- entityEventSequence?: string | null;
2846
- }
2847
- /** @oneof */
2848
- interface DomainEventBodyOneOf {
2849
- createdEvent?: EntityCreatedEvent;
2850
- updatedEvent?: EntityUpdatedEvent;
2851
- deletedEvent?: EntityDeletedEvent;
2852
- actionEvent?: ActionEvent;
2853
- }
2854
- interface EntityCreatedEvent {
2855
- entity?: string;
2856
- }
2857
- interface RestoreInfo {
2858
- deletedDate?: Date | null;
2859
- }
2860
- interface EntityUpdatedEvent {
2861
- /**
2862
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2863
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2864
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2865
- */
2866
- currentEntity?: string;
2867
- }
2868
- interface EntityDeletedEvent {
2869
- /** Entity that was deleted. */
2870
- deletedEntity?: string | null;
2871
- }
2872
- interface ActionEvent {
2873
- body?: string;
2874
- }
2875
- interface MessageEnvelope {
2876
- /**
2877
- * App instance ID.
2878
- * @format GUID
2879
- */
2880
- instanceId?: string | null;
2881
- /**
2882
- * Event type.
2883
- * @maxLength 150
2884
- */
2885
- eventType?: string;
2886
- /** The identification type and identity data. */
2887
- identity?: IdentificationData;
2888
- /** Stringify payload. */
2889
- data?: string;
2890
- /** Details related to the account */
2891
- accountInfo?: AccountInfo;
2892
- }
2893
- interface IdentificationData extends IdentificationDataIdOneOf {
2894
- /**
2895
- * ID of a site visitor that has not logged in to the site.
2896
- * @format GUID
2897
- */
2898
- anonymousVisitorId?: string;
2899
- /**
2900
- * ID of a site visitor that has logged in to the site.
2901
- * @format GUID
2902
- */
2903
- memberId?: string;
2904
- /**
2905
- * ID of a Wix user (site owner, contributor, etc.).
2906
- * @format GUID
2907
- */
2908
- wixUserId?: string;
2909
- /**
2910
- * ID of an app.
2911
- * @format GUID
2912
- */
2913
- appId?: string;
2914
- /** @readonly */
2915
- identityType?: WebhookIdentityTypeWithLiterals;
2916
- }
2917
- /** @oneof */
2918
- interface IdentificationDataIdOneOf {
2919
- /**
2920
- * ID of a site visitor that has not logged in to the site.
2921
- * @format GUID
2922
- */
2923
- anonymousVisitorId?: string;
2924
- /**
2925
- * ID of a site visitor that has logged in to the site.
2926
- * @format GUID
2927
- */
2928
- memberId?: string;
2929
- /**
2930
- * ID of a Wix user (site owner, contributor, etc.).
2931
- * @format GUID
2932
- */
2933
- wixUserId?: string;
2934
- /**
2935
- * ID of an app.
2936
- * @format GUID
2937
- */
2938
- appId?: string;
2939
- }
2940
- declare enum WebhookIdentityType {
2941
- UNKNOWN = "UNKNOWN",
2942
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2943
- MEMBER = "MEMBER",
2944
- WIX_USER = "WIX_USER",
2945
- APP = "APP"
2946
- }
2947
- /** @enumType */
2948
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2949
- interface AccountInfo {
2950
- /**
2951
- * ID of the Wix account associated with the event.
2952
- * @format GUID
2953
- */
2954
- accountId?: string | null;
2911
+ relatedPostIds?: string[];
2955
2912
  /**
2956
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2913
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2914
+ * @maxSize 100
2957
2915
  * @format GUID
2958
2916
  */
2959
- parentAccountId?: string | null;
2917
+ pricingPlanIds?: string[];
2960
2918
  /**
2961
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2919
+ * ID of the draft post's translations.
2920
+ *
2921
+ * All translations of a single post share the same `translationId`.
2922
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2962
2923
  * @format GUID
2963
2924
  */
2964
- siteId?: string | null;
2965
- }
2966
- /** Get Blog Publications Count Stats request */
2967
- interface QueryPublicationsCountStatsRequest {
2968
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2969
- rangeStart?: Date | null;
2970
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2971
- rangeEnd?: Date | null;
2972
- /** Order of the returned results. */
2973
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2974
- /** Number of months to include in the response. */
2975
- months?: number;
2925
+ translationId?: string | null;
2976
2926
  /**
2977
- * Language filter
2927
+ * Language the draft post is written in.
2978
2928
  *
2979
2929
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2980
2930
  * @format LANGUAGE_TAG
2981
2931
  */
2982
2932
  language?: string | null;
2983
2933
  /**
2984
- * Timezone of the client.
2985
- * @minLength 3
2986
- * @maxLength 100
2934
+ * Draft Post rich content.
2935
+ *
2936
+ * <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">
2937
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2938
+ * </widget>
2987
2939
  */
2988
- timeZone?: string | null;
2989
- }
2990
- declare enum QueryPublicationsCountStatsRequestOrder {
2991
- UNKNOWN = "UNKNOWN",
2992
- OLDEST = "OLDEST",
2993
- NEWEST = "NEWEST"
2994
- }
2995
- /** @enumType */
2996
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2997
- /** Get Blog Publications Count Stats response */
2998
- interface QueryPublicationsCountStatsResponse {
2999
- /** Chronologically ordered list of publications. */
3000
- stats?: PeriodPublicationsCount[];
3001
- }
3002
- /** Publications count for a specific time period */
3003
- interface PeriodPublicationsCount {
3004
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3005
- periodStart?: Date | null;
3006
- /** Number of posts published during this month. */
3007
- publicationsCount?: number;
3008
- }
3009
- /** Get Blog Post Count Stats request */
3010
- interface QueryPostCountStatsRequest {
3011
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3012
- rangeStart?: Date | null;
2940
+ richContent?: RichContent;
3013
2941
  /**
3014
- * Order of returned results.
3015
- *
3016
- * - `OLDEST`: posts by date in ascending order.
3017
- * - `NEWEST`: posts by date in descending order.
3018
- *
3019
- * Default: `OLDEST`
2942
+ * Status of the draft post.
2943
+ * @readonly
3020
2944
  */
3021
- order?: OrderWithLiterals;
3022
- /** Number of months to include in response. */
3023
- months?: number;
2945
+ status?: StatusWithLiterals;
2946
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2947
+ moderationDetails?: ModerationDetails;
3024
2948
  /**
3025
- * Language filter.
3026
- *
3027
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3028
- * Pass a language to only receive the period post count for that specified language.
3029
- * @format LANGUAGE_TAG
2949
+ * Indicates if there are changes made to the draft post that have not yet been published.
2950
+ * @readonly
3030
2951
  */
3031
- language?: string | null;
2952
+ hasUnpublishedChanges?: boolean;
3032
2953
  /**
3033
- * Time zone to use when calculating the start of the month.
3034
- *
3035
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3036
- * @minLength 3
2954
+ * Date the draft post was last edited.
2955
+ * @readonly
2956
+ */
2957
+ editedDate?: Date | null;
2958
+ /**
2959
+ * Date the draft post is scheduled to be published.
2960
+ * @readonly
2961
+ */
2962
+ scheduledPublishDate?: Date | null;
2963
+ /** Date the post was first published. */
2964
+ firstPublishedDate?: Date | null;
2965
+ /** SEO data. */
2966
+ seoData?: SeoSchema;
2967
+ /**
2968
+ * Draft post URL preview. What the URL will look like once the post is published.
2969
+ * @readonly
2970
+ */
2971
+ url?: string;
2972
+ /**
2973
+ * Date the draft post was first created.
2974
+ * @readonly
2975
+ */
2976
+ _createdDate?: Date | null;
2977
+ /**
2978
+ * SEO slug.
3037
2979
  * @maxLength 100
3038
2980
  */
3039
- timeZone?: string | null;
2981
+ seoSlug?: string | null;
2982
+ /** Post cover media. */
2983
+ media?: Media;
2984
+ /** Number of paragraphs to display in a paid content preview for non-paying users. */
2985
+ previewTextParagraph?: number | null;
3040
2986
  }
3041
- declare enum Order {
2987
+ declare enum Origin {
3042
2988
  UNKNOWN = "UNKNOWN",
3043
- OLDEST = "OLDEST",
3044
- NEWEST = "NEWEST"
2989
+ /** Changed by admin */
2990
+ ADMIN = "ADMIN",
2991
+ /** Categories were changed */
2992
+ ADD_CATEGORIES = "ADD_CATEGORIES",
2993
+ /** Saved automatically */
2994
+ AUTO_SAVE = "AUTO_SAVE",
2995
+ /** Copied from template */
2996
+ COPY_TEMPLATE = "COPY_TEMPLATE",
2997
+ /** Imported */
2998
+ IMPORT = "IMPORT",
2999
+ /** Imported in bulk */
3000
+ IMPORT_BULK = "IMPORT_BULK",
3001
+ /** Imported with html import */
3002
+ IMPORT_HTML = "IMPORT_HTML",
3003
+ /** Patch import */
3004
+ IMPORT_PATCH = "IMPORT_PATCH",
3005
+ /** Changed language */
3006
+ LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
3007
+ /** Saved manually */
3008
+ MANUAL_SAVE = "MANUAL_SAVE",
3009
+ /** Affected by migration */
3010
+ MIGRATION = "MIGRATION",
3011
+ /** Affected by moderation */
3012
+ MODERATION = "MODERATION",
3013
+ /** Moved to trash */
3014
+ MOVE_TO_TRASH = "MOVE_TO_TRASH",
3015
+ /** Pricing plans were changed */
3016
+ PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
3017
+ /** Was provisioned */
3018
+ PROVISION = "PROVISION",
3019
+ /** Was published */
3020
+ PUBLISH = "PUBLISH",
3021
+ /** Owner was reassigned */
3022
+ REASSIGN_OWNER = "REASSIGN_OWNER",
3023
+ /** Was reblogged */
3024
+ REBLOG = "REBLOG",
3025
+ /** Was restored */
3026
+ RESTORE = "RESTORE",
3027
+ /** Reverted to draft */
3028
+ REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
3029
+ /** Was translated */
3030
+ TRANSLATION = "TRANSLATION",
3031
+ /** Was unpublished */
3032
+ UNPUBLISH = "UNPUBLISH",
3033
+ /** Was unscheduled */
3034
+ UNSCHEDULE = "UNSCHEDULE",
3035
+ /** New edit session started which updated editing_session_id id */
3036
+ NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
3037
+ /** Was scheduled by Later */
3038
+ SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
3039
+ /** Was unscheduled by Later */
3040
+ SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
3041
+ /** Was published by Later */
3042
+ SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
3043
+ /** Was scheduled */
3044
+ SCHEDULE = "SCHEDULE",
3045
+ /** Was removed from moderation */
3046
+ REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
3047
+ /** Was rejected from moderation */
3048
+ REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
3049
+ /** Was approved in moderation */
3050
+ APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
3051
+ /** Tag was deleted */
3052
+ DELETE_TAG = "DELETE_TAG",
3053
+ /** Post was pinned */
3054
+ PIN = "PIN",
3055
+ /** Post was unpinned */
3056
+ UNPIN = "UNPIN",
3057
+ /** Saved automatically by AI tool. */
3058
+ AI_AUTO_SAVE = "AI_AUTO_SAVE"
3045
3059
  }
3046
3060
  /** @enumType */
3047
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3048
- /** Get Blog Post Count Stats response */
3049
- interface QueryPostCountStatsResponse {
3050
- /** List of published post counts by month. */
3051
- stats?: PeriodPostCount[];
3052
- }
3053
- /** Post count for a specific time period */
3054
- interface PeriodPostCount {
3055
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3056
- periodStart?: Date | null;
3057
- /** Number of posts published during this month. */
3058
- postCount?: number;
3061
+ 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';
3062
+ declare enum Status {
3063
+ UNKNOWN = "UNKNOWN",
3064
+ /** Status indicating the draft post is published. */
3065
+ PUBLISHED = "PUBLISHED",
3066
+ /** Status indicating the draft post is unpublished. */
3067
+ UNPUBLISHED = "UNPUBLISHED",
3068
+ /** Status indicating the draft post is scheduled for publication. */
3069
+ SCHEDULED = "SCHEDULED",
3070
+ /** Status indicating the draft post is deleted. */
3071
+ DELETED = "DELETED",
3072
+ /** Status indicating the draft post is in review. */
3073
+ IN_REVIEW = "IN_REVIEW"
3059
3074
  }
3060
- interface GetTotalPublicationsRequest {
3075
+ /** @enumType */
3076
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
3077
+ interface DraftPostTranslation {
3061
3078
  /**
3062
- * Language filter
3063
- * @minLength 2
3064
- * @format LANGUAGE_TAG
3079
+ * Post ID.
3080
+ * @format GUID
3065
3081
  */
3066
- language?: string | null;
3067
- }
3068
- interface GetTotalPublicationsResponse {
3069
- /** Total amount of publications. */
3070
- total?: number;
3071
- }
3072
- interface GetTotalPostsRequest {
3082
+ _id?: string;
3083
+ /** Post status. */
3084
+ status?: StatusWithLiterals;
3073
3085
  /**
3074
- * Language filter.
3075
- *
3076
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3077
- * Pass a language to receive the total amount of posts in that specified language.
3086
+ * Language the post is written in.
3078
3087
  * @format LANGUAGE_TAG
3079
3088
  */
3080
3089
  language?: string | null;
3081
- }
3082
- interface GetTotalPostsResponse {
3083
- /** Total amount of published posts. */
3084
- total?: number;
3090
+ /**
3091
+ * Post slug. For example, 'post-slug'.
3092
+ * @maxLength 100
3093
+ */
3094
+ slug?: string | null;
3095
+ /** SEO data. */
3096
+ seoData?: SeoSchema;
3097
+ /** Post URL. */
3098
+ url?: string;
3085
3099
  }
3086
3100
  interface GetTotalLikesPerMemberRequest {
3087
3101
  /**
@@ -4342,9 +4356,12 @@ type PostQuery = {
4342
4356
  }[];
4343
4357
  };
4344
4358
  declare const utils: {
4345
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4346
- Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4347
- Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
4359
+ query: {
4360
+ /** @enumType */
4361
+ QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4362
+ Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4363
+ Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
4364
+ };
4348
4365
  };
4349
4366
  /**
4350
4367
  * Retrieves a post's metrics.
@@ -4359,4 +4376,4 @@ declare const utils: {
4359
4376
  */
4360
4377
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4361
4378
 
4362
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
4379
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };