@wix/auto_sdk_blog_posts 1.0.108 → 1.0.110
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.d.ts +11 -15
- package/build/cjs/index.js +31 -36
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +516 -514
- package/build/cjs/index.typings.js +26 -26
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +364 -364
- package/build/cjs/meta.js +20 -20
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +11 -15
- package/build/es/index.mjs +31 -36
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +516 -514
- package/build/es/index.typings.mjs +26 -26
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +364 -364
- package/build/es/meta.mjs +20 -20
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -15
- package/build/internal/cjs/index.js +31 -36
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +516 -514
- package/build/internal/cjs/index.typings.js +26 -26
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +364 -364
- package/build/internal/cjs/meta.js +20 -20
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -15
- package/build/internal/es/index.mjs +31 -36
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +516 -514
- package/build/internal/es/index.typings.mjs +26 -26
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +364 -364
- package/build/internal/es/meta.mjs +20 -20
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2235,125 +2235,433 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2235
2235
|
*/
|
|
2236
2236
|
anonymousVisitorId?: string | null;
|
|
2237
2237
|
}
|
|
2238
|
-
|
|
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;
|
|
2238
|
+
interface ListTemplatesRequest {
|
|
2248
2239
|
/**
|
|
2249
|
-
*
|
|
2240
|
+
* Filter post templates by given template category ids
|
|
2241
|
+
* @maxSize 50
|
|
2242
|
+
* @format GUID
|
|
2243
|
+
*/
|
|
2244
|
+
categoryIds?: string[];
|
|
2245
|
+
/**
|
|
2246
|
+
* Filter post templates by provided language
|
|
2247
|
+
* @format LANGUAGE_TAG
|
|
2248
|
+
*/
|
|
2249
|
+
language?: string | null;
|
|
2250
|
+
/** Returns post template categories when set to TRUE */
|
|
2251
|
+
listTemplateCategories?: boolean;
|
|
2252
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2253
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2254
|
+
/** Pagination options. */
|
|
2255
|
+
paging?: BlogPaging;
|
|
2256
|
+
}
|
|
2257
|
+
declare enum GetPostTemplatesSort {
|
|
2258
|
+
/** Sort by ascending publishing date. */
|
|
2259
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2260
|
+
/** Sort by descending publishing date. */
|
|
2261
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2262
|
+
}
|
|
2263
|
+
/** @enumType */
|
|
2264
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2265
|
+
interface BlogPaging {
|
|
2266
|
+
/**
|
|
2267
|
+
* Number of items to skip in the current sort order.
|
|
2268
|
+
*
|
|
2269
|
+
*
|
|
2270
|
+
* Default: `0`
|
|
2271
|
+
*/
|
|
2272
|
+
offset?: number;
|
|
2273
|
+
/**
|
|
2274
|
+
* Number of items to return.
|
|
2275
|
+
*
|
|
2276
|
+
*
|
|
2277
|
+
* Default:`50`
|
|
2278
|
+
* @min 1
|
|
2279
|
+
* @max 100
|
|
2280
|
+
*/
|
|
2281
|
+
limit?: number;
|
|
2282
|
+
/**
|
|
2283
|
+
* Pointer to the next or previous page in the list of results.
|
|
2284
|
+
* @maxLength 2000
|
|
2285
|
+
*/
|
|
2286
|
+
cursor?: string | null;
|
|
2287
|
+
}
|
|
2288
|
+
interface ListTemplatesResponse {
|
|
2289
|
+
/** Available post templates */
|
|
2290
|
+
postTemplates?: Post[];
|
|
2291
|
+
/** Details on the paged set of posts templates returned. */
|
|
2292
|
+
postTemplatesMetaData?: MetaData;
|
|
2293
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2294
|
+
templateCategories?: Category[];
|
|
2295
|
+
}
|
|
2296
|
+
interface MetaData {
|
|
2297
|
+
/** Number of items returned in this response. */
|
|
2298
|
+
count?: number;
|
|
2299
|
+
/** Requested offset. */
|
|
2300
|
+
offset?: number;
|
|
2301
|
+
/** Total number of items that match the query. */
|
|
2302
|
+
total?: number;
|
|
2303
|
+
/**
|
|
2304
|
+
* Pointer to the next or previous page in the list of results.
|
|
2305
|
+
* @maxLength 2000
|
|
2306
|
+
*/
|
|
2307
|
+
cursor?: string | null;
|
|
2308
|
+
}
|
|
2309
|
+
interface Category {
|
|
2310
|
+
/**
|
|
2311
|
+
* Category ID.
|
|
2312
|
+
* @immutable
|
|
2313
|
+
* @maxLength 38
|
|
2314
|
+
*/
|
|
2315
|
+
_id?: string;
|
|
2316
|
+
/**
|
|
2317
|
+
* Category label. Displayed in the Category Menu.
|
|
2318
|
+
* @maxLength 35
|
|
2319
|
+
*/
|
|
2320
|
+
label?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* Number of posts in the category.
|
|
2323
|
+
* @readonly
|
|
2324
|
+
*/
|
|
2325
|
+
postCount?: number;
|
|
2326
|
+
/**
|
|
2327
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2328
|
+
* @readonly
|
|
2329
|
+
*/
|
|
2330
|
+
url?: string;
|
|
2331
|
+
/**
|
|
2332
|
+
* Category description.
|
|
2333
|
+
* @maxLength 500
|
|
2334
|
+
*/
|
|
2335
|
+
description?: string | null;
|
|
2336
|
+
/**
|
|
2337
|
+
* Category title.
|
|
2338
|
+
* @maxLength 200
|
|
2339
|
+
* @deprecated Category title.
|
|
2340
|
+
* @targetRemovalDate 2025-07-16
|
|
2341
|
+
*/
|
|
2342
|
+
title?: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2345
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2346
|
+
*
|
|
2347
|
+
* Default: `-1`
|
|
2348
|
+
*/
|
|
2349
|
+
displayPosition?: number | null;
|
|
2350
|
+
/**
|
|
2351
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2352
|
+
* @format GUID
|
|
2353
|
+
*/
|
|
2354
|
+
translationId?: string | null;
|
|
2355
|
+
/**
|
|
2356
|
+
* Category language.
|
|
2250
2357
|
*
|
|
2251
2358
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2252
|
-
* @
|
|
2359
|
+
* @immutable
|
|
2253
2360
|
*/
|
|
2254
2361
|
language?: string | null;
|
|
2255
2362
|
/**
|
|
2256
|
-
*
|
|
2257
|
-
* @minLength 3
|
|
2363
|
+
* 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`.
|
|
2258
2364
|
* @maxLength 100
|
|
2259
2365
|
*/
|
|
2260
|
-
|
|
2366
|
+
slug?: string;
|
|
2367
|
+
/** SEO data. */
|
|
2368
|
+
seoData?: SeoSchema;
|
|
2369
|
+
/** Category cover image. */
|
|
2370
|
+
coverImage?: string;
|
|
2371
|
+
/**
|
|
2372
|
+
* Date and time the Category was last updated.
|
|
2373
|
+
* @readonly
|
|
2374
|
+
*/
|
|
2375
|
+
_updatedDate?: Date | null;
|
|
2261
2376
|
}
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2377
|
+
interface CategoryTranslation {
|
|
2378
|
+
/**
|
|
2379
|
+
* Category ID.
|
|
2380
|
+
* @format GUID
|
|
2381
|
+
*/
|
|
2382
|
+
_id?: string;
|
|
2383
|
+
/**
|
|
2384
|
+
* Label displayed in the categories menu on the site.
|
|
2385
|
+
* @maxLength 100
|
|
2386
|
+
*/
|
|
2387
|
+
label?: string | null;
|
|
2388
|
+
/**
|
|
2389
|
+
* Language of the category.
|
|
2390
|
+
* @format LANGUAGE_TAG
|
|
2391
|
+
*/
|
|
2392
|
+
language?: string | null;
|
|
2393
|
+
/** URL of this category page. */
|
|
2394
|
+
url?: string;
|
|
2266
2395
|
}
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2396
|
+
interface GetTemplateRequest {
|
|
2397
|
+
/**
|
|
2398
|
+
* Post template id
|
|
2399
|
+
* @format GUID
|
|
2400
|
+
*/
|
|
2401
|
+
postTemplateId?: string;
|
|
2273
2402
|
}
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
periodStart?: Date | null;
|
|
2278
|
-
/** Number of posts published during this month. */
|
|
2279
|
-
publicationsCount?: number;
|
|
2403
|
+
interface GetTemplateResponse {
|
|
2404
|
+
/** Post template */
|
|
2405
|
+
postTemplate?: Post;
|
|
2280
2406
|
}
|
|
2281
|
-
|
|
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;
|
|
2407
|
+
interface CreateDraftPostFromTemplateRequest {
|
|
2285
2408
|
/**
|
|
2286
|
-
*
|
|
2409
|
+
* Post template id
|
|
2410
|
+
* @format GUID
|
|
2411
|
+
*/
|
|
2412
|
+
postTemplateId?: string;
|
|
2413
|
+
}
|
|
2414
|
+
interface CreateDraftPostFromTemplateResponse {
|
|
2415
|
+
/** Created draft post */
|
|
2416
|
+
draftPost?: DraftPost;
|
|
2417
|
+
}
|
|
2418
|
+
interface DraftPost {
|
|
2419
|
+
/**
|
|
2420
|
+
* Draft post ID.
|
|
2421
|
+
* @readonly
|
|
2422
|
+
* @maxLength 38
|
|
2423
|
+
*/
|
|
2424
|
+
_id?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* Draft post title.
|
|
2427
|
+
* @maxLength 200
|
|
2428
|
+
*/
|
|
2429
|
+
title?: string;
|
|
2430
|
+
/**
|
|
2431
|
+
* Draft post excerpt.
|
|
2287
2432
|
*
|
|
2288
|
-
*
|
|
2289
|
-
*
|
|
2433
|
+
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
2434
|
+
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
2435
|
+
* @maxLength 500
|
|
2436
|
+
*/
|
|
2437
|
+
excerpt?: string | null;
|
|
2438
|
+
/** Whether the draft post is marked as featured. */
|
|
2439
|
+
featured?: boolean | null;
|
|
2440
|
+
/**
|
|
2441
|
+
* Category IDs of the draft post.
|
|
2442
|
+
* @maxSize 10
|
|
2443
|
+
* @maxLength 38
|
|
2444
|
+
*/
|
|
2445
|
+
categoryIds?: string[];
|
|
2446
|
+
/**
|
|
2447
|
+
* Draft post owner's member ID.
|
|
2448
|
+
* @format GUID
|
|
2449
|
+
*/
|
|
2450
|
+
memberId?: string | null;
|
|
2451
|
+
/**
|
|
2452
|
+
* Hashtags in the post.
|
|
2453
|
+
* @maxSize 100
|
|
2454
|
+
* @maxLength 100
|
|
2455
|
+
*/
|
|
2456
|
+
hashtags?: string[];
|
|
2457
|
+
/** Whether commenting on the draft post is enabled. */
|
|
2458
|
+
commentingEnabled?: boolean | null;
|
|
2459
|
+
/**
|
|
2460
|
+
* Estimated reading time of the draft post (calculated automatically).
|
|
2461
|
+
* @readonly
|
|
2462
|
+
*/
|
|
2463
|
+
minutesToRead?: number;
|
|
2464
|
+
/** Image placed at the top of the blog page. */
|
|
2465
|
+
heroImage?: string;
|
|
2466
|
+
/**
|
|
2467
|
+
* Tag IDs the draft post is tagged with.
|
|
2468
|
+
* @maxSize 30
|
|
2469
|
+
* @maxLength 38
|
|
2470
|
+
*/
|
|
2471
|
+
tagIds?: string[];
|
|
2472
|
+
/**
|
|
2473
|
+
* IDs of posts related to this draft post.
|
|
2474
|
+
* @maxSize 3
|
|
2475
|
+
* @maxLength 38
|
|
2476
|
+
*/
|
|
2477
|
+
relatedPostIds?: string[];
|
|
2478
|
+
/**
|
|
2479
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
2480
|
+
* @maxSize 100
|
|
2481
|
+
* @format GUID
|
|
2482
|
+
*/
|
|
2483
|
+
pricingPlanIds?: string[];
|
|
2484
|
+
/**
|
|
2485
|
+
* ID of the draft post's translations.
|
|
2290
2486
|
*
|
|
2291
|
-
*
|
|
2487
|
+
* All translations of a single post share the same `translationId`.
|
|
2488
|
+
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
2489
|
+
* @format GUID
|
|
2292
2490
|
*/
|
|
2293
|
-
|
|
2294
|
-
/** Number of months to include in response. */
|
|
2295
|
-
months?: number;
|
|
2491
|
+
translationId?: string | null;
|
|
2296
2492
|
/**
|
|
2297
|
-
* Language
|
|
2493
|
+
* Language the draft post is written in.
|
|
2298
2494
|
*
|
|
2299
2495
|
* 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
2496
|
* @format LANGUAGE_TAG
|
|
2302
2497
|
*/
|
|
2303
2498
|
language?: string | null;
|
|
2304
2499
|
/**
|
|
2305
|
-
*
|
|
2500
|
+
* Draft Post rich content.
|
|
2306
2501
|
*
|
|
2307
|
-
*
|
|
2308
|
-
*
|
|
2502
|
+
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
|
2503
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2504
|
+
* </widget>
|
|
2505
|
+
*/
|
|
2506
|
+
richContent?: RichContent;
|
|
2507
|
+
/**
|
|
2508
|
+
* Status of the draft post.
|
|
2509
|
+
* @readonly
|
|
2510
|
+
*/
|
|
2511
|
+
status?: StatusWithLiterals;
|
|
2512
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
2513
|
+
moderationDetails?: ModerationDetails;
|
|
2514
|
+
/**
|
|
2515
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
2516
|
+
* @readonly
|
|
2517
|
+
*/
|
|
2518
|
+
hasUnpublishedChanges?: boolean;
|
|
2519
|
+
/**
|
|
2520
|
+
* Date the draft post was last edited.
|
|
2521
|
+
* @readonly
|
|
2522
|
+
*/
|
|
2523
|
+
editedDate?: Date | null;
|
|
2524
|
+
/**
|
|
2525
|
+
* Date the draft post is scheduled to be published.
|
|
2526
|
+
* @readonly
|
|
2527
|
+
*/
|
|
2528
|
+
scheduledPublishDate?: Date | null;
|
|
2529
|
+
/** Date the post was first published. */
|
|
2530
|
+
firstPublishedDate?: Date | null;
|
|
2531
|
+
/** SEO data. */
|
|
2532
|
+
seoData?: SeoSchema;
|
|
2533
|
+
/**
|
|
2534
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
|
2535
|
+
* @readonly
|
|
2536
|
+
*/
|
|
2537
|
+
url?: string;
|
|
2538
|
+
/**
|
|
2539
|
+
* Date the draft post was first created.
|
|
2540
|
+
* @readonly
|
|
2541
|
+
*/
|
|
2542
|
+
_createdDate?: Date | null;
|
|
2543
|
+
/**
|
|
2544
|
+
* SEO slug.
|
|
2309
2545
|
* @maxLength 100
|
|
2310
2546
|
*/
|
|
2311
|
-
|
|
2547
|
+
seoSlug?: string | null;
|
|
2548
|
+
/** Post cover media. */
|
|
2549
|
+
media?: Media;
|
|
2550
|
+
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2551
|
+
previewTextParagraph?: number | null;
|
|
2312
2552
|
}
|
|
2313
|
-
declare enum
|
|
2553
|
+
declare enum Origin {
|
|
2314
2554
|
UNKNOWN = "UNKNOWN",
|
|
2315
|
-
|
|
2316
|
-
|
|
2555
|
+
/** Changed by admin */
|
|
2556
|
+
ADMIN = "ADMIN",
|
|
2557
|
+
/** Categories were changed */
|
|
2558
|
+
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
2559
|
+
/** Saved automatically */
|
|
2560
|
+
AUTO_SAVE = "AUTO_SAVE",
|
|
2561
|
+
/** Copied from template */
|
|
2562
|
+
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
2563
|
+
/** Imported */
|
|
2564
|
+
IMPORT = "IMPORT",
|
|
2565
|
+
/** Imported in bulk */
|
|
2566
|
+
IMPORT_BULK = "IMPORT_BULK",
|
|
2567
|
+
/** Imported with html import */
|
|
2568
|
+
IMPORT_HTML = "IMPORT_HTML",
|
|
2569
|
+
/** Patch import */
|
|
2570
|
+
IMPORT_PATCH = "IMPORT_PATCH",
|
|
2571
|
+
/** Changed language */
|
|
2572
|
+
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
2573
|
+
/** Saved manually */
|
|
2574
|
+
MANUAL_SAVE = "MANUAL_SAVE",
|
|
2575
|
+
/** Affected by migration */
|
|
2576
|
+
MIGRATION = "MIGRATION",
|
|
2577
|
+
/** Affected by moderation */
|
|
2578
|
+
MODERATION = "MODERATION",
|
|
2579
|
+
/** Moved to trash */
|
|
2580
|
+
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
2581
|
+
/** Pricing plans were changed */
|
|
2582
|
+
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
2583
|
+
/** Was provisioned */
|
|
2584
|
+
PROVISION = "PROVISION",
|
|
2585
|
+
/** Was published */
|
|
2586
|
+
PUBLISH = "PUBLISH",
|
|
2587
|
+
/** Owner was reassigned */
|
|
2588
|
+
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
2589
|
+
/** Was reblogged */
|
|
2590
|
+
REBLOG = "REBLOG",
|
|
2591
|
+
/** Was restored */
|
|
2592
|
+
RESTORE = "RESTORE",
|
|
2593
|
+
/** Reverted to draft */
|
|
2594
|
+
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
2595
|
+
/** Was translated */
|
|
2596
|
+
TRANSLATION = "TRANSLATION",
|
|
2597
|
+
/** Was unpublished */
|
|
2598
|
+
UNPUBLISH = "UNPUBLISH",
|
|
2599
|
+
/** Was unscheduled */
|
|
2600
|
+
UNSCHEDULE = "UNSCHEDULE",
|
|
2601
|
+
/** New edit session started which updated editing_session_id id */
|
|
2602
|
+
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
2603
|
+
/** Was scheduled by Later */
|
|
2604
|
+
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
2605
|
+
/** Was unscheduled by Later */
|
|
2606
|
+
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
2607
|
+
/** Was published by Later */
|
|
2608
|
+
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
2609
|
+
/** Was scheduled */
|
|
2610
|
+
SCHEDULE = "SCHEDULE",
|
|
2611
|
+
/** Was removed from moderation */
|
|
2612
|
+
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
2613
|
+
/** Was rejected from moderation */
|
|
2614
|
+
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
2615
|
+
/** Was approved in moderation */
|
|
2616
|
+
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
2617
|
+
/** Tag was deleted */
|
|
2618
|
+
DELETE_TAG = "DELETE_TAG",
|
|
2619
|
+
/** Post was pinned */
|
|
2620
|
+
PIN = "PIN",
|
|
2621
|
+
/** Post was unpinned */
|
|
2622
|
+
UNPIN = "UNPIN",
|
|
2623
|
+
/** Saved automatically by AI tool. */
|
|
2624
|
+
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2317
2625
|
}
|
|
2318
2626
|
/** @enumType */
|
|
2319
|
-
type
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
/**
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2330
|
-
|
|
2627
|
+
type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
|
2628
|
+
declare enum Status {
|
|
2629
|
+
UNKNOWN = "UNKNOWN",
|
|
2630
|
+
/** Status indicating the draft post is published. */
|
|
2631
|
+
PUBLISHED = "PUBLISHED",
|
|
2632
|
+
/** Status indicating the draft post is unpublished. */
|
|
2633
|
+
UNPUBLISHED = "UNPUBLISHED",
|
|
2634
|
+
/** Status indicating the draft post is scheduled for publication. */
|
|
2635
|
+
SCHEDULED = "SCHEDULED",
|
|
2636
|
+
/** Status indicating the draft post is deleted. */
|
|
2637
|
+
DELETED = "DELETED",
|
|
2638
|
+
/** Status indicating the draft post is in review. */
|
|
2639
|
+
IN_REVIEW = "IN_REVIEW"
|
|
2331
2640
|
}
|
|
2332
|
-
|
|
2641
|
+
/** @enumType */
|
|
2642
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
2643
|
+
interface DraftPostTranslation {
|
|
2333
2644
|
/**
|
|
2334
|
-
*
|
|
2335
|
-
* @
|
|
2336
|
-
* @format LANGUAGE_TAG
|
|
2645
|
+
* Post ID.
|
|
2646
|
+
* @format GUID
|
|
2337
2647
|
*/
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
/** Total amount of publications. */
|
|
2342
|
-
total?: number;
|
|
2343
|
-
}
|
|
2344
|
-
interface GetTotalPostsRequest {
|
|
2648
|
+
_id?: string;
|
|
2649
|
+
/** Post status. */
|
|
2650
|
+
status?: StatusWithLiterals;
|
|
2345
2651
|
/**
|
|
2346
|
-
* Language
|
|
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.
|
|
2652
|
+
* Language the post is written in.
|
|
2350
2653
|
* @format LANGUAGE_TAG
|
|
2351
2654
|
*/
|
|
2352
2655
|
language?: string | null;
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2656
|
+
/**
|
|
2657
|
+
* Post slug. For example, 'post-slug'.
|
|
2658
|
+
* @maxLength 100
|
|
2659
|
+
*/
|
|
2660
|
+
slug?: string | null;
|
|
2661
|
+
/** SEO data. */
|
|
2662
|
+
seoData?: SeoSchema;
|
|
2663
|
+
/** Post URL. */
|
|
2664
|
+
url?: string;
|
|
2357
2665
|
}
|
|
2358
2666
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2359
2667
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -2509,438 +2817,130 @@ interface AccountInfo {
|
|
|
2509
2817
|
*/
|
|
2510
2818
|
parentAccountId?: string | null;
|
|
2511
2819
|
/**
|
|
2512
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2513
|
-
* @format GUID
|
|
2514
|
-
*/
|
|
2515
|
-
siteId?: string | null;
|
|
2516
|
-
}
|
|
2517
|
-
interface ListTemplatesRequest {
|
|
2518
|
-
/**
|
|
2519
|
-
* Filter post templates by given template category ids
|
|
2520
|
-
* @maxSize 50
|
|
2521
|
-
* @format GUID
|
|
2522
|
-
*/
|
|
2523
|
-
categoryIds?: string[];
|
|
2524
|
-
/**
|
|
2525
|
-
* Filter post templates by provided language
|
|
2526
|
-
* @format LANGUAGE_TAG
|
|
2527
|
-
*/
|
|
2528
|
-
language?: string | null;
|
|
2529
|
-
/** Returns post template categories when set to TRUE */
|
|
2530
|
-
listTemplateCategories?: boolean;
|
|
2531
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2532
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2533
|
-
/** Pagination options. */
|
|
2534
|
-
paging?: BlogPaging;
|
|
2535
|
-
}
|
|
2536
|
-
declare enum GetPostTemplatesSort {
|
|
2537
|
-
/** Sort by ascending publishing date. */
|
|
2538
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2539
|
-
/** Sort by descending publishing date. */
|
|
2540
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2541
|
-
}
|
|
2542
|
-
/** @enumType */
|
|
2543
|
-
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2544
|
-
interface BlogPaging {
|
|
2545
|
-
/**
|
|
2546
|
-
* Number of items to skip in the current sort order.
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2549
|
-
* Default: `0`
|
|
2550
|
-
*/
|
|
2551
|
-
offset?: number;
|
|
2552
|
-
/**
|
|
2553
|
-
* Number of items to return.
|
|
2554
|
-
*
|
|
2555
|
-
*
|
|
2556
|
-
* Default:`50`
|
|
2557
|
-
* @min 1
|
|
2558
|
-
* @max 100
|
|
2559
|
-
*/
|
|
2560
|
-
limit?: number;
|
|
2561
|
-
/**
|
|
2562
|
-
* Pointer to the next or previous page in the list of results.
|
|
2563
|
-
* @maxLength 2000
|
|
2564
|
-
*/
|
|
2565
|
-
cursor?: string | null;
|
|
2566
|
-
}
|
|
2567
|
-
interface ListTemplatesResponse {
|
|
2568
|
-
/** Available post templates */
|
|
2569
|
-
postTemplates?: Post[];
|
|
2570
|
-
/** Details on the paged set of posts templates returned. */
|
|
2571
|
-
postTemplatesMetaData?: MetaData;
|
|
2572
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2573
|
-
templateCategories?: Category[];
|
|
2574
|
-
}
|
|
2575
|
-
interface MetaData {
|
|
2576
|
-
/** Number of items returned in this response. */
|
|
2577
|
-
count?: number;
|
|
2578
|
-
/** Requested offset. */
|
|
2579
|
-
offset?: number;
|
|
2580
|
-
/** Total number of items that match the query. */
|
|
2581
|
-
total?: number;
|
|
2582
|
-
/**
|
|
2583
|
-
* Pointer to the next or previous page in the list of results.
|
|
2584
|
-
* @maxLength 2000
|
|
2585
|
-
*/
|
|
2586
|
-
cursor?: string | null;
|
|
2587
|
-
}
|
|
2588
|
-
interface Category {
|
|
2589
|
-
/**
|
|
2590
|
-
* Category ID.
|
|
2591
|
-
* @immutable
|
|
2592
|
-
* @maxLength 38
|
|
2593
|
-
*/
|
|
2594
|
-
_id?: string;
|
|
2595
|
-
/**
|
|
2596
|
-
* Category label. Displayed in the Category Menu.
|
|
2597
|
-
* @maxLength 35
|
|
2598
|
-
*/
|
|
2599
|
-
label?: string;
|
|
2600
|
-
/**
|
|
2601
|
-
* Number of posts in the category.
|
|
2602
|
-
* @readonly
|
|
2603
|
-
*/
|
|
2604
|
-
postCount?: number;
|
|
2605
|
-
/**
|
|
2606
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2607
|
-
* @readonly
|
|
2608
|
-
*/
|
|
2609
|
-
url?: string;
|
|
2610
|
-
/**
|
|
2611
|
-
* Category description.
|
|
2612
|
-
* @maxLength 500
|
|
2613
|
-
*/
|
|
2614
|
-
description?: string | null;
|
|
2615
|
-
/**
|
|
2616
|
-
* Category title.
|
|
2617
|
-
* @maxLength 200
|
|
2618
|
-
* @deprecated Category title.
|
|
2619
|
-
* @targetRemovalDate 2025-07-16
|
|
2620
|
-
*/
|
|
2621
|
-
title?: string;
|
|
2622
|
-
/**
|
|
2623
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2624
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2625
|
-
*
|
|
2626
|
-
* Default: `-1`
|
|
2627
|
-
*/
|
|
2628
|
-
displayPosition?: number | null;
|
|
2629
|
-
/**
|
|
2630
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2631
|
-
* @format GUID
|
|
2632
|
-
*/
|
|
2633
|
-
translationId?: string | null;
|
|
2634
|
-
/**
|
|
2635
|
-
* Category language.
|
|
2636
|
-
*
|
|
2637
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2638
|
-
* @immutable
|
|
2639
|
-
*/
|
|
2640
|
-
language?: string | null;
|
|
2641
|
-
/**
|
|
2642
|
-
* 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`.
|
|
2643
|
-
* @maxLength 100
|
|
2644
|
-
*/
|
|
2645
|
-
slug?: string;
|
|
2646
|
-
/** SEO data. */
|
|
2647
|
-
seoData?: SeoSchema;
|
|
2648
|
-
/** Category cover image. */
|
|
2649
|
-
coverImage?: string;
|
|
2650
|
-
/**
|
|
2651
|
-
* Date and time the Category was last updated.
|
|
2652
|
-
* @readonly
|
|
2653
|
-
*/
|
|
2654
|
-
_updatedDate?: Date | null;
|
|
2655
|
-
}
|
|
2656
|
-
interface CategoryTranslation {
|
|
2657
|
-
/**
|
|
2658
|
-
* Category ID.
|
|
2659
|
-
* @format GUID
|
|
2660
|
-
*/
|
|
2661
|
-
_id?: string;
|
|
2662
|
-
/**
|
|
2663
|
-
* Label displayed in the categories menu on the site.
|
|
2664
|
-
* @maxLength 100
|
|
2665
|
-
*/
|
|
2666
|
-
label?: string | null;
|
|
2667
|
-
/**
|
|
2668
|
-
* Language of the category.
|
|
2669
|
-
* @format LANGUAGE_TAG
|
|
2670
|
-
*/
|
|
2671
|
-
language?: string | null;
|
|
2672
|
-
/** URL of this category page. */
|
|
2673
|
-
url?: string;
|
|
2674
|
-
}
|
|
2675
|
-
interface GetTemplateRequest {
|
|
2676
|
-
/**
|
|
2677
|
-
* Post template id
|
|
2678
|
-
* @format GUID
|
|
2679
|
-
*/
|
|
2680
|
-
postTemplateId?: string;
|
|
2681
|
-
}
|
|
2682
|
-
interface GetTemplateResponse {
|
|
2683
|
-
/** Post template */
|
|
2684
|
-
postTemplate?: Post;
|
|
2685
|
-
}
|
|
2686
|
-
interface CreateDraftPostFromTemplateRequest {
|
|
2687
|
-
/**
|
|
2688
|
-
* Post template id
|
|
2689
|
-
* @format GUID
|
|
2690
|
-
*/
|
|
2691
|
-
postTemplateId?: string;
|
|
2692
|
-
}
|
|
2693
|
-
interface CreateDraftPostFromTemplateResponse {
|
|
2694
|
-
/** Created draft post */
|
|
2695
|
-
draftPost?: DraftPost;
|
|
2696
|
-
}
|
|
2697
|
-
interface DraftPost {
|
|
2698
|
-
/**
|
|
2699
|
-
* Draft post ID.
|
|
2700
|
-
* @readonly
|
|
2701
|
-
* @maxLength 38
|
|
2702
|
-
*/
|
|
2703
|
-
_id?: string;
|
|
2704
|
-
/**
|
|
2705
|
-
* Draft post title.
|
|
2706
|
-
* @maxLength 200
|
|
2707
|
-
*/
|
|
2708
|
-
title?: string;
|
|
2709
|
-
/**
|
|
2710
|
-
* Draft post excerpt.
|
|
2711
|
-
*
|
|
2712
|
-
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
2713
|
-
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
2714
|
-
* @maxLength 500
|
|
2715
|
-
*/
|
|
2716
|
-
excerpt?: string | null;
|
|
2717
|
-
/** Whether the draft post is marked as featured. */
|
|
2718
|
-
featured?: boolean | null;
|
|
2719
|
-
/**
|
|
2720
|
-
* Category IDs of the draft post.
|
|
2721
|
-
* @maxSize 10
|
|
2722
|
-
* @maxLength 38
|
|
2723
|
-
*/
|
|
2724
|
-
categoryIds?: string[];
|
|
2725
|
-
/**
|
|
2726
|
-
* Draft post owner's member ID.
|
|
2727
|
-
* @format GUID
|
|
2728
|
-
*/
|
|
2729
|
-
memberId?: string | null;
|
|
2730
|
-
/**
|
|
2731
|
-
* Hashtags in the post.
|
|
2732
|
-
* @maxSize 100
|
|
2733
|
-
* @maxLength 100
|
|
2734
|
-
*/
|
|
2735
|
-
hashtags?: string[];
|
|
2736
|
-
/** Whether commenting on the draft post is enabled. */
|
|
2737
|
-
commentingEnabled?: boolean | null;
|
|
2738
|
-
/**
|
|
2739
|
-
* Estimated reading time of the draft post (calculated automatically).
|
|
2740
|
-
* @readonly
|
|
2741
|
-
*/
|
|
2742
|
-
minutesToRead?: number;
|
|
2743
|
-
/** Image placed at the top of the blog page. */
|
|
2744
|
-
heroImage?: string;
|
|
2745
|
-
/**
|
|
2746
|
-
* Tag IDs the draft post is tagged with.
|
|
2747
|
-
* @maxSize 30
|
|
2748
|
-
* @maxLength 38
|
|
2749
|
-
*/
|
|
2750
|
-
tagIds?: string[];
|
|
2751
|
-
/**
|
|
2752
|
-
* IDs of posts related to this draft post.
|
|
2753
|
-
* @maxSize 3
|
|
2754
|
-
* @maxLength 38
|
|
2755
|
-
*/
|
|
2756
|
-
relatedPostIds?: string[];
|
|
2757
|
-
/**
|
|
2758
|
-
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
2759
|
-
* @maxSize 100
|
|
2760
|
-
* @format GUID
|
|
2761
|
-
*/
|
|
2762
|
-
pricingPlanIds?: string[];
|
|
2763
|
-
/**
|
|
2764
|
-
* ID of the draft post's translations.
|
|
2765
|
-
*
|
|
2766
|
-
* All translations of a single post share the same `translationId`.
|
|
2767
|
-
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
2820
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2768
2821
|
* @format GUID
|
|
2769
2822
|
*/
|
|
2770
|
-
|
|
2823
|
+
siteId?: string | null;
|
|
2824
|
+
}
|
|
2825
|
+
/** Get Blog Publications Count Stats request */
|
|
2826
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2827
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2828
|
+
rangeStart?: Date | null;
|
|
2829
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2830
|
+
rangeEnd?: Date | null;
|
|
2831
|
+
/** Order of the returned results. */
|
|
2832
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2833
|
+
/** Number of months to include in the response. */
|
|
2834
|
+
months?: number;
|
|
2771
2835
|
/**
|
|
2772
|
-
* Language
|
|
2836
|
+
* Language filter
|
|
2773
2837
|
*
|
|
2774
2838
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2775
2839
|
* @format LANGUAGE_TAG
|
|
2776
2840
|
*/
|
|
2777
2841
|
language?: string | null;
|
|
2778
2842
|
/**
|
|
2779
|
-
*
|
|
2780
|
-
*
|
|
2781
|
-
*
|
|
2782
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2783
|
-
* </widget>
|
|
2784
|
-
*/
|
|
2785
|
-
richContent?: RichContent;
|
|
2786
|
-
/**
|
|
2787
|
-
* Status of the draft post.
|
|
2788
|
-
* @readonly
|
|
2789
|
-
*/
|
|
2790
|
-
status?: StatusWithLiterals;
|
|
2791
|
-
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
2792
|
-
moderationDetails?: ModerationDetails;
|
|
2793
|
-
/**
|
|
2794
|
-
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
2795
|
-
* @readonly
|
|
2796
|
-
*/
|
|
2797
|
-
hasUnpublishedChanges?: boolean;
|
|
2798
|
-
/**
|
|
2799
|
-
* Date the draft post was last edited.
|
|
2800
|
-
* @readonly
|
|
2801
|
-
*/
|
|
2802
|
-
editedDate?: Date | null;
|
|
2803
|
-
/**
|
|
2804
|
-
* Date the draft post is scheduled to be published.
|
|
2805
|
-
* @readonly
|
|
2843
|
+
* Timezone of the client.
|
|
2844
|
+
* @minLength 3
|
|
2845
|
+
* @maxLength 100
|
|
2806
2846
|
*/
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2847
|
+
timeZone?: string | null;
|
|
2848
|
+
}
|
|
2849
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2850
|
+
UNKNOWN = "UNKNOWN",
|
|
2851
|
+
OLDEST = "OLDEST",
|
|
2852
|
+
NEWEST = "NEWEST"
|
|
2853
|
+
}
|
|
2854
|
+
/** @enumType */
|
|
2855
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2856
|
+
/** Get Blog Publications Count Stats response */
|
|
2857
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2858
|
+
/** Chronologically ordered list of publications. */
|
|
2859
|
+
stats?: PeriodPublicationsCount[];
|
|
2860
|
+
}
|
|
2861
|
+
/** Publications count for a specific time period */
|
|
2862
|
+
interface PeriodPublicationsCount {
|
|
2863
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2864
|
+
periodStart?: Date | null;
|
|
2865
|
+
/** Number of posts published during this month. */
|
|
2866
|
+
publicationsCount?: number;
|
|
2867
|
+
}
|
|
2868
|
+
/** Get Blog Post Count Stats request */
|
|
2869
|
+
interface QueryPostCountStatsRequest {
|
|
2870
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2871
|
+
rangeStart?: Date | null;
|
|
2812
2872
|
/**
|
|
2813
|
-
*
|
|
2814
|
-
*
|
|
2873
|
+
* Order of returned results.
|
|
2874
|
+
*
|
|
2875
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
2876
|
+
* - `NEWEST`: posts by date in descending order.
|
|
2877
|
+
*
|
|
2878
|
+
* Default: `OLDEST`
|
|
2815
2879
|
*/
|
|
2816
|
-
|
|
2880
|
+
order?: OrderWithLiterals;
|
|
2881
|
+
/** Number of months to include in response. */
|
|
2882
|
+
months?: number;
|
|
2817
2883
|
/**
|
|
2818
|
-
*
|
|
2819
|
-
*
|
|
2884
|
+
* Language filter.
|
|
2885
|
+
*
|
|
2886
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2887
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
2888
|
+
* @format LANGUAGE_TAG
|
|
2820
2889
|
*/
|
|
2821
|
-
|
|
2890
|
+
language?: string | null;
|
|
2822
2891
|
/**
|
|
2823
|
-
*
|
|
2892
|
+
* Time zone to use when calculating the start of the month.
|
|
2893
|
+
*
|
|
2894
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2895
|
+
* @minLength 3
|
|
2824
2896
|
* @maxLength 100
|
|
2825
2897
|
*/
|
|
2826
|
-
|
|
2827
|
-
/** Post cover media. */
|
|
2828
|
-
media?: Media;
|
|
2829
|
-
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2830
|
-
previewTextParagraph?: number | null;
|
|
2898
|
+
timeZone?: string | null;
|
|
2831
2899
|
}
|
|
2832
|
-
declare enum
|
|
2900
|
+
declare enum Order {
|
|
2833
2901
|
UNKNOWN = "UNKNOWN",
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
/** Categories were changed */
|
|
2837
|
-
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
2838
|
-
/** Saved automatically */
|
|
2839
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
2840
|
-
/** Copied from template */
|
|
2841
|
-
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
2842
|
-
/** Imported */
|
|
2843
|
-
IMPORT = "IMPORT",
|
|
2844
|
-
/** Imported in bulk */
|
|
2845
|
-
IMPORT_BULK = "IMPORT_BULK",
|
|
2846
|
-
/** Imported with html import */
|
|
2847
|
-
IMPORT_HTML = "IMPORT_HTML",
|
|
2848
|
-
/** Patch import */
|
|
2849
|
-
IMPORT_PATCH = "IMPORT_PATCH",
|
|
2850
|
-
/** Changed language */
|
|
2851
|
-
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
2852
|
-
/** Saved manually */
|
|
2853
|
-
MANUAL_SAVE = "MANUAL_SAVE",
|
|
2854
|
-
/** Affected by migration */
|
|
2855
|
-
MIGRATION = "MIGRATION",
|
|
2856
|
-
/** Affected by moderation */
|
|
2857
|
-
MODERATION = "MODERATION",
|
|
2858
|
-
/** Moved to trash */
|
|
2859
|
-
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
2860
|
-
/** Pricing plans were changed */
|
|
2861
|
-
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
2862
|
-
/** Was provisioned */
|
|
2863
|
-
PROVISION = "PROVISION",
|
|
2864
|
-
/** Was published */
|
|
2865
|
-
PUBLISH = "PUBLISH",
|
|
2866
|
-
/** Owner was reassigned */
|
|
2867
|
-
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
2868
|
-
/** Was reblogged */
|
|
2869
|
-
REBLOG = "REBLOG",
|
|
2870
|
-
/** Was restored */
|
|
2871
|
-
RESTORE = "RESTORE",
|
|
2872
|
-
/** Reverted to draft */
|
|
2873
|
-
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
2874
|
-
/** Was translated */
|
|
2875
|
-
TRANSLATION = "TRANSLATION",
|
|
2876
|
-
/** Was unpublished */
|
|
2877
|
-
UNPUBLISH = "UNPUBLISH",
|
|
2878
|
-
/** Was unscheduled */
|
|
2879
|
-
UNSCHEDULE = "UNSCHEDULE",
|
|
2880
|
-
/** New edit session started which updated editing_session_id id */
|
|
2881
|
-
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
2882
|
-
/** Was scheduled by Later */
|
|
2883
|
-
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
2884
|
-
/** Was unscheduled by Later */
|
|
2885
|
-
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
2886
|
-
/** Was published by Later */
|
|
2887
|
-
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
2888
|
-
/** Was scheduled */
|
|
2889
|
-
SCHEDULE = "SCHEDULE",
|
|
2890
|
-
/** Was removed from moderation */
|
|
2891
|
-
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
2892
|
-
/** Was rejected from moderation */
|
|
2893
|
-
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
2894
|
-
/** Was approved in moderation */
|
|
2895
|
-
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
2896
|
-
/** Tag was deleted */
|
|
2897
|
-
DELETE_TAG = "DELETE_TAG",
|
|
2898
|
-
/** Post was pinned */
|
|
2899
|
-
PIN = "PIN",
|
|
2900
|
-
/** Post was unpinned */
|
|
2901
|
-
UNPIN = "UNPIN",
|
|
2902
|
-
/** Saved automatically by AI tool. */
|
|
2903
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2902
|
+
OLDEST = "OLDEST",
|
|
2903
|
+
NEWEST = "NEWEST"
|
|
2904
2904
|
}
|
|
2905
2905
|
/** @enumType */
|
|
2906
|
-
type
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
/**
|
|
2910
|
-
|
|
2911
|
-
/** Status indicating the draft post is unpublished. */
|
|
2912
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
2913
|
-
/** Status indicating the draft post is scheduled for publication. */
|
|
2914
|
-
SCHEDULED = "SCHEDULED",
|
|
2915
|
-
/** Status indicating the draft post is deleted. */
|
|
2916
|
-
DELETED = "DELETED",
|
|
2917
|
-
/** Status indicating the draft post is in review. */
|
|
2918
|
-
IN_REVIEW = "IN_REVIEW"
|
|
2906
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2907
|
+
/** Get Blog Post Count Stats response */
|
|
2908
|
+
interface QueryPostCountStatsResponse {
|
|
2909
|
+
/** List of published post counts by month. */
|
|
2910
|
+
stats?: PeriodPostCount[];
|
|
2919
2911
|
}
|
|
2920
|
-
/**
|
|
2921
|
-
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
/** Post status. */
|
|
2929
|
-
status?: StatusWithLiterals;
|
|
2912
|
+
/** Post count for a specific time period */
|
|
2913
|
+
interface PeriodPostCount {
|
|
2914
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2915
|
+
periodStart?: Date | null;
|
|
2916
|
+
/** Number of posts published during this month. */
|
|
2917
|
+
postCount?: number;
|
|
2918
|
+
}
|
|
2919
|
+
interface GetTotalPublicationsRequest {
|
|
2930
2920
|
/**
|
|
2931
|
-
* Language
|
|
2921
|
+
* Language filter
|
|
2922
|
+
* @minLength 2
|
|
2932
2923
|
* @format LANGUAGE_TAG
|
|
2933
2924
|
*/
|
|
2934
2925
|
language?: string | null;
|
|
2926
|
+
}
|
|
2927
|
+
interface GetTotalPublicationsResponse {
|
|
2928
|
+
/** Total amount of publications. */
|
|
2929
|
+
total?: number;
|
|
2930
|
+
}
|
|
2931
|
+
interface GetTotalPostsRequest {
|
|
2935
2932
|
/**
|
|
2936
|
-
*
|
|
2937
|
-
*
|
|
2933
|
+
* Language filter.
|
|
2934
|
+
*
|
|
2935
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2936
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
2937
|
+
* @format LANGUAGE_TAG
|
|
2938
2938
|
*/
|
|
2939
|
-
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
/**
|
|
2943
|
-
|
|
2939
|
+
language?: string | null;
|
|
2940
|
+
}
|
|
2941
|
+
interface GetTotalPostsResponse {
|
|
2942
|
+
/** Total amount of published posts. */
|
|
2943
|
+
total?: number;
|
|
2944
2944
|
}
|
|
2945
2945
|
interface GetTotalLikesPerMemberRequest {
|
|
2946
2946
|
/**
|
|
@@ -3659,6 +3659,15 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
3659
3659
|
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3660
3660
|
*/
|
|
3661
3661
|
entityEventSequence?: string | null;
|
|
3662
|
+
accountInfo?: AccountInfoMetadata;
|
|
3663
|
+
}
|
|
3664
|
+
interface AccountInfoMetadata {
|
|
3665
|
+
/** ID of the Wix account associated with the event */
|
|
3666
|
+
accountId: string;
|
|
3667
|
+
/** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
|
|
3668
|
+
siteId?: string;
|
|
3669
|
+
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
3670
|
+
parentAccountId?: string;
|
|
3662
3671
|
}
|
|
3663
3672
|
interface PostLikedEnvelope {
|
|
3664
3673
|
data: PostLiked;
|
|
@@ -3752,14 +3761,13 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3752
3761
|
/**
|
|
3753
3762
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3754
3763
|
*
|
|
3755
|
-
*
|
|
3756
|
-
* The
|
|
3757
|
-
*
|
|
3758
|
-
*
|
|
3759
|
-
*
|
|
3760
|
-
*
|
|
3764
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
|
3765
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
|
3766
|
+
* includes the number of `months` following `rangeStart`.
|
|
3767
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3768
|
+
* the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
|
|
3769
|
+
* > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
3761
3770
|
* @public
|
|
3762
|
-
* @param options - Options specifying time frame, sort, and filter.
|
|
3763
3771
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3764
3772
|
* @applicableIdentity APP
|
|
3765
3773
|
* @returns Get Blog Post Count Stats response
|
|
@@ -3800,7 +3808,6 @@ interface QueryPostCountStatsOptions {
|
|
|
3800
3808
|
/**
|
|
3801
3809
|
* Retrieves the total amount of published posts of the blog.
|
|
3802
3810
|
* @public
|
|
3803
|
-
* @param options - Language Options.
|
|
3804
3811
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3805
3812
|
* @applicableIdentity APP
|
|
3806
3813
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -3821,12 +3828,12 @@ interface GetTotalPostsOptions {
|
|
|
3821
3828
|
* @param postId - Post ID.
|
|
3822
3829
|
* @public
|
|
3823
3830
|
* @requiredField postId
|
|
3824
|
-
* @param options - Options specifying which fields to return.
|
|
3825
3831
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3826
3832
|
* @applicableIdentity APP
|
|
3833
|
+
* @returns Retrieved post info.
|
|
3827
3834
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3828
3835
|
*/
|
|
3829
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
3836
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
|
|
3830
3837
|
interface GetPostOptions {
|
|
3831
3838
|
/**
|
|
3832
3839
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3846,7 +3853,6 @@ interface GetPostOptions {
|
|
|
3846
3853
|
* @param slug - Slug of the post to retrieve.
|
|
3847
3854
|
* @public
|
|
3848
3855
|
* @requiredField slug
|
|
3849
|
-
* @param options - Options specifying which fields to return.
|
|
3850
3856
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3851
3857
|
* @applicableIdentity APP
|
|
3852
3858
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -3874,7 +3880,6 @@ interface GetPostBySlugOptions {
|
|
|
3874
3880
|
* - `paging.limit` is `50`.
|
|
3875
3881
|
* - `paging.offset` is `0`.
|
|
3876
3882
|
* @public
|
|
3877
|
-
* @param options - Sort, filter, and paging options.
|
|
3878
3883
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3879
3884
|
* @applicableIdentity APP
|
|
3880
3885
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -3945,26 +3950,23 @@ interface ListPostsOptions {
|
|
|
3945
3950
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3946
3951
|
}
|
|
3947
3952
|
/**
|
|
3948
|
-
*
|
|
3953
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
|
3949
3954
|
*
|
|
3955
|
+
* Query Posts runs with these defaults, which you can override:
|
|
3956
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
3957
|
+
* - `paging.limit` is `50`.
|
|
3958
|
+
* - `paging.offset` is `0`.
|
|
3950
3959
|
*
|
|
3951
|
-
*
|
|
3952
|
-
*
|
|
3953
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
3954
|
-
*
|
|
3955
|
-
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
3956
|
-
*
|
|
3957
|
-
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
3958
|
-
* + `limit(50)`
|
|
3959
|
-
* + `descending('firstPublishedDate')`
|
|
3960
|
-
*
|
|
3961
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
3962
|
-
*
|
|
3963
|
-
* To learn how to query posts, refer to the table below.
|
|
3960
|
+
* For field support for filters and sorting, see
|
|
3961
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
|
3964
3962
|
*
|
|
3965
|
-
*
|
|
3963
|
+
* To learn about working with _Query_ endpoints, see
|
|
3964
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
3965
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
|
3966
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
3967
|
+
* For a detailed list of supported filters and sortable fields, see
|
|
3968
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
|
3966
3969
|
* @public
|
|
3967
|
-
* @param options - Options specifying which fields to return.
|
|
3968
3970
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3969
3971
|
* @applicableIdentity APP
|
|
3970
3972
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|