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