@wix/auto_sdk_blog_posts 1.0.132 → 1.0.134

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.
@@ -2396,403 +2396,130 @@ interface PostUnlikedInitiatorOneOf {
2396
2396
  */
2397
2397
  anonymousVisitorId?: string | null;
2398
2398
  }
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;
2399
+ interface ListTemplatesRequest {
2409
2400
  /**
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.
2413
- * @format LANGUAGE_TAG
2401
+ * Filter post templates by given template category ids
2402
+ * @maxSize 50
2403
+ * @format GUID
2414
2404
  */
2415
- language?: string | null;
2405
+ categoryIds?: string[];
2416
2406
  /**
2417
- * Timezone of the client.
2418
- * @minLength 3
2419
- * @maxLength 100
2407
+ * Filter post templates by provided language
2408
+ * @format LANGUAGE_TAG
2420
2409
  */
2421
- timeZone?: string | null;
2410
+ language?: string | null;
2411
+ /** Returns post template categories when set to TRUE */
2412
+ listTemplateCategories?: boolean;
2413
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2414
+ sort?: GetPostTemplatesSortWithLiterals;
2415
+ /** Pagination options. */
2416
+ paging?: BlogPaging;
2422
2417
  }
2423
- declare enum QueryPublicationsCountStatsRequestOrder {
2424
- UNKNOWN = "UNKNOWN",
2425
- OLDEST = "OLDEST",
2426
- NEWEST = "NEWEST"
2418
+ declare enum GetPostTemplatesSort {
2419
+ /** Sort by ascending publishing date. */
2420
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2421
+ /** Sort by descending publishing date. */
2422
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2427
2423
  }
2428
2424
  /** @enumType */
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;
2425
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2426
+ interface BlogPaging {
2446
2427
  /**
2447
- * Order of returned results.
2428
+ * Number of items to skip in the current sort order.
2448
2429
  *
2449
- * - `OLDEST`: posts by date in ascending order.
2450
- * - `NEWEST`: posts by date in descending order.
2451
2430
  *
2452
- * Default: `OLDEST`
2431
+ * Default: `0`
2453
2432
  */
2454
- order?: OrderWithLiterals;
2455
- /** Number of months to include in response. */
2456
- months?: number;
2433
+ offset?: number;
2457
2434
  /**
2458
- * Language filter.
2435
+ * Number of items to return.
2459
2436
  *
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
2463
- */
2464
- language?: string | null;
2465
- /**
2466
- * Time zone to use when calculating the start of the month.
2467
2437
  *
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
2438
+ * Default:`50`
2439
+ * @min 1
2440
+ * @max 100
2471
2441
  */
2472
- timeZone?: string | null;
2473
- }
2474
- declare enum Order {
2475
- UNKNOWN = "UNKNOWN",
2476
- OLDEST = "OLDEST",
2477
- NEWEST = "NEWEST"
2478
- }
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 {
2442
+ limit?: number;
2494
2443
  /**
2495
- * Language filter
2496
- * @minLength 2
2497
- * @format LANGUAGE_TAG
2444
+ * Pointer to the next or previous page in the list of results.
2445
+ * @maxLength 2000
2498
2446
  */
2499
- language?: string | null;
2447
+ cursor?: string | null;
2500
2448
  }
2501
- interface GetTotalPublicationsResponse {
2502
- /** Total amount of publications. */
2503
- total?: number;
2449
+ interface ListTemplatesResponse {
2450
+ /** Available post templates */
2451
+ postTemplates?: Post[];
2452
+ /** Details on the paged set of posts templates returned. */
2453
+ postTemplatesMetaData?: MetaData;
2454
+ /** Post template categories. This value is returned empty unless asked explicitly */
2455
+ templateCategories?: Category[];
2504
2456
  }
2505
- interface GetTotalPostsRequest {
2457
+ interface MetaData {
2458
+ /** Number of items returned in this response. */
2459
+ count?: number;
2460
+ /** Requested offset. */
2461
+ offset?: number;
2462
+ /** Total number of items that match the query. */
2463
+ total?: number;
2506
2464
  /**
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
2465
+ * Pointer to the next or previous page in the list of results.
2466
+ * @maxLength 2000
2512
2467
  */
2513
- language?: string | null;
2514
- }
2515
- interface GetTotalPostsResponse {
2516
- /** Total amount of published posts. */
2517
- total?: number;
2468
+ cursor?: string | null;
2518
2469
  }
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. */
2525
- _id?: string;
2470
+ interface Category {
2526
2471
  /**
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`.
2472
+ * Category ID.
2473
+ * @immutable
2474
+ * @maxLength 38
2529
2475
  */
2530
- entityFqdn?: string;
2476
+ _id?: string;
2531
2477
  /**
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`.
2478
+ * Category label. Displayed in the Category Menu.
2479
+ * @maxLength 35
2534
2480
  */
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;
2481
+ label?: string;
2540
2482
  /**
2541
- * Whether the event was triggered as a result of a privacy regulation application
2542
- * (for example, GDPR).
2483
+ * Number of posts in the category.
2484
+ * @readonly
2543
2485
  */
2544
- triggeredByAnonymizeRequest?: boolean | null;
2545
- /** If present, indicates the action that triggered the event. */
2546
- originatedFrom?: string | null;
2486
+ postCount?: number;
2547
2487
  /**
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
+ * The `url` of the page that lists every post with the specified category.
2489
+ * @readonly
2550
2490
  */
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 {
2491
+ url?: string;
2567
2492
  /**
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.
2493
+ * Category description.
2494
+ * @maxLength 500
2571
2495
  */
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 {
2496
+ description?: string | null;
2582
2497
  /**
2583
- * App instance ID.
2584
- * @format GUID
2498
+ * Category title.
2499
+ * @maxLength 200
2500
+ * @deprecated Category title.
2501
+ * @targetRemovalDate 2025-07-16
2585
2502
  */
2586
- instanceId?: string | null;
2503
+ title?: string;
2587
2504
  /**
2588
- * Event type.
2589
- * @maxLength 150
2505
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2506
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2507
+ *
2508
+ * Default: `-1`
2590
2509
  */
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 {
2510
+ displayPosition?: number | null;
2600
2511
  /**
2601
- * ID of a site visitor that has not logged in to the site.
2512
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2602
2513
  * @format GUID
2603
2514
  */
2604
- anonymousVisitorId?: string;
2515
+ translationId?: string | null;
2605
2516
  /**
2606
- * ID of a site visitor that has logged in to the site.
2607
- * @format GUID
2517
+ * Category language.
2518
+ *
2519
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2520
+ * @immutable
2608
2521
  */
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;
2522
+ language?: string | null;
2796
2523
  /**
2797
2524
  * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
2798
2525
  * @maxLength 100
@@ -3097,6 +2824,279 @@ interface DraftPostTranslation {
3097
2824
  /** Post URL. */
3098
2825
  url?: string;
3099
2826
  }
2827
+ interface DomainEvent extends DomainEventBodyOneOf {
2828
+ createdEvent?: EntityCreatedEvent;
2829
+ updatedEvent?: EntityUpdatedEvent;
2830
+ deletedEvent?: EntityDeletedEvent;
2831
+ actionEvent?: ActionEvent;
2832
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2833
+ _id?: string;
2834
+ /**
2835
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2836
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2837
+ */
2838
+ entityFqdn?: string;
2839
+ /**
2840
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2841
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2842
+ */
2843
+ slug?: string;
2844
+ /** ID of the entity associated with the event. */
2845
+ entityId?: string;
2846
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2847
+ eventTime?: Date | null;
2848
+ /**
2849
+ * Whether the event was triggered as a result of a privacy regulation application
2850
+ * (for example, GDPR).
2851
+ */
2852
+ triggeredByAnonymizeRequest?: boolean | null;
2853
+ /** If present, indicates the action that triggered the event. */
2854
+ originatedFrom?: string | null;
2855
+ /**
2856
+ * 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.
2857
+ * 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.
2858
+ */
2859
+ entityEventSequence?: string | null;
2860
+ }
2861
+ /** @oneof */
2862
+ interface DomainEventBodyOneOf {
2863
+ createdEvent?: EntityCreatedEvent;
2864
+ updatedEvent?: EntityUpdatedEvent;
2865
+ deletedEvent?: EntityDeletedEvent;
2866
+ actionEvent?: ActionEvent;
2867
+ }
2868
+ interface EntityCreatedEvent {
2869
+ entity?: string;
2870
+ }
2871
+ interface RestoreInfo {
2872
+ deletedDate?: Date | null;
2873
+ }
2874
+ interface EntityUpdatedEvent {
2875
+ /**
2876
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2877
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2878
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2879
+ */
2880
+ currentEntity?: string;
2881
+ }
2882
+ interface EntityDeletedEvent {
2883
+ /** Entity that was deleted. */
2884
+ deletedEntity?: string | null;
2885
+ }
2886
+ interface ActionEvent {
2887
+ body?: string;
2888
+ }
2889
+ interface MessageEnvelope {
2890
+ /**
2891
+ * App instance ID.
2892
+ * @format GUID
2893
+ */
2894
+ instanceId?: string | null;
2895
+ /**
2896
+ * Event type.
2897
+ * @maxLength 150
2898
+ */
2899
+ eventType?: string;
2900
+ /** The identification type and identity data. */
2901
+ identity?: IdentificationData;
2902
+ /** Stringify payload. */
2903
+ data?: string;
2904
+ /** Details related to the account */
2905
+ accountInfo?: AccountInfo;
2906
+ }
2907
+ interface IdentificationData extends IdentificationDataIdOneOf {
2908
+ /**
2909
+ * ID of a site visitor that has not logged in to the site.
2910
+ * @format GUID
2911
+ */
2912
+ anonymousVisitorId?: string;
2913
+ /**
2914
+ * ID of a site visitor that has logged in to the site.
2915
+ * @format GUID
2916
+ */
2917
+ memberId?: string;
2918
+ /**
2919
+ * ID of a Wix user (site owner, contributor, etc.).
2920
+ * @format GUID
2921
+ */
2922
+ wixUserId?: string;
2923
+ /**
2924
+ * ID of an app.
2925
+ * @format GUID
2926
+ */
2927
+ appId?: string;
2928
+ /** @readonly */
2929
+ identityType?: WebhookIdentityTypeWithLiterals;
2930
+ }
2931
+ /** @oneof */
2932
+ interface IdentificationDataIdOneOf {
2933
+ /**
2934
+ * ID of a site visitor that has not logged in to the site.
2935
+ * @format GUID
2936
+ */
2937
+ anonymousVisitorId?: string;
2938
+ /**
2939
+ * ID of a site visitor that has logged in to the site.
2940
+ * @format GUID
2941
+ */
2942
+ memberId?: string;
2943
+ /**
2944
+ * ID of a Wix user (site owner, contributor, etc.).
2945
+ * @format GUID
2946
+ */
2947
+ wixUserId?: string;
2948
+ /**
2949
+ * ID of an app.
2950
+ * @format GUID
2951
+ */
2952
+ appId?: string;
2953
+ }
2954
+ declare enum WebhookIdentityType {
2955
+ UNKNOWN = "UNKNOWN",
2956
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2957
+ MEMBER = "MEMBER",
2958
+ WIX_USER = "WIX_USER",
2959
+ APP = "APP"
2960
+ }
2961
+ /** @enumType */
2962
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2963
+ interface AccountInfo {
2964
+ /**
2965
+ * ID of the Wix account associated with the event.
2966
+ * @format GUID
2967
+ */
2968
+ accountId?: string | null;
2969
+ /**
2970
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2971
+ * @format GUID
2972
+ */
2973
+ parentAccountId?: string | null;
2974
+ /**
2975
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2976
+ * @format GUID
2977
+ */
2978
+ siteId?: string | null;
2979
+ }
2980
+ /** Get Blog Publications Count Stats request */
2981
+ interface QueryPublicationsCountStatsRequest {
2982
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2983
+ rangeStart?: Date | null;
2984
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2985
+ rangeEnd?: Date | null;
2986
+ /** Order of the returned results. */
2987
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2988
+ /** Number of months to include in the response. */
2989
+ months?: number;
2990
+ /**
2991
+ * Language filter
2992
+ *
2993
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2994
+ * @format LANGUAGE_TAG
2995
+ */
2996
+ language?: string | null;
2997
+ /**
2998
+ * Timezone of the client.
2999
+ * @minLength 3
3000
+ * @maxLength 100
3001
+ */
3002
+ timeZone?: string | null;
3003
+ }
3004
+ declare enum QueryPublicationsCountStatsRequestOrder {
3005
+ UNKNOWN = "UNKNOWN",
3006
+ OLDEST = "OLDEST",
3007
+ NEWEST = "NEWEST"
3008
+ }
3009
+ /** @enumType */
3010
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3011
+ /** Get Blog Publications Count Stats response */
3012
+ interface QueryPublicationsCountStatsResponse {
3013
+ /** Chronologically ordered list of publications. */
3014
+ stats?: PeriodPublicationsCount[];
3015
+ }
3016
+ /** Publications count for a specific time period */
3017
+ interface PeriodPublicationsCount {
3018
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3019
+ periodStart?: Date | null;
3020
+ /** Number of posts published during this month. */
3021
+ publicationsCount?: number;
3022
+ }
3023
+ /** Get Blog Post Count Stats request */
3024
+ interface QueryPostCountStatsRequest {
3025
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3026
+ rangeStart?: Date | null;
3027
+ /**
3028
+ * Order of returned results.
3029
+ *
3030
+ * - `OLDEST`: posts by date in ascending order.
3031
+ * - `NEWEST`: posts by date in descending order.
3032
+ *
3033
+ * Default: `OLDEST`
3034
+ */
3035
+ order?: OrderWithLiterals;
3036
+ /** Number of months to include in response. */
3037
+ months?: number;
3038
+ /**
3039
+ * Language filter.
3040
+ *
3041
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3042
+ * Pass a language to only receive the period post count for that specified language.
3043
+ * @format LANGUAGE_TAG
3044
+ */
3045
+ language?: string | null;
3046
+ /**
3047
+ * Time zone to use when calculating the start of the month.
3048
+ *
3049
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3050
+ * @minLength 3
3051
+ * @maxLength 100
3052
+ */
3053
+ timeZone?: string | null;
3054
+ }
3055
+ declare enum Order {
3056
+ UNKNOWN = "UNKNOWN",
3057
+ OLDEST = "OLDEST",
3058
+ NEWEST = "NEWEST"
3059
+ }
3060
+ /** @enumType */
3061
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3062
+ /** Get Blog Post Count Stats response */
3063
+ interface QueryPostCountStatsResponse {
3064
+ /** List of published post counts by month. */
3065
+ stats?: PeriodPostCount[];
3066
+ }
3067
+ /** Post count for a specific time period */
3068
+ interface PeriodPostCount {
3069
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3070
+ periodStart?: Date | null;
3071
+ /** Number of posts published during this month. */
3072
+ postCount?: number;
3073
+ }
3074
+ interface GetTotalPublicationsRequest {
3075
+ /**
3076
+ * Language filter
3077
+ * @minLength 2
3078
+ * @format LANGUAGE_TAG
3079
+ */
3080
+ language?: string | null;
3081
+ }
3082
+ interface GetTotalPublicationsResponse {
3083
+ /** Total amount of publications. */
3084
+ total?: number;
3085
+ }
3086
+ interface GetTotalPostsRequest {
3087
+ /**
3088
+ * Language filter.
3089
+ *
3090
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3091
+ * Pass a language to receive the total amount of posts in that specified language.
3092
+ * @format LANGUAGE_TAG
3093
+ */
3094
+ language?: string | null;
3095
+ }
3096
+ interface GetTotalPostsResponse {
3097
+ /** Total amount of published posts. */
3098
+ total?: number;
3099
+ }
3100
3100
  interface GetTotalLikesPerMemberRequest {
3101
3101
  /**
3102
3102
  * Member ID.