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