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