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