@wix/auto_sdk_blog_posts 1.0.131 → 1.0.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.js +21 -23
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +493 -495
- package/build/cjs/index.typings.js +21 -23
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +358 -358
- package/build/cjs/meta.js +20 -20
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs +21 -23
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +493 -495
- package/build/es/index.typings.mjs +21 -23
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +358 -358
- package/build/es/meta.mjs +20 -20
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.js +21 -23
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +493 -495
- package/build/internal/cjs/index.typings.js +21 -23
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +358 -358
- package/build/internal/cjs/meta.js +20 -20
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.mjs +21 -23
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +493 -495
- package/build/internal/es/index.typings.mjs +21 -23
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +358 -358
- package/build/internal/es/meta.mjs +20 -20
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/meta.d.ts
CHANGED
|
@@ -2433,405 +2433,130 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2433
2433
|
*/
|
|
2434
2434
|
anonymousVisitorId?: string | null;
|
|
2435
2435
|
}
|
|
2436
|
-
|
|
2437
|
-
interface QueryPublicationsCountStatsRequest {
|
|
2438
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2439
|
-
rangeStart?: Date | null;
|
|
2440
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2441
|
-
rangeEnd?: Date | null;
|
|
2442
|
-
/** Order of the returned results. */
|
|
2443
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2444
|
-
/** Number of months to include in the response. */
|
|
2445
|
-
months?: number;
|
|
2436
|
+
interface ListTemplatesRequest {
|
|
2446
2437
|
/**
|
|
2447
|
-
*
|
|
2448
|
-
*
|
|
2449
|
-
*
|
|
2450
|
-
* @format LANGUAGE_TAG
|
|
2438
|
+
* Filter post templates by given template category ids
|
|
2439
|
+
* @maxSize 50
|
|
2440
|
+
* @format GUID
|
|
2451
2441
|
*/
|
|
2452
|
-
|
|
2442
|
+
categoryIds?: string[];
|
|
2453
2443
|
/**
|
|
2454
|
-
*
|
|
2455
|
-
* @
|
|
2456
|
-
* @maxLength 100
|
|
2444
|
+
* Filter post templates by provided language
|
|
2445
|
+
* @format LANGUAGE_TAG
|
|
2457
2446
|
*/
|
|
2458
|
-
|
|
2447
|
+
language?: string | null;
|
|
2448
|
+
/** Returns post template categories when set to TRUE */
|
|
2449
|
+
listTemplateCategories?: boolean;
|
|
2450
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2451
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2452
|
+
/** Pagination options. */
|
|
2453
|
+
paging?: BlogPaging;
|
|
2459
2454
|
}
|
|
2460
|
-
declare enum
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2455
|
+
declare enum GetPostTemplatesSort {
|
|
2456
|
+
/** Sort by ascending publishing date. */
|
|
2457
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2458
|
+
/** Sort by descending publishing date. */
|
|
2459
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2464
2460
|
}
|
|
2465
2461
|
/** @enumType */
|
|
2466
|
-
type
|
|
2467
|
-
|
|
2468
|
-
interface QueryPublicationsCountStatsResponse {
|
|
2469
|
-
/** Chronologically ordered list of publications. */
|
|
2470
|
-
stats?: PeriodPublicationsCount[];
|
|
2471
|
-
}
|
|
2472
|
-
/** Publications count for a specific time period */
|
|
2473
|
-
interface PeriodPublicationsCount {
|
|
2474
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2475
|
-
periodStart?: Date | null;
|
|
2476
|
-
/** Number of posts published during this month. */
|
|
2477
|
-
publicationsCount?: number;
|
|
2478
|
-
}
|
|
2479
|
-
/** Get Blog Post Count Stats request */
|
|
2480
|
-
interface QueryPostCountStatsRequest {
|
|
2481
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2482
|
-
rangeStart?: Date | null;
|
|
2462
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2463
|
+
interface BlogPaging {
|
|
2483
2464
|
/**
|
|
2484
|
-
*
|
|
2465
|
+
* Number of items to skip in the current sort order.
|
|
2485
2466
|
*
|
|
2486
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
2487
|
-
* - `NEWEST`: posts by date in descending order.
|
|
2488
2467
|
*
|
|
2489
|
-
* Default: `
|
|
2468
|
+
* Default: `0`
|
|
2490
2469
|
*/
|
|
2491
|
-
|
|
2492
|
-
/** Number of months to include in response. */
|
|
2493
|
-
months?: number;
|
|
2470
|
+
offset?: number;
|
|
2494
2471
|
/**
|
|
2495
|
-
*
|
|
2472
|
+
* Number of items to return.
|
|
2496
2473
|
*
|
|
2497
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2498
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
2499
|
-
* @format LANGUAGE_TAG
|
|
2500
|
-
*/
|
|
2501
|
-
language?: string | null;
|
|
2502
|
-
/**
|
|
2503
|
-
* Time zone to use when calculating the start of the month.
|
|
2504
2474
|
*
|
|
2505
|
-
*
|
|
2506
|
-
* @
|
|
2507
|
-
* @
|
|
2475
|
+
* Default:`50`
|
|
2476
|
+
* @min 1
|
|
2477
|
+
* @max 100
|
|
2508
2478
|
*/
|
|
2509
|
-
|
|
2510
|
-
}
|
|
2511
|
-
declare enum Order {
|
|
2512
|
-
UNKNOWN = "UNKNOWN",
|
|
2513
|
-
OLDEST = "OLDEST",
|
|
2514
|
-
NEWEST = "NEWEST"
|
|
2515
|
-
}
|
|
2516
|
-
/** @enumType */
|
|
2517
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2518
|
-
/** Get Blog Post Count Stats response */
|
|
2519
|
-
interface QueryPostCountStatsResponse {
|
|
2520
|
-
/** List of published post counts by month. */
|
|
2521
|
-
stats?: PeriodPostCount[];
|
|
2522
|
-
}
|
|
2523
|
-
/** Post count for a specific time period */
|
|
2524
|
-
interface PeriodPostCount {
|
|
2525
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2526
|
-
periodStart?: Date | null;
|
|
2527
|
-
/** Number of posts published during this month. */
|
|
2528
|
-
postCount?: number;
|
|
2529
|
-
}
|
|
2530
|
-
interface GetTotalPublicationsRequest {
|
|
2479
|
+
limit?: number;
|
|
2531
2480
|
/**
|
|
2532
|
-
*
|
|
2533
|
-
* @
|
|
2534
|
-
* @format LANGUAGE_TAG
|
|
2481
|
+
* Pointer to the next or previous page in the list of results.
|
|
2482
|
+
* @maxLength 2000
|
|
2535
2483
|
*/
|
|
2536
|
-
|
|
2484
|
+
cursor?: string | null;
|
|
2537
2485
|
}
|
|
2538
|
-
interface
|
|
2539
|
-
/**
|
|
2540
|
-
|
|
2486
|
+
interface ListTemplatesResponse {
|
|
2487
|
+
/** Available post templates */
|
|
2488
|
+
postTemplates?: Post[];
|
|
2489
|
+
/** Details on the paged set of posts templates returned. */
|
|
2490
|
+
postTemplatesMetaData?: MetaData;
|
|
2491
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2492
|
+
templateCategories?: Category[];
|
|
2541
2493
|
}
|
|
2542
|
-
interface
|
|
2494
|
+
interface MetaData {
|
|
2495
|
+
/** Number of items returned in this response. */
|
|
2496
|
+
count?: number;
|
|
2497
|
+
/** Requested offset. */
|
|
2498
|
+
offset?: number;
|
|
2499
|
+
/** Total number of items that match the query. */
|
|
2500
|
+
total?: number;
|
|
2543
2501
|
/**
|
|
2544
|
-
*
|
|
2545
|
-
*
|
|
2546
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2547
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
2548
|
-
* @format LANGUAGE_TAG
|
|
2502
|
+
* Pointer to the next or previous page in the list of results.
|
|
2503
|
+
* @maxLength 2000
|
|
2549
2504
|
*/
|
|
2550
|
-
|
|
2551
|
-
}
|
|
2552
|
-
interface GetTotalPostsResponse {
|
|
2553
|
-
/** Total amount of published posts. */
|
|
2554
|
-
total?: number;
|
|
2505
|
+
cursor?: string | null;
|
|
2555
2506
|
}
|
|
2556
|
-
interface
|
|
2557
|
-
createdEvent?: EntityCreatedEvent;
|
|
2558
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2559
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2560
|
-
actionEvent?: ActionEvent;
|
|
2561
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2562
|
-
id?: string;
|
|
2507
|
+
interface Category {
|
|
2563
2508
|
/**
|
|
2564
|
-
*
|
|
2565
|
-
*
|
|
2509
|
+
* Category ID.
|
|
2510
|
+
* @immutable
|
|
2511
|
+
* @maxLength 38
|
|
2566
2512
|
*/
|
|
2567
|
-
|
|
2513
|
+
id?: string;
|
|
2568
2514
|
/**
|
|
2569
|
-
*
|
|
2570
|
-
*
|
|
2515
|
+
* Category label. Displayed in the Category Menu.
|
|
2516
|
+
* @maxLength 35
|
|
2571
2517
|
*/
|
|
2572
|
-
|
|
2573
|
-
/** ID of the entity associated with the event. */
|
|
2574
|
-
entityId?: string;
|
|
2575
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2576
|
-
eventTime?: Date | null;
|
|
2518
|
+
label?: string;
|
|
2577
2519
|
/**
|
|
2578
|
-
*
|
|
2579
|
-
*
|
|
2520
|
+
* Number of posts in the category.
|
|
2521
|
+
* @readonly
|
|
2580
2522
|
*/
|
|
2581
|
-
|
|
2582
|
-
/** If present, indicates the action that triggered the event. */
|
|
2583
|
-
originatedFrom?: string | null;
|
|
2523
|
+
postCount?: number;
|
|
2584
2524
|
/**
|
|
2585
|
-
*
|
|
2586
|
-
*
|
|
2525
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2526
|
+
* @readonly
|
|
2587
2527
|
*/
|
|
2588
|
-
|
|
2589
|
-
}
|
|
2590
|
-
/** @oneof */
|
|
2591
|
-
interface DomainEventBodyOneOf {
|
|
2592
|
-
createdEvent?: EntityCreatedEvent;
|
|
2593
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2594
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2595
|
-
actionEvent?: ActionEvent;
|
|
2596
|
-
}
|
|
2597
|
-
interface EntityCreatedEvent {
|
|
2598
|
-
entityAsJson?: string;
|
|
2599
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2600
|
-
restoreInfo?: RestoreInfo;
|
|
2601
|
-
}
|
|
2602
|
-
interface RestoreInfo {
|
|
2603
|
-
deletedDate?: Date | null;
|
|
2604
|
-
}
|
|
2605
|
-
interface EntityUpdatedEvent {
|
|
2528
|
+
url?: PageUrl;
|
|
2606
2529
|
/**
|
|
2607
|
-
*
|
|
2608
|
-
*
|
|
2609
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2530
|
+
* Category description.
|
|
2531
|
+
* @maxLength 500
|
|
2610
2532
|
*/
|
|
2611
|
-
|
|
2612
|
-
}
|
|
2613
|
-
interface EntityDeletedEvent {
|
|
2614
|
-
/** Entity that was deleted. */
|
|
2615
|
-
deletedEntityAsJson?: string | null;
|
|
2616
|
-
}
|
|
2617
|
-
interface ActionEvent {
|
|
2618
|
-
bodyAsJson?: string;
|
|
2619
|
-
}
|
|
2620
|
-
interface MessageEnvelope {
|
|
2533
|
+
description?: string | null;
|
|
2621
2534
|
/**
|
|
2622
|
-
*
|
|
2623
|
-
* @
|
|
2535
|
+
* Category title.
|
|
2536
|
+
* @maxLength 200
|
|
2537
|
+
* @deprecated Category title.
|
|
2538
|
+
* @targetRemovalDate 2025-07-16
|
|
2624
2539
|
*/
|
|
2625
|
-
|
|
2540
|
+
title?: string;
|
|
2626
2541
|
/**
|
|
2627
|
-
*
|
|
2628
|
-
*
|
|
2542
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2543
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2544
|
+
*
|
|
2545
|
+
* Default: `-1`
|
|
2629
2546
|
*/
|
|
2630
|
-
|
|
2631
|
-
/** The identification type and identity data. */
|
|
2632
|
-
identity?: IdentificationData;
|
|
2633
|
-
/** Stringify payload. */
|
|
2634
|
-
data?: string;
|
|
2635
|
-
/** Details related to the account */
|
|
2636
|
-
accountInfo?: AccountInfo;
|
|
2637
|
-
}
|
|
2638
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2547
|
+
displayPosition?: number | null;
|
|
2639
2548
|
/**
|
|
2640
|
-
* ID of
|
|
2549
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2641
2550
|
* @format GUID
|
|
2642
2551
|
*/
|
|
2643
|
-
|
|
2552
|
+
translationId?: string | null;
|
|
2644
2553
|
/**
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
2554
|
+
* Category language.
|
|
2555
|
+
*
|
|
2556
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2557
|
+
* @immutable
|
|
2647
2558
|
*/
|
|
2648
|
-
|
|
2649
|
-
/**
|
|
2650
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2651
|
-
* @format GUID
|
|
2652
|
-
*/
|
|
2653
|
-
wixUserId?: string;
|
|
2654
|
-
/**
|
|
2655
|
-
* ID of an app.
|
|
2656
|
-
* @format GUID
|
|
2657
|
-
*/
|
|
2658
|
-
appId?: string;
|
|
2659
|
-
/** @readonly */
|
|
2660
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2661
|
-
}
|
|
2662
|
-
/** @oneof */
|
|
2663
|
-
interface IdentificationDataIdOneOf {
|
|
2664
|
-
/**
|
|
2665
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2666
|
-
* @format GUID
|
|
2667
|
-
*/
|
|
2668
|
-
anonymousVisitorId?: string;
|
|
2669
|
-
/**
|
|
2670
|
-
* ID of a site visitor that has logged in to the site.
|
|
2671
|
-
* @format GUID
|
|
2672
|
-
*/
|
|
2673
|
-
memberId?: string;
|
|
2674
|
-
/**
|
|
2675
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2676
|
-
* @format GUID
|
|
2677
|
-
*/
|
|
2678
|
-
wixUserId?: string;
|
|
2679
|
-
/**
|
|
2680
|
-
* ID of an app.
|
|
2681
|
-
* @format GUID
|
|
2682
|
-
*/
|
|
2683
|
-
appId?: string;
|
|
2684
|
-
}
|
|
2685
|
-
declare enum WebhookIdentityType {
|
|
2686
|
-
UNKNOWN = "UNKNOWN",
|
|
2687
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2688
|
-
MEMBER = "MEMBER",
|
|
2689
|
-
WIX_USER = "WIX_USER",
|
|
2690
|
-
APP = "APP"
|
|
2691
|
-
}
|
|
2692
|
-
/** @enumType */
|
|
2693
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2694
|
-
interface AccountInfo {
|
|
2695
|
-
/**
|
|
2696
|
-
* ID of the Wix account associated with the event.
|
|
2697
|
-
* @format GUID
|
|
2698
|
-
*/
|
|
2699
|
-
accountId?: string | null;
|
|
2700
|
-
/**
|
|
2701
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2702
|
-
* @format GUID
|
|
2703
|
-
*/
|
|
2704
|
-
parentAccountId?: string | null;
|
|
2705
|
-
/**
|
|
2706
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2707
|
-
* @format GUID
|
|
2708
|
-
*/
|
|
2709
|
-
siteId?: string | null;
|
|
2710
|
-
}
|
|
2711
|
-
interface ListTemplatesRequest {
|
|
2712
|
-
/**
|
|
2713
|
-
* Filter post templates by given template category ids
|
|
2714
|
-
* @maxSize 50
|
|
2715
|
-
* @format GUID
|
|
2716
|
-
*/
|
|
2717
|
-
categoryIds?: string[];
|
|
2718
|
-
/**
|
|
2719
|
-
* Filter post templates by provided language
|
|
2720
|
-
* @format LANGUAGE_TAG
|
|
2721
|
-
*/
|
|
2722
|
-
language?: string | null;
|
|
2723
|
-
/** Returns post template categories when set to TRUE */
|
|
2724
|
-
listTemplateCategories?: boolean;
|
|
2725
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2726
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2727
|
-
/** Pagination options. */
|
|
2728
|
-
paging?: BlogPaging;
|
|
2729
|
-
}
|
|
2730
|
-
declare enum GetPostTemplatesSort {
|
|
2731
|
-
/** Sort by ascending publishing date. */
|
|
2732
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2733
|
-
/** Sort by descending publishing date. */
|
|
2734
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2735
|
-
}
|
|
2736
|
-
/** @enumType */
|
|
2737
|
-
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2738
|
-
interface BlogPaging {
|
|
2739
|
-
/**
|
|
2740
|
-
* Number of items to skip in the current sort order.
|
|
2741
|
-
*
|
|
2742
|
-
*
|
|
2743
|
-
* Default: `0`
|
|
2744
|
-
*/
|
|
2745
|
-
offset?: number;
|
|
2746
|
-
/**
|
|
2747
|
-
* Number of items to return.
|
|
2748
|
-
*
|
|
2749
|
-
*
|
|
2750
|
-
* Default:`50`
|
|
2751
|
-
* @min 1
|
|
2752
|
-
* @max 100
|
|
2753
|
-
*/
|
|
2754
|
-
limit?: number;
|
|
2755
|
-
/**
|
|
2756
|
-
* Pointer to the next or previous page in the list of results.
|
|
2757
|
-
* @maxLength 2000
|
|
2758
|
-
*/
|
|
2759
|
-
cursor?: string | null;
|
|
2760
|
-
}
|
|
2761
|
-
interface ListTemplatesResponse {
|
|
2762
|
-
/** Available post templates */
|
|
2763
|
-
postTemplates?: Post[];
|
|
2764
|
-
/** Details on the paged set of posts templates returned. */
|
|
2765
|
-
postTemplatesMetaData?: MetaData;
|
|
2766
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2767
|
-
templateCategories?: Category[];
|
|
2768
|
-
}
|
|
2769
|
-
interface MetaData {
|
|
2770
|
-
/** Number of items returned in this response. */
|
|
2771
|
-
count?: number;
|
|
2772
|
-
/** Requested offset. */
|
|
2773
|
-
offset?: number;
|
|
2774
|
-
/** Total number of items that match the query. */
|
|
2775
|
-
total?: number;
|
|
2776
|
-
/**
|
|
2777
|
-
* Pointer to the next or previous page in the list of results.
|
|
2778
|
-
* @maxLength 2000
|
|
2779
|
-
*/
|
|
2780
|
-
cursor?: string | null;
|
|
2781
|
-
}
|
|
2782
|
-
interface Category {
|
|
2783
|
-
/**
|
|
2784
|
-
* Category ID.
|
|
2785
|
-
* @immutable
|
|
2786
|
-
* @maxLength 38
|
|
2787
|
-
*/
|
|
2788
|
-
id?: string;
|
|
2789
|
-
/**
|
|
2790
|
-
* Category label. Displayed in the Category Menu.
|
|
2791
|
-
* @maxLength 35
|
|
2792
|
-
*/
|
|
2793
|
-
label?: string;
|
|
2794
|
-
/**
|
|
2795
|
-
* Number of posts in the category.
|
|
2796
|
-
* @readonly
|
|
2797
|
-
*/
|
|
2798
|
-
postCount?: number;
|
|
2799
|
-
/**
|
|
2800
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2801
|
-
* @readonly
|
|
2802
|
-
*/
|
|
2803
|
-
url?: PageUrl;
|
|
2804
|
-
/**
|
|
2805
|
-
* Category description.
|
|
2806
|
-
* @maxLength 500
|
|
2807
|
-
*/
|
|
2808
|
-
description?: string | null;
|
|
2809
|
-
/**
|
|
2810
|
-
* Category title.
|
|
2811
|
-
* @maxLength 200
|
|
2812
|
-
* @deprecated Category title.
|
|
2813
|
-
* @targetRemovalDate 2025-07-16
|
|
2814
|
-
*/
|
|
2815
|
-
title?: string;
|
|
2816
|
-
/**
|
|
2817
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2818
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2819
|
-
*
|
|
2820
|
-
* Default: `-1`
|
|
2821
|
-
*/
|
|
2822
|
-
displayPosition?: number | null;
|
|
2823
|
-
/**
|
|
2824
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2825
|
-
* @format GUID
|
|
2826
|
-
*/
|
|
2827
|
-
translationId?: string | null;
|
|
2828
|
-
/**
|
|
2829
|
-
* Category language.
|
|
2830
|
-
*
|
|
2831
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2832
|
-
* @immutable
|
|
2833
|
-
*/
|
|
2834
|
-
language?: string | null;
|
|
2559
|
+
language?: string | null;
|
|
2835
2560
|
/**
|
|
2836
2561
|
* 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`.
|
|
2837
2562
|
* @maxLength 100
|
|
@@ -3136,6 +2861,281 @@ interface DraftPostTranslation {
|
|
|
3136
2861
|
/** Post URL. */
|
|
3137
2862
|
url?: PageUrl;
|
|
3138
2863
|
}
|
|
2864
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2865
|
+
createdEvent?: EntityCreatedEvent;
|
|
2866
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2867
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2868
|
+
actionEvent?: ActionEvent;
|
|
2869
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2870
|
+
id?: string;
|
|
2871
|
+
/**
|
|
2872
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2873
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2874
|
+
*/
|
|
2875
|
+
entityFqdn?: string;
|
|
2876
|
+
/**
|
|
2877
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2878
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2879
|
+
*/
|
|
2880
|
+
slug?: string;
|
|
2881
|
+
/** ID of the entity associated with the event. */
|
|
2882
|
+
entityId?: string;
|
|
2883
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2884
|
+
eventTime?: Date | null;
|
|
2885
|
+
/**
|
|
2886
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2887
|
+
* (for example, GDPR).
|
|
2888
|
+
*/
|
|
2889
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2890
|
+
/** If present, indicates the action that triggered the event. */
|
|
2891
|
+
originatedFrom?: string | null;
|
|
2892
|
+
/**
|
|
2893
|
+
* 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.
|
|
2894
|
+
* 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.
|
|
2895
|
+
*/
|
|
2896
|
+
entityEventSequence?: string | null;
|
|
2897
|
+
}
|
|
2898
|
+
/** @oneof */
|
|
2899
|
+
interface DomainEventBodyOneOf {
|
|
2900
|
+
createdEvent?: EntityCreatedEvent;
|
|
2901
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2902
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2903
|
+
actionEvent?: ActionEvent;
|
|
2904
|
+
}
|
|
2905
|
+
interface EntityCreatedEvent {
|
|
2906
|
+
entityAsJson?: string;
|
|
2907
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2908
|
+
restoreInfo?: RestoreInfo;
|
|
2909
|
+
}
|
|
2910
|
+
interface RestoreInfo {
|
|
2911
|
+
deletedDate?: Date | null;
|
|
2912
|
+
}
|
|
2913
|
+
interface EntityUpdatedEvent {
|
|
2914
|
+
/**
|
|
2915
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2916
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2917
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2918
|
+
*/
|
|
2919
|
+
currentEntityAsJson?: string;
|
|
2920
|
+
}
|
|
2921
|
+
interface EntityDeletedEvent {
|
|
2922
|
+
/** Entity that was deleted. */
|
|
2923
|
+
deletedEntityAsJson?: string | null;
|
|
2924
|
+
}
|
|
2925
|
+
interface ActionEvent {
|
|
2926
|
+
bodyAsJson?: string;
|
|
2927
|
+
}
|
|
2928
|
+
interface MessageEnvelope {
|
|
2929
|
+
/**
|
|
2930
|
+
* App instance ID.
|
|
2931
|
+
* @format GUID
|
|
2932
|
+
*/
|
|
2933
|
+
instanceId?: string | null;
|
|
2934
|
+
/**
|
|
2935
|
+
* Event type.
|
|
2936
|
+
* @maxLength 150
|
|
2937
|
+
*/
|
|
2938
|
+
eventType?: string;
|
|
2939
|
+
/** The identification type and identity data. */
|
|
2940
|
+
identity?: IdentificationData;
|
|
2941
|
+
/** Stringify payload. */
|
|
2942
|
+
data?: string;
|
|
2943
|
+
/** Details related to the account */
|
|
2944
|
+
accountInfo?: AccountInfo;
|
|
2945
|
+
}
|
|
2946
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2947
|
+
/**
|
|
2948
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2949
|
+
* @format GUID
|
|
2950
|
+
*/
|
|
2951
|
+
anonymousVisitorId?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
* ID of a site visitor that has logged in to the site.
|
|
2954
|
+
* @format GUID
|
|
2955
|
+
*/
|
|
2956
|
+
memberId?: string;
|
|
2957
|
+
/**
|
|
2958
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2959
|
+
* @format GUID
|
|
2960
|
+
*/
|
|
2961
|
+
wixUserId?: string;
|
|
2962
|
+
/**
|
|
2963
|
+
* ID of an app.
|
|
2964
|
+
* @format GUID
|
|
2965
|
+
*/
|
|
2966
|
+
appId?: string;
|
|
2967
|
+
/** @readonly */
|
|
2968
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2969
|
+
}
|
|
2970
|
+
/** @oneof */
|
|
2971
|
+
interface IdentificationDataIdOneOf {
|
|
2972
|
+
/**
|
|
2973
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2974
|
+
* @format GUID
|
|
2975
|
+
*/
|
|
2976
|
+
anonymousVisitorId?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
* ID of a site visitor that has logged in to the site.
|
|
2979
|
+
* @format GUID
|
|
2980
|
+
*/
|
|
2981
|
+
memberId?: string;
|
|
2982
|
+
/**
|
|
2983
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2984
|
+
* @format GUID
|
|
2985
|
+
*/
|
|
2986
|
+
wixUserId?: string;
|
|
2987
|
+
/**
|
|
2988
|
+
* ID of an app.
|
|
2989
|
+
* @format GUID
|
|
2990
|
+
*/
|
|
2991
|
+
appId?: string;
|
|
2992
|
+
}
|
|
2993
|
+
declare enum WebhookIdentityType {
|
|
2994
|
+
UNKNOWN = "UNKNOWN",
|
|
2995
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2996
|
+
MEMBER = "MEMBER",
|
|
2997
|
+
WIX_USER = "WIX_USER",
|
|
2998
|
+
APP = "APP"
|
|
2999
|
+
}
|
|
3000
|
+
/** @enumType */
|
|
3001
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3002
|
+
interface AccountInfo {
|
|
3003
|
+
/**
|
|
3004
|
+
* ID of the Wix account associated with the event.
|
|
3005
|
+
* @format GUID
|
|
3006
|
+
*/
|
|
3007
|
+
accountId?: string | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3010
|
+
* @format GUID
|
|
3011
|
+
*/
|
|
3012
|
+
parentAccountId?: string | null;
|
|
3013
|
+
/**
|
|
3014
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3015
|
+
* @format GUID
|
|
3016
|
+
*/
|
|
3017
|
+
siteId?: string | null;
|
|
3018
|
+
}
|
|
3019
|
+
/** Get Blog Publications Count Stats request */
|
|
3020
|
+
interface QueryPublicationsCountStatsRequest {
|
|
3021
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3022
|
+
rangeStart?: Date | null;
|
|
3023
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3024
|
+
rangeEnd?: Date | null;
|
|
3025
|
+
/** Order of the returned results. */
|
|
3026
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3027
|
+
/** Number of months to include in the response. */
|
|
3028
|
+
months?: number;
|
|
3029
|
+
/**
|
|
3030
|
+
* Language filter
|
|
3031
|
+
*
|
|
3032
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3033
|
+
* @format LANGUAGE_TAG
|
|
3034
|
+
*/
|
|
3035
|
+
language?: string | null;
|
|
3036
|
+
/**
|
|
3037
|
+
* Timezone of the client.
|
|
3038
|
+
* @minLength 3
|
|
3039
|
+
* @maxLength 100
|
|
3040
|
+
*/
|
|
3041
|
+
timeZone?: string | null;
|
|
3042
|
+
}
|
|
3043
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3044
|
+
UNKNOWN = "UNKNOWN",
|
|
3045
|
+
OLDEST = "OLDEST",
|
|
3046
|
+
NEWEST = "NEWEST"
|
|
3047
|
+
}
|
|
3048
|
+
/** @enumType */
|
|
3049
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3050
|
+
/** Get Blog Publications Count Stats response */
|
|
3051
|
+
interface QueryPublicationsCountStatsResponse {
|
|
3052
|
+
/** Chronologically ordered list of publications. */
|
|
3053
|
+
stats?: PeriodPublicationsCount[];
|
|
3054
|
+
}
|
|
3055
|
+
/** Publications count for a specific time period */
|
|
3056
|
+
interface PeriodPublicationsCount {
|
|
3057
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3058
|
+
periodStart?: Date | null;
|
|
3059
|
+
/** Number of posts published during this month. */
|
|
3060
|
+
publicationsCount?: number;
|
|
3061
|
+
}
|
|
3062
|
+
/** Get Blog Post Count Stats request */
|
|
3063
|
+
interface QueryPostCountStatsRequest {
|
|
3064
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3065
|
+
rangeStart?: Date | null;
|
|
3066
|
+
/**
|
|
3067
|
+
* Order of returned results.
|
|
3068
|
+
*
|
|
3069
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
3070
|
+
* - `NEWEST`: posts by date in descending order.
|
|
3071
|
+
*
|
|
3072
|
+
* Default: `OLDEST`
|
|
3073
|
+
*/
|
|
3074
|
+
order?: OrderWithLiterals;
|
|
3075
|
+
/** Number of months to include in response. */
|
|
3076
|
+
months?: number;
|
|
3077
|
+
/**
|
|
3078
|
+
* Language filter.
|
|
3079
|
+
*
|
|
3080
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3081
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
3082
|
+
* @format LANGUAGE_TAG
|
|
3083
|
+
*/
|
|
3084
|
+
language?: string | null;
|
|
3085
|
+
/**
|
|
3086
|
+
* Time zone to use when calculating the start of the month.
|
|
3087
|
+
*
|
|
3088
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3089
|
+
* @minLength 3
|
|
3090
|
+
* @maxLength 100
|
|
3091
|
+
*/
|
|
3092
|
+
timeZone?: string | null;
|
|
3093
|
+
}
|
|
3094
|
+
declare enum Order {
|
|
3095
|
+
UNKNOWN = "UNKNOWN",
|
|
3096
|
+
OLDEST = "OLDEST",
|
|
3097
|
+
NEWEST = "NEWEST"
|
|
3098
|
+
}
|
|
3099
|
+
/** @enumType */
|
|
3100
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3101
|
+
/** Get Blog Post Count Stats response */
|
|
3102
|
+
interface QueryPostCountStatsResponse {
|
|
3103
|
+
/** List of published post counts by month. */
|
|
3104
|
+
stats?: PeriodPostCount[];
|
|
3105
|
+
}
|
|
3106
|
+
/** Post count for a specific time period */
|
|
3107
|
+
interface PeriodPostCount {
|
|
3108
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3109
|
+
periodStart?: Date | null;
|
|
3110
|
+
/** Number of posts published during this month. */
|
|
3111
|
+
postCount?: number;
|
|
3112
|
+
}
|
|
3113
|
+
interface GetTotalPublicationsRequest {
|
|
3114
|
+
/**
|
|
3115
|
+
* Language filter
|
|
3116
|
+
* @minLength 2
|
|
3117
|
+
* @format LANGUAGE_TAG
|
|
3118
|
+
*/
|
|
3119
|
+
language?: string | null;
|
|
3120
|
+
}
|
|
3121
|
+
interface GetTotalPublicationsResponse {
|
|
3122
|
+
/** Total amount of publications. */
|
|
3123
|
+
total?: number;
|
|
3124
|
+
}
|
|
3125
|
+
interface GetTotalPostsRequest {
|
|
3126
|
+
/**
|
|
3127
|
+
* Language filter.
|
|
3128
|
+
*
|
|
3129
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3130
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
3131
|
+
* @format LANGUAGE_TAG
|
|
3132
|
+
*/
|
|
3133
|
+
language?: string | null;
|
|
3134
|
+
}
|
|
3135
|
+
interface GetTotalPostsResponse {
|
|
3136
|
+
/** Total amount of published posts. */
|
|
3137
|
+
total?: number;
|
|
3138
|
+
}
|
|
3139
3139
|
interface GetTotalLikesPerMemberRequest {
|
|
3140
3140
|
/**
|
|
3141
3141
|
* Member ID.
|