@wix/auto_sdk_blog_posts 1.0.102 → 1.0.103
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 +343 -343
- package/build/cjs/index.typings.js +20 -20
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +347 -347
- 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 +343 -343
- package/build/es/index.typings.mjs +20 -20
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +347 -347
- 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 +343 -343
- 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 +347 -347
- 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 +343 -343
- 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 +347 -347
- package/build/internal/es/meta.mjs +20 -20
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -2280,394 +2280,130 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2280
2280
|
*/
|
|
2281
2281
|
anonymousVisitorId?: string | null;
|
|
2282
2282
|
}
|
|
2283
|
-
|
|
2284
|
-
interface QueryPublicationsCountStatsRequest {
|
|
2285
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2286
|
-
rangeStart?: Date | null;
|
|
2287
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2288
|
-
rangeEnd?: Date | null;
|
|
2289
|
-
/** Order of the returned results. */
|
|
2290
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2291
|
-
/** Number of months to include in the response. */
|
|
2292
|
-
months?: number;
|
|
2283
|
+
interface ListTemplatesRequest {
|
|
2293
2284
|
/**
|
|
2294
|
-
*
|
|
2295
|
-
*
|
|
2296
|
-
*
|
|
2297
|
-
* @format LANGUAGE_TAG
|
|
2285
|
+
* Filter post templates by given template category ids
|
|
2286
|
+
* @maxSize 50
|
|
2287
|
+
* @format GUID
|
|
2298
2288
|
*/
|
|
2299
|
-
|
|
2289
|
+
categoryIds?: string[];
|
|
2300
2290
|
/**
|
|
2301
|
-
*
|
|
2302
|
-
* @
|
|
2303
|
-
* @maxLength 100
|
|
2291
|
+
* Filter post templates by provided language
|
|
2292
|
+
* @format LANGUAGE_TAG
|
|
2304
2293
|
*/
|
|
2305
|
-
|
|
2294
|
+
language?: string | null;
|
|
2295
|
+
/** Returns post template categories when set to TRUE */
|
|
2296
|
+
listTemplateCategories?: boolean;
|
|
2297
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2298
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2299
|
+
/** Pagination options. */
|
|
2300
|
+
paging?: BlogPaging;
|
|
2306
2301
|
}
|
|
2307
|
-
declare enum
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
|
|
2302
|
+
declare enum GetPostTemplatesSort {
|
|
2303
|
+
/** Sort by ascending publishing date. */
|
|
2304
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2305
|
+
/** Sort by descending publishing date. */
|
|
2306
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2311
2307
|
}
|
|
2312
2308
|
/** @enumType */
|
|
2313
|
-
type
|
|
2314
|
-
|
|
2315
|
-
interface QueryPublicationsCountStatsResponse {
|
|
2316
|
-
/** Chronologically ordered list of publications. */
|
|
2317
|
-
stats?: PeriodPublicationsCount[];
|
|
2318
|
-
}
|
|
2319
|
-
/** Publications count for a specific time period */
|
|
2320
|
-
interface PeriodPublicationsCount {
|
|
2321
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2322
|
-
periodStart?: Date | null;
|
|
2323
|
-
/** Number of posts published during this month. */
|
|
2324
|
-
publicationsCount?: number;
|
|
2325
|
-
}
|
|
2326
|
-
/** Get Blog Post Count Stats request */
|
|
2327
|
-
interface QueryPostCountStatsRequest {
|
|
2328
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2329
|
-
rangeStart?: Date | null;
|
|
2309
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2310
|
+
interface BlogPaging {
|
|
2330
2311
|
/**
|
|
2331
|
-
*
|
|
2312
|
+
* Number of items to skip in the current sort order.
|
|
2332
2313
|
*
|
|
2333
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
2334
|
-
* - `NEWEST`: posts by date in descending order.
|
|
2335
2314
|
*
|
|
2336
|
-
* Default: `
|
|
2315
|
+
* Default: `0`
|
|
2337
2316
|
*/
|
|
2338
|
-
|
|
2339
|
-
/** Number of months to include in response. */
|
|
2340
|
-
months?: number;
|
|
2317
|
+
offset?: number;
|
|
2341
2318
|
/**
|
|
2342
|
-
*
|
|
2319
|
+
* Number of items to return.
|
|
2343
2320
|
*
|
|
2344
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2345
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
2346
|
-
* @format LANGUAGE_TAG
|
|
2347
|
-
*/
|
|
2348
|
-
language?: string | null;
|
|
2349
|
-
/**
|
|
2350
|
-
* Time zone to use when calculating the start of the month.
|
|
2351
2321
|
*
|
|
2352
|
-
*
|
|
2353
|
-
* @
|
|
2354
|
-
* @
|
|
2322
|
+
* Default:`50`
|
|
2323
|
+
* @min 1
|
|
2324
|
+
* @max 100
|
|
2355
2325
|
*/
|
|
2356
|
-
|
|
2357
|
-
}
|
|
2358
|
-
declare enum Order {
|
|
2359
|
-
UNKNOWN = "UNKNOWN",
|
|
2360
|
-
OLDEST = "OLDEST",
|
|
2361
|
-
NEWEST = "NEWEST"
|
|
2362
|
-
}
|
|
2363
|
-
/** @enumType */
|
|
2364
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2365
|
-
/** Get Blog Post Count Stats response */
|
|
2366
|
-
interface QueryPostCountStatsResponse {
|
|
2367
|
-
/** List of published post counts by month. */
|
|
2368
|
-
stats?: PeriodPostCount[];
|
|
2369
|
-
}
|
|
2370
|
-
/** Post count for a specific time period */
|
|
2371
|
-
interface PeriodPostCount {
|
|
2372
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2373
|
-
periodStart?: Date | null;
|
|
2374
|
-
/** Number of posts published during this month. */
|
|
2375
|
-
postCount?: number;
|
|
2376
|
-
}
|
|
2377
|
-
interface GetTotalPublicationsRequest {
|
|
2326
|
+
limit?: number;
|
|
2378
2327
|
/**
|
|
2379
|
-
*
|
|
2380
|
-
* @
|
|
2381
|
-
* @format LANGUAGE_TAG
|
|
2328
|
+
* Pointer to the next or previous page in the list of results.
|
|
2329
|
+
* @maxLength 2000
|
|
2382
2330
|
*/
|
|
2383
|
-
|
|
2331
|
+
cursor?: string | null;
|
|
2384
2332
|
}
|
|
2385
|
-
interface
|
|
2386
|
-
/**
|
|
2387
|
-
|
|
2333
|
+
interface ListTemplatesResponse {
|
|
2334
|
+
/** Available post templates */
|
|
2335
|
+
postTemplates?: Post[];
|
|
2336
|
+
/** Details on the paged set of posts templates returned. */
|
|
2337
|
+
postTemplatesMetaData?: MetaData;
|
|
2338
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2339
|
+
templateCategories?: Category[];
|
|
2388
2340
|
}
|
|
2389
|
-
interface
|
|
2341
|
+
interface MetaData {
|
|
2342
|
+
/** Number of items returned in this response. */
|
|
2343
|
+
count?: number;
|
|
2344
|
+
/** Requested offset. */
|
|
2345
|
+
offset?: number;
|
|
2346
|
+
/** Total number of items that match the query. */
|
|
2347
|
+
total?: number;
|
|
2390
2348
|
/**
|
|
2391
|
-
*
|
|
2392
|
-
*
|
|
2393
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2394
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
2395
|
-
* @format LANGUAGE_TAG
|
|
2349
|
+
* Pointer to the next or previous page in the list of results.
|
|
2350
|
+
* @maxLength 2000
|
|
2396
2351
|
*/
|
|
2397
|
-
|
|
2398
|
-
}
|
|
2399
|
-
interface GetTotalPostsResponse {
|
|
2400
|
-
/** Total amount of published posts. */
|
|
2401
|
-
total?: number;
|
|
2352
|
+
cursor?: string | null;
|
|
2402
2353
|
}
|
|
2403
|
-
interface
|
|
2404
|
-
createdEvent?: EntityCreatedEvent;
|
|
2405
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2406
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2407
|
-
actionEvent?: ActionEvent;
|
|
2354
|
+
interface Category {
|
|
2408
2355
|
/**
|
|
2409
|
-
*
|
|
2410
|
-
*
|
|
2356
|
+
* Category ID.
|
|
2357
|
+
* @immutable
|
|
2358
|
+
* @maxLength 38
|
|
2411
2359
|
*/
|
|
2412
2360
|
id?: string;
|
|
2413
2361
|
/**
|
|
2414
|
-
*
|
|
2415
|
-
*
|
|
2362
|
+
* Category label. Displayed in the Category Menu.
|
|
2363
|
+
* @maxLength 35
|
|
2416
2364
|
*/
|
|
2417
|
-
|
|
2365
|
+
label?: string;
|
|
2418
2366
|
/**
|
|
2419
|
-
*
|
|
2420
|
-
*
|
|
2421
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2367
|
+
* Number of posts in the category.
|
|
2368
|
+
* @readonly
|
|
2422
2369
|
*/
|
|
2423
|
-
|
|
2424
|
-
/** ID of the entity associated with the event. */
|
|
2425
|
-
entityId?: string;
|
|
2426
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2427
|
-
eventTime?: Date | null;
|
|
2370
|
+
postCount?: number;
|
|
2428
2371
|
/**
|
|
2429
|
-
*
|
|
2430
|
-
*
|
|
2372
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2373
|
+
* @readonly
|
|
2431
2374
|
*/
|
|
2432
|
-
|
|
2433
|
-
/** If present, indicates the action that triggered the event. */
|
|
2434
|
-
originatedFrom?: string | null;
|
|
2375
|
+
url?: PageUrl;
|
|
2435
2376
|
/**
|
|
2436
|
-
*
|
|
2437
|
-
*
|
|
2438
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2439
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2440
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2441
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2377
|
+
* Category description.
|
|
2378
|
+
* @maxLength 500
|
|
2442
2379
|
*/
|
|
2443
|
-
|
|
2444
|
-
}
|
|
2445
|
-
/** @oneof */
|
|
2446
|
-
interface DomainEventBodyOneOf {
|
|
2447
|
-
createdEvent?: EntityCreatedEvent;
|
|
2448
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2449
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2450
|
-
actionEvent?: ActionEvent;
|
|
2451
|
-
}
|
|
2452
|
-
interface EntityCreatedEvent {
|
|
2453
|
-
entityAsJson?: string;
|
|
2454
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2455
|
-
restoreInfo?: RestoreInfo;
|
|
2456
|
-
}
|
|
2457
|
-
interface RestoreInfo {
|
|
2458
|
-
deletedDate?: Date | null;
|
|
2459
|
-
}
|
|
2460
|
-
interface EntityUpdatedEvent {
|
|
2380
|
+
description?: string | null;
|
|
2461
2381
|
/**
|
|
2462
|
-
*
|
|
2463
|
-
*
|
|
2464
|
-
*
|
|
2382
|
+
* Category title.
|
|
2383
|
+
* @maxLength 200
|
|
2384
|
+
* @deprecated Category title.
|
|
2385
|
+
* @targetRemovalDate 2025-07-16
|
|
2465
2386
|
*/
|
|
2466
|
-
|
|
2467
|
-
}
|
|
2468
|
-
interface EntityDeletedEvent {
|
|
2469
|
-
/** Entity that was deleted */
|
|
2470
|
-
deletedEntityAsJson?: string | null;
|
|
2471
|
-
}
|
|
2472
|
-
interface ActionEvent {
|
|
2473
|
-
bodyAsJson?: string;
|
|
2474
|
-
}
|
|
2475
|
-
interface MessageEnvelope {
|
|
2387
|
+
title?: string;
|
|
2476
2388
|
/**
|
|
2477
|
-
*
|
|
2478
|
-
*
|
|
2389
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2390
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2391
|
+
*
|
|
2392
|
+
* Default: `-1`
|
|
2479
2393
|
*/
|
|
2480
|
-
|
|
2394
|
+
displayPosition?: number | null;
|
|
2481
2395
|
/**
|
|
2482
|
-
*
|
|
2483
|
-
* @
|
|
2396
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2397
|
+
* @format GUID
|
|
2484
2398
|
*/
|
|
2485
|
-
|
|
2486
|
-
/** The identification type and identity data. */
|
|
2487
|
-
identity?: IdentificationData;
|
|
2488
|
-
/** Stringify payload. */
|
|
2489
|
-
data?: string;
|
|
2490
|
-
}
|
|
2491
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2399
|
+
translationId?: string | null;
|
|
2492
2400
|
/**
|
|
2493
|
-
*
|
|
2494
|
-
*
|
|
2401
|
+
* Category language.
|
|
2402
|
+
*
|
|
2403
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2404
|
+
* @immutable
|
|
2495
2405
|
*/
|
|
2496
|
-
|
|
2497
|
-
/**
|
|
2498
|
-
* ID of a site visitor that has logged in to the site.
|
|
2499
|
-
* @format GUID
|
|
2500
|
-
*/
|
|
2501
|
-
memberId?: string;
|
|
2502
|
-
/**
|
|
2503
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2504
|
-
* @format GUID
|
|
2505
|
-
*/
|
|
2506
|
-
wixUserId?: string;
|
|
2507
|
-
/**
|
|
2508
|
-
* ID of an app.
|
|
2509
|
-
* @format GUID
|
|
2510
|
-
*/
|
|
2511
|
-
appId?: string;
|
|
2512
|
-
/** @readonly */
|
|
2513
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2514
|
-
}
|
|
2515
|
-
/** @oneof */
|
|
2516
|
-
interface IdentificationDataIdOneOf {
|
|
2517
|
-
/**
|
|
2518
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2519
|
-
* @format GUID
|
|
2520
|
-
*/
|
|
2521
|
-
anonymousVisitorId?: string;
|
|
2522
|
-
/**
|
|
2523
|
-
* ID of a site visitor that has logged in to the site.
|
|
2524
|
-
* @format GUID
|
|
2525
|
-
*/
|
|
2526
|
-
memberId?: string;
|
|
2527
|
-
/**
|
|
2528
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2529
|
-
* @format GUID
|
|
2530
|
-
*/
|
|
2531
|
-
wixUserId?: string;
|
|
2532
|
-
/**
|
|
2533
|
-
* ID of an app.
|
|
2534
|
-
* @format GUID
|
|
2535
|
-
*/
|
|
2536
|
-
appId?: string;
|
|
2537
|
-
}
|
|
2538
|
-
declare enum WebhookIdentityType {
|
|
2539
|
-
UNKNOWN = "UNKNOWN",
|
|
2540
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2541
|
-
MEMBER = "MEMBER",
|
|
2542
|
-
WIX_USER = "WIX_USER",
|
|
2543
|
-
APP = "APP"
|
|
2544
|
-
}
|
|
2545
|
-
/** @enumType */
|
|
2546
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2547
|
-
interface ListTemplatesRequest {
|
|
2548
|
-
/**
|
|
2549
|
-
* Filter post templates by given template category ids
|
|
2550
|
-
* @maxSize 50
|
|
2551
|
-
* @format GUID
|
|
2552
|
-
*/
|
|
2553
|
-
categoryIds?: string[];
|
|
2554
|
-
/**
|
|
2555
|
-
* Filter post templates by provided language
|
|
2556
|
-
* @format LANGUAGE_TAG
|
|
2557
|
-
*/
|
|
2558
|
-
language?: string | null;
|
|
2559
|
-
/** Returns post template categories when set to TRUE */
|
|
2560
|
-
listTemplateCategories?: boolean;
|
|
2561
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2562
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2563
|
-
/** Pagination options. */
|
|
2564
|
-
paging?: BlogPaging;
|
|
2565
|
-
}
|
|
2566
|
-
declare enum GetPostTemplatesSort {
|
|
2567
|
-
/** Sort by ascending publishing date. */
|
|
2568
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2569
|
-
/** Sort by descending publishing date. */
|
|
2570
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2571
|
-
}
|
|
2572
|
-
/** @enumType */
|
|
2573
|
-
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2574
|
-
interface BlogPaging {
|
|
2575
|
-
/**
|
|
2576
|
-
* Number of items to skip in the current sort order.
|
|
2577
|
-
*
|
|
2578
|
-
*
|
|
2579
|
-
* Default: `0`
|
|
2580
|
-
*/
|
|
2581
|
-
offset?: number;
|
|
2582
|
-
/**
|
|
2583
|
-
* Number of items to return.
|
|
2584
|
-
*
|
|
2585
|
-
*
|
|
2586
|
-
* Default:`50`
|
|
2587
|
-
* @min 1
|
|
2588
|
-
* @max 100
|
|
2589
|
-
*/
|
|
2590
|
-
limit?: number;
|
|
2591
|
-
/**
|
|
2592
|
-
* Pointer to the next or previous page in the list of results.
|
|
2593
|
-
* @maxLength 2000
|
|
2594
|
-
*/
|
|
2595
|
-
cursor?: string | null;
|
|
2596
|
-
}
|
|
2597
|
-
interface ListTemplatesResponse {
|
|
2598
|
-
/** Available post templates */
|
|
2599
|
-
postTemplates?: Post[];
|
|
2600
|
-
/** Details on the paged set of posts templates returned. */
|
|
2601
|
-
postTemplatesMetaData?: MetaData;
|
|
2602
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2603
|
-
templateCategories?: Category[];
|
|
2604
|
-
}
|
|
2605
|
-
interface MetaData {
|
|
2606
|
-
/** Number of items returned in this response. */
|
|
2607
|
-
count?: number;
|
|
2608
|
-
/** Requested offset. */
|
|
2609
|
-
offset?: number;
|
|
2610
|
-
/** Total number of items that match the query. */
|
|
2611
|
-
total?: number;
|
|
2612
|
-
/**
|
|
2613
|
-
* Pointer to the next or previous page in the list of results.
|
|
2614
|
-
* @maxLength 2000
|
|
2615
|
-
*/
|
|
2616
|
-
cursor?: string | null;
|
|
2617
|
-
}
|
|
2618
|
-
interface Category {
|
|
2619
|
-
/**
|
|
2620
|
-
* Category ID.
|
|
2621
|
-
* @immutable
|
|
2622
|
-
* @maxLength 38
|
|
2623
|
-
*/
|
|
2624
|
-
id?: string;
|
|
2625
|
-
/**
|
|
2626
|
-
* Category label. Displayed in the Category Menu.
|
|
2627
|
-
* @maxLength 35
|
|
2628
|
-
*/
|
|
2629
|
-
label?: string;
|
|
2630
|
-
/**
|
|
2631
|
-
* Number of posts in the category.
|
|
2632
|
-
* @readonly
|
|
2633
|
-
*/
|
|
2634
|
-
postCount?: number;
|
|
2635
|
-
/**
|
|
2636
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2637
|
-
* @readonly
|
|
2638
|
-
*/
|
|
2639
|
-
url?: PageUrl;
|
|
2640
|
-
/**
|
|
2641
|
-
* Category description.
|
|
2642
|
-
* @maxLength 500
|
|
2643
|
-
*/
|
|
2644
|
-
description?: string | null;
|
|
2645
|
-
/**
|
|
2646
|
-
* Category title.
|
|
2647
|
-
* @maxLength 200
|
|
2648
|
-
* @deprecated Category title.
|
|
2649
|
-
* @targetRemovalDate 2025-07-16
|
|
2650
|
-
*/
|
|
2651
|
-
title?: string;
|
|
2652
|
-
/**
|
|
2653
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2654
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2655
|
-
*
|
|
2656
|
-
* Default: `-1`
|
|
2657
|
-
*/
|
|
2658
|
-
displayPosition?: number | null;
|
|
2659
|
-
/**
|
|
2660
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2661
|
-
* @format GUID
|
|
2662
|
-
*/
|
|
2663
|
-
translationId?: string | null;
|
|
2664
|
-
/**
|
|
2665
|
-
* Category language.
|
|
2666
|
-
*
|
|
2667
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2668
|
-
* @immutable
|
|
2669
|
-
*/
|
|
2670
|
-
language?: string | null;
|
|
2406
|
+
language?: string | null;
|
|
2671
2407
|
/**
|
|
2672
2408
|
* 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`.
|
|
2673
2409
|
* @maxLength 100
|
|
@@ -2972,6 +2708,270 @@ interface DraftPostTranslation {
|
|
|
2972
2708
|
/** Post URL. */
|
|
2973
2709
|
url?: PageUrl;
|
|
2974
2710
|
}
|
|
2711
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2712
|
+
createdEvent?: EntityCreatedEvent;
|
|
2713
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2714
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2715
|
+
actionEvent?: ActionEvent;
|
|
2716
|
+
/**
|
|
2717
|
+
* Unique event ID.
|
|
2718
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2719
|
+
*/
|
|
2720
|
+
id?: string;
|
|
2721
|
+
/**
|
|
2722
|
+
* Assumes actions are also always typed to an entity_type
|
|
2723
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2724
|
+
*/
|
|
2725
|
+
entityFqdn?: string;
|
|
2726
|
+
/**
|
|
2727
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2728
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2729
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2730
|
+
*/
|
|
2731
|
+
slug?: string;
|
|
2732
|
+
/** ID of the entity associated with the event. */
|
|
2733
|
+
entityId?: string;
|
|
2734
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2735
|
+
eventTime?: Date | null;
|
|
2736
|
+
/**
|
|
2737
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2738
|
+
* (for example, GDPR).
|
|
2739
|
+
*/
|
|
2740
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2741
|
+
/** If present, indicates the action that triggered the event. */
|
|
2742
|
+
originatedFrom?: string | null;
|
|
2743
|
+
/**
|
|
2744
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2745
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2746
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2747
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2748
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2749
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2750
|
+
*/
|
|
2751
|
+
entityEventSequence?: string | null;
|
|
2752
|
+
}
|
|
2753
|
+
/** @oneof */
|
|
2754
|
+
interface DomainEventBodyOneOf {
|
|
2755
|
+
createdEvent?: EntityCreatedEvent;
|
|
2756
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2757
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2758
|
+
actionEvent?: ActionEvent;
|
|
2759
|
+
}
|
|
2760
|
+
interface EntityCreatedEvent {
|
|
2761
|
+
entityAsJson?: string;
|
|
2762
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2763
|
+
restoreInfo?: RestoreInfo;
|
|
2764
|
+
}
|
|
2765
|
+
interface RestoreInfo {
|
|
2766
|
+
deletedDate?: Date | null;
|
|
2767
|
+
}
|
|
2768
|
+
interface EntityUpdatedEvent {
|
|
2769
|
+
/**
|
|
2770
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2771
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2772
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2773
|
+
*/
|
|
2774
|
+
currentEntityAsJson?: string;
|
|
2775
|
+
}
|
|
2776
|
+
interface EntityDeletedEvent {
|
|
2777
|
+
/** Entity that was deleted */
|
|
2778
|
+
deletedEntityAsJson?: string | null;
|
|
2779
|
+
}
|
|
2780
|
+
interface ActionEvent {
|
|
2781
|
+
bodyAsJson?: string;
|
|
2782
|
+
}
|
|
2783
|
+
interface MessageEnvelope {
|
|
2784
|
+
/**
|
|
2785
|
+
* App instance ID.
|
|
2786
|
+
* @format GUID
|
|
2787
|
+
*/
|
|
2788
|
+
instanceId?: string | null;
|
|
2789
|
+
/**
|
|
2790
|
+
* Event type.
|
|
2791
|
+
* @maxLength 150
|
|
2792
|
+
*/
|
|
2793
|
+
eventType?: string;
|
|
2794
|
+
/** The identification type and identity data. */
|
|
2795
|
+
identity?: IdentificationData;
|
|
2796
|
+
/** Stringify payload. */
|
|
2797
|
+
data?: string;
|
|
2798
|
+
}
|
|
2799
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2800
|
+
/**
|
|
2801
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2802
|
+
* @format GUID
|
|
2803
|
+
*/
|
|
2804
|
+
anonymousVisitorId?: string;
|
|
2805
|
+
/**
|
|
2806
|
+
* ID of a site visitor that has logged in to the site.
|
|
2807
|
+
* @format GUID
|
|
2808
|
+
*/
|
|
2809
|
+
memberId?: string;
|
|
2810
|
+
/**
|
|
2811
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2812
|
+
* @format GUID
|
|
2813
|
+
*/
|
|
2814
|
+
wixUserId?: string;
|
|
2815
|
+
/**
|
|
2816
|
+
* ID of an app.
|
|
2817
|
+
* @format GUID
|
|
2818
|
+
*/
|
|
2819
|
+
appId?: string;
|
|
2820
|
+
/** @readonly */
|
|
2821
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2822
|
+
}
|
|
2823
|
+
/** @oneof */
|
|
2824
|
+
interface IdentificationDataIdOneOf {
|
|
2825
|
+
/**
|
|
2826
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2827
|
+
* @format GUID
|
|
2828
|
+
*/
|
|
2829
|
+
anonymousVisitorId?: string;
|
|
2830
|
+
/**
|
|
2831
|
+
* ID of a site visitor that has logged in to the site.
|
|
2832
|
+
* @format GUID
|
|
2833
|
+
*/
|
|
2834
|
+
memberId?: string;
|
|
2835
|
+
/**
|
|
2836
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2837
|
+
* @format GUID
|
|
2838
|
+
*/
|
|
2839
|
+
wixUserId?: string;
|
|
2840
|
+
/**
|
|
2841
|
+
* ID of an app.
|
|
2842
|
+
* @format GUID
|
|
2843
|
+
*/
|
|
2844
|
+
appId?: string;
|
|
2845
|
+
}
|
|
2846
|
+
declare enum WebhookIdentityType {
|
|
2847
|
+
UNKNOWN = "UNKNOWN",
|
|
2848
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2849
|
+
MEMBER = "MEMBER",
|
|
2850
|
+
WIX_USER = "WIX_USER",
|
|
2851
|
+
APP = "APP"
|
|
2852
|
+
}
|
|
2853
|
+
/** @enumType */
|
|
2854
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2855
|
+
/** Get Blog Publications Count Stats request */
|
|
2856
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2857
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2858
|
+
rangeStart?: Date | null;
|
|
2859
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2860
|
+
rangeEnd?: Date | null;
|
|
2861
|
+
/** Order of the returned results. */
|
|
2862
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2863
|
+
/** Number of months to include in the response. */
|
|
2864
|
+
months?: number;
|
|
2865
|
+
/**
|
|
2866
|
+
* Language filter
|
|
2867
|
+
*
|
|
2868
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2869
|
+
* @format LANGUAGE_TAG
|
|
2870
|
+
*/
|
|
2871
|
+
language?: string | null;
|
|
2872
|
+
/**
|
|
2873
|
+
* Timezone of the client.
|
|
2874
|
+
* @minLength 3
|
|
2875
|
+
* @maxLength 100
|
|
2876
|
+
*/
|
|
2877
|
+
timeZone?: string | null;
|
|
2878
|
+
}
|
|
2879
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2880
|
+
UNKNOWN = "UNKNOWN",
|
|
2881
|
+
OLDEST = "OLDEST",
|
|
2882
|
+
NEWEST = "NEWEST"
|
|
2883
|
+
}
|
|
2884
|
+
/** @enumType */
|
|
2885
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2886
|
+
/** Get Blog Publications Count Stats response */
|
|
2887
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2888
|
+
/** Chronologically ordered list of publications. */
|
|
2889
|
+
stats?: PeriodPublicationsCount[];
|
|
2890
|
+
}
|
|
2891
|
+
/** Publications count for a specific time period */
|
|
2892
|
+
interface PeriodPublicationsCount {
|
|
2893
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2894
|
+
periodStart?: Date | null;
|
|
2895
|
+
/** Number of posts published during this month. */
|
|
2896
|
+
publicationsCount?: number;
|
|
2897
|
+
}
|
|
2898
|
+
/** Get Blog Post Count Stats request */
|
|
2899
|
+
interface QueryPostCountStatsRequest {
|
|
2900
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2901
|
+
rangeStart?: Date | null;
|
|
2902
|
+
/**
|
|
2903
|
+
* Order of returned results.
|
|
2904
|
+
*
|
|
2905
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
2906
|
+
* - `NEWEST`: posts by date in descending order.
|
|
2907
|
+
*
|
|
2908
|
+
* Default: `OLDEST`
|
|
2909
|
+
*/
|
|
2910
|
+
order?: OrderWithLiterals;
|
|
2911
|
+
/** Number of months to include in response. */
|
|
2912
|
+
months?: number;
|
|
2913
|
+
/**
|
|
2914
|
+
* Language filter.
|
|
2915
|
+
*
|
|
2916
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2917
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
2918
|
+
* @format LANGUAGE_TAG
|
|
2919
|
+
*/
|
|
2920
|
+
language?: string | null;
|
|
2921
|
+
/**
|
|
2922
|
+
* Time zone to use when calculating the start of the month.
|
|
2923
|
+
*
|
|
2924
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2925
|
+
* @minLength 3
|
|
2926
|
+
* @maxLength 100
|
|
2927
|
+
*/
|
|
2928
|
+
timeZone?: string | null;
|
|
2929
|
+
}
|
|
2930
|
+
declare enum Order {
|
|
2931
|
+
UNKNOWN = "UNKNOWN",
|
|
2932
|
+
OLDEST = "OLDEST",
|
|
2933
|
+
NEWEST = "NEWEST"
|
|
2934
|
+
}
|
|
2935
|
+
/** @enumType */
|
|
2936
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2937
|
+
/** Get Blog Post Count Stats response */
|
|
2938
|
+
interface QueryPostCountStatsResponse {
|
|
2939
|
+
/** List of published post counts by month. */
|
|
2940
|
+
stats?: PeriodPostCount[];
|
|
2941
|
+
}
|
|
2942
|
+
/** Post count for a specific time period */
|
|
2943
|
+
interface PeriodPostCount {
|
|
2944
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2945
|
+
periodStart?: Date | null;
|
|
2946
|
+
/** Number of posts published during this month. */
|
|
2947
|
+
postCount?: number;
|
|
2948
|
+
}
|
|
2949
|
+
interface GetTotalPublicationsRequest {
|
|
2950
|
+
/**
|
|
2951
|
+
* Language filter
|
|
2952
|
+
* @minLength 2
|
|
2953
|
+
* @format LANGUAGE_TAG
|
|
2954
|
+
*/
|
|
2955
|
+
language?: string | null;
|
|
2956
|
+
}
|
|
2957
|
+
interface GetTotalPublicationsResponse {
|
|
2958
|
+
/** Total amount of publications. */
|
|
2959
|
+
total?: number;
|
|
2960
|
+
}
|
|
2961
|
+
interface GetTotalPostsRequest {
|
|
2962
|
+
/**
|
|
2963
|
+
* Language filter.
|
|
2964
|
+
*
|
|
2965
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2966
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
2967
|
+
* @format LANGUAGE_TAG
|
|
2968
|
+
*/
|
|
2969
|
+
language?: string | null;
|
|
2970
|
+
}
|
|
2971
|
+
interface GetTotalPostsResponse {
|
|
2972
|
+
/** Total amount of published posts. */
|
|
2973
|
+
total?: number;
|
|
2974
|
+
}
|
|
2975
2975
|
interface GetTotalLikesPerMemberRequest {
|
|
2976
2976
|
/**
|
|
2977
2977
|
* Member ID.
|