@wix/auto_sdk_blog_posts 1.0.129 → 1.0.131
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 +50 -32
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +559 -530
- package/build/cjs/index.typings.js +40 -27
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +374 -360
- package/build/cjs/meta.js +31 -20
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +15 -11
- package/build/es/index.mjs +49 -32
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +559 -530
- package/build/es/index.typings.mjs +39 -27
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +374 -360
- package/build/es/meta.mjs +30 -20
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +15 -11
- package/build/internal/cjs/index.js +50 -32
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +559 -530
- package/build/internal/cjs/index.typings.js +40 -27
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +374 -360
- package/build/internal/cjs/meta.js +31 -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 +49 -32
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +559 -530
- package/build/internal/es/index.typings.mjs +39 -27
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +374 -360
- package/build/internal/es/meta.mjs +30 -20
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -2018,6 +2018,8 @@ interface LayoutData {
|
|
|
2018
2018
|
containerData?: PluginContainerData;
|
|
2019
2019
|
/** Defines where selected design propertied applies to */
|
|
2020
2020
|
designTarget?: DesignTargetWithLiterals;
|
|
2021
|
+
/** Banner configuration. When present, this layout is displayed as a banner. */
|
|
2022
|
+
banner?: Banner;
|
|
2021
2023
|
}
|
|
2022
2024
|
declare enum Scaling {
|
|
2023
2025
|
/** Auto image scaling */
|
|
@@ -2051,6 +2053,14 @@ declare enum ImagePosition {
|
|
|
2051
2053
|
}
|
|
2052
2054
|
/** @enumType */
|
|
2053
2055
|
type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
2056
|
+
declare enum BannerOrigin {
|
|
2057
|
+
/** Banner originated from an image */
|
|
2058
|
+
IMAGE = "IMAGE",
|
|
2059
|
+
/** Banner originated from a layout */
|
|
2060
|
+
LAYOUT = "LAYOUT"
|
|
2061
|
+
}
|
|
2062
|
+
/** @enumType */
|
|
2063
|
+
type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
|
|
2054
2064
|
interface BackgroundImage {
|
|
2055
2065
|
/** Background image. */
|
|
2056
2066
|
media?: V1Media;
|
|
@@ -2087,6 +2097,10 @@ declare enum DesignTarget {
|
|
|
2087
2097
|
}
|
|
2088
2098
|
/** @enumType */
|
|
2089
2099
|
type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
|
|
2100
|
+
interface Banner {
|
|
2101
|
+
/** Origin of the banner */
|
|
2102
|
+
origin?: BannerOriginWithLiterals;
|
|
2103
|
+
}
|
|
2090
2104
|
interface LayoutCellData {
|
|
2091
2105
|
/** Size of the cell in 12 columns grid. */
|
|
2092
2106
|
colSpan?: number | null;
|
|
@@ -2375,135 +2389,408 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2375
2389
|
*/
|
|
2376
2390
|
anonymousVisitorId?: string | null;
|
|
2377
2391
|
}
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2392
|
+
/** Get Blog Publications Count Stats request */
|
|
2393
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2394
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2395
|
+
rangeStart?: Date | null;
|
|
2396
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2397
|
+
rangeEnd?: Date | null;
|
|
2398
|
+
/** Order of the returned results. */
|
|
2399
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2400
|
+
/** Number of months to include in the response. */
|
|
2401
|
+
months?: number;
|
|
2385
2402
|
/**
|
|
2386
|
-
*
|
|
2403
|
+
* Language filter
|
|
2404
|
+
*
|
|
2405
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2387
2406
|
* @format LANGUAGE_TAG
|
|
2388
2407
|
*/
|
|
2389
2408
|
language?: string | null;
|
|
2390
|
-
/**
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2409
|
+
/**
|
|
2410
|
+
* Timezone of the client.
|
|
2411
|
+
* @minLength 3
|
|
2412
|
+
* @maxLength 100
|
|
2413
|
+
*/
|
|
2414
|
+
timeZone?: string | null;
|
|
2396
2415
|
}
|
|
2397
|
-
declare enum
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2416
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2417
|
+
UNKNOWN = "UNKNOWN",
|
|
2418
|
+
OLDEST = "OLDEST",
|
|
2419
|
+
NEWEST = "NEWEST"
|
|
2402
2420
|
}
|
|
2403
2421
|
/** @enumType */
|
|
2404
|
-
type
|
|
2405
|
-
|
|
2422
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2423
|
+
/** Get Blog Publications Count Stats response */
|
|
2424
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2425
|
+
/** Chronologically ordered list of publications. */
|
|
2426
|
+
stats?: PeriodPublicationsCount[];
|
|
2427
|
+
}
|
|
2428
|
+
/** Publications count for a specific time period */
|
|
2429
|
+
interface PeriodPublicationsCount {
|
|
2430
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2431
|
+
periodStart?: Date | null;
|
|
2432
|
+
/** Number of posts published during this month. */
|
|
2433
|
+
publicationsCount?: number;
|
|
2434
|
+
}
|
|
2435
|
+
/** Get Blog Post Count Stats request */
|
|
2436
|
+
interface QueryPostCountStatsRequest {
|
|
2437
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2438
|
+
rangeStart?: Date | null;
|
|
2406
2439
|
/**
|
|
2407
|
-
*
|
|
2440
|
+
* Order of returned results.
|
|
2408
2441
|
*
|
|
2442
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
2443
|
+
* - `NEWEST`: posts by date in descending order.
|
|
2409
2444
|
*
|
|
2410
|
-
* Default: `
|
|
2445
|
+
* Default: `OLDEST`
|
|
2411
2446
|
*/
|
|
2412
|
-
|
|
2447
|
+
order?: OrderWithLiterals;
|
|
2448
|
+
/** Number of months to include in response. */
|
|
2449
|
+
months?: number;
|
|
2413
2450
|
/**
|
|
2414
|
-
*
|
|
2415
|
-
*
|
|
2451
|
+
* Language filter.
|
|
2416
2452
|
*
|
|
2417
|
-
*
|
|
2418
|
-
*
|
|
2419
|
-
* @
|
|
2453
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2454
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
2455
|
+
* @format LANGUAGE_TAG
|
|
2420
2456
|
*/
|
|
2421
|
-
|
|
2457
|
+
language?: string | null;
|
|
2422
2458
|
/**
|
|
2423
|
-
*
|
|
2424
|
-
*
|
|
2459
|
+
* Time zone to use when calculating the start of the month.
|
|
2460
|
+
*
|
|
2461
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2462
|
+
* @minLength 3
|
|
2463
|
+
* @maxLength 100
|
|
2425
2464
|
*/
|
|
2426
|
-
|
|
2465
|
+
timeZone?: string | null;
|
|
2427
2466
|
}
|
|
2428
|
-
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
postTemplatesMetaData?: MetaData;
|
|
2433
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2434
|
-
templateCategories?: Category[];
|
|
2467
|
+
declare enum Order {
|
|
2468
|
+
UNKNOWN = "UNKNOWN",
|
|
2469
|
+
OLDEST = "OLDEST",
|
|
2470
|
+
NEWEST = "NEWEST"
|
|
2435
2471
|
}
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
|
|
2442
|
-
|
|
2472
|
+
/** @enumType */
|
|
2473
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2474
|
+
/** Get Blog Post Count Stats response */
|
|
2475
|
+
interface QueryPostCountStatsResponse {
|
|
2476
|
+
/** List of published post counts by month. */
|
|
2477
|
+
stats?: PeriodPostCount[];
|
|
2478
|
+
}
|
|
2479
|
+
/** Post count for a specific time period */
|
|
2480
|
+
interface PeriodPostCount {
|
|
2481
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2482
|
+
periodStart?: Date | null;
|
|
2483
|
+
/** Number of posts published during this month. */
|
|
2484
|
+
postCount?: number;
|
|
2485
|
+
}
|
|
2486
|
+
interface GetTotalPublicationsRequest {
|
|
2443
2487
|
/**
|
|
2444
|
-
*
|
|
2445
|
-
* @
|
|
2488
|
+
* Language filter
|
|
2489
|
+
* @minLength 2
|
|
2490
|
+
* @format LANGUAGE_TAG
|
|
2446
2491
|
*/
|
|
2447
|
-
|
|
2492
|
+
language?: string | null;
|
|
2448
2493
|
}
|
|
2449
|
-
interface
|
|
2494
|
+
interface GetTotalPublicationsResponse {
|
|
2495
|
+
/** Total amount of publications. */
|
|
2496
|
+
total?: number;
|
|
2497
|
+
}
|
|
2498
|
+
interface GetTotalPostsRequest {
|
|
2450
2499
|
/**
|
|
2451
|
-
*
|
|
2452
|
-
*
|
|
2453
|
-
*
|
|
2500
|
+
* Language filter.
|
|
2501
|
+
*
|
|
2502
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2503
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
2504
|
+
* @format LANGUAGE_TAG
|
|
2454
2505
|
*/
|
|
2506
|
+
language?: string | null;
|
|
2507
|
+
}
|
|
2508
|
+
interface GetTotalPostsResponse {
|
|
2509
|
+
/** Total amount of published posts. */
|
|
2510
|
+
total?: number;
|
|
2511
|
+
}
|
|
2512
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2513
|
+
createdEvent?: EntityCreatedEvent;
|
|
2514
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2515
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2516
|
+
actionEvent?: ActionEvent;
|
|
2517
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2455
2518
|
_id?: string;
|
|
2456
2519
|
/**
|
|
2457
|
-
*
|
|
2458
|
-
*
|
|
2459
|
-
*/
|
|
2460
|
-
label?: string;
|
|
2461
|
-
/**
|
|
2462
|
-
* Number of posts in the category.
|
|
2463
|
-
* @readonly
|
|
2520
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2521
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2464
2522
|
*/
|
|
2465
|
-
|
|
2523
|
+
entityFqdn?: string;
|
|
2466
2524
|
/**
|
|
2467
|
-
*
|
|
2468
|
-
*
|
|
2525
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2526
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2469
2527
|
*/
|
|
2470
|
-
|
|
2528
|
+
slug?: string;
|
|
2529
|
+
/** ID of the entity associated with the event. */
|
|
2530
|
+
entityId?: string;
|
|
2531
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2532
|
+
eventTime?: Date | null;
|
|
2471
2533
|
/**
|
|
2472
|
-
*
|
|
2473
|
-
*
|
|
2534
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2535
|
+
* (for example, GDPR).
|
|
2474
2536
|
*/
|
|
2475
|
-
|
|
2537
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2538
|
+
/** If present, indicates the action that triggered the event. */
|
|
2539
|
+
originatedFrom?: string | null;
|
|
2476
2540
|
/**
|
|
2477
|
-
*
|
|
2478
|
-
*
|
|
2479
|
-
* @deprecated Category title.
|
|
2480
|
-
* @targetRemovalDate 2025-07-16
|
|
2541
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
2542
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2481
2543
|
*/
|
|
2482
|
-
|
|
2544
|
+
entityEventSequence?: string | null;
|
|
2545
|
+
}
|
|
2546
|
+
/** @oneof */
|
|
2547
|
+
interface DomainEventBodyOneOf {
|
|
2548
|
+
createdEvent?: EntityCreatedEvent;
|
|
2549
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2550
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2551
|
+
actionEvent?: ActionEvent;
|
|
2552
|
+
}
|
|
2553
|
+
interface EntityCreatedEvent {
|
|
2554
|
+
entity?: string;
|
|
2555
|
+
}
|
|
2556
|
+
interface RestoreInfo {
|
|
2557
|
+
deletedDate?: Date | null;
|
|
2558
|
+
}
|
|
2559
|
+
interface EntityUpdatedEvent {
|
|
2483
2560
|
/**
|
|
2484
|
-
*
|
|
2485
|
-
*
|
|
2486
|
-
*
|
|
2487
|
-
* Default: `-1`
|
|
2561
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2562
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2563
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2488
2564
|
*/
|
|
2489
|
-
|
|
2565
|
+
currentEntity?: string;
|
|
2566
|
+
}
|
|
2567
|
+
interface EntityDeletedEvent {
|
|
2568
|
+
/** Entity that was deleted. */
|
|
2569
|
+
deletedEntity?: string | null;
|
|
2570
|
+
}
|
|
2571
|
+
interface ActionEvent {
|
|
2572
|
+
body?: string;
|
|
2573
|
+
}
|
|
2574
|
+
interface MessageEnvelope {
|
|
2490
2575
|
/**
|
|
2491
|
-
*
|
|
2576
|
+
* App instance ID.
|
|
2492
2577
|
* @format GUID
|
|
2493
2578
|
*/
|
|
2494
|
-
|
|
2579
|
+
instanceId?: string | null;
|
|
2495
2580
|
/**
|
|
2496
|
-
*
|
|
2497
|
-
*
|
|
2498
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2499
|
-
* @immutable
|
|
2581
|
+
* Event type.
|
|
2582
|
+
* @maxLength 150
|
|
2500
2583
|
*/
|
|
2501
|
-
|
|
2584
|
+
eventType?: string;
|
|
2585
|
+
/** The identification type and identity data. */
|
|
2586
|
+
identity?: IdentificationData;
|
|
2587
|
+
/** Stringify payload. */
|
|
2588
|
+
data?: string;
|
|
2589
|
+
/** Details related to the account */
|
|
2590
|
+
accountInfo?: AccountInfo;
|
|
2591
|
+
}
|
|
2592
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2502
2593
|
/**
|
|
2503
|
-
*
|
|
2504
|
-
* @
|
|
2594
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2595
|
+
* @format GUID
|
|
2505
2596
|
*/
|
|
2506
|
-
|
|
2597
|
+
anonymousVisitorId?: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* ID of a site visitor that has logged in to the site.
|
|
2600
|
+
* @format GUID
|
|
2601
|
+
*/
|
|
2602
|
+
memberId?: string;
|
|
2603
|
+
/**
|
|
2604
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2605
|
+
* @format GUID
|
|
2606
|
+
*/
|
|
2607
|
+
wixUserId?: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* ID of an app.
|
|
2610
|
+
* @format GUID
|
|
2611
|
+
*/
|
|
2612
|
+
appId?: string;
|
|
2613
|
+
/** @readonly */
|
|
2614
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2615
|
+
}
|
|
2616
|
+
/** @oneof */
|
|
2617
|
+
interface IdentificationDataIdOneOf {
|
|
2618
|
+
/**
|
|
2619
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2620
|
+
* @format GUID
|
|
2621
|
+
*/
|
|
2622
|
+
anonymousVisitorId?: string;
|
|
2623
|
+
/**
|
|
2624
|
+
* ID of a site visitor that has logged in to the site.
|
|
2625
|
+
* @format GUID
|
|
2626
|
+
*/
|
|
2627
|
+
memberId?: string;
|
|
2628
|
+
/**
|
|
2629
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2630
|
+
* @format GUID
|
|
2631
|
+
*/
|
|
2632
|
+
wixUserId?: string;
|
|
2633
|
+
/**
|
|
2634
|
+
* ID of an app.
|
|
2635
|
+
* @format GUID
|
|
2636
|
+
*/
|
|
2637
|
+
appId?: string;
|
|
2638
|
+
}
|
|
2639
|
+
declare enum WebhookIdentityType {
|
|
2640
|
+
UNKNOWN = "UNKNOWN",
|
|
2641
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2642
|
+
MEMBER = "MEMBER",
|
|
2643
|
+
WIX_USER = "WIX_USER",
|
|
2644
|
+
APP = "APP"
|
|
2645
|
+
}
|
|
2646
|
+
/** @enumType */
|
|
2647
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2648
|
+
interface AccountInfo {
|
|
2649
|
+
/**
|
|
2650
|
+
* ID of the Wix account associated with the event.
|
|
2651
|
+
* @format GUID
|
|
2652
|
+
*/
|
|
2653
|
+
accountId?: string | null;
|
|
2654
|
+
/**
|
|
2655
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2656
|
+
* @format GUID
|
|
2657
|
+
*/
|
|
2658
|
+
parentAccountId?: string | null;
|
|
2659
|
+
/**
|
|
2660
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2661
|
+
* @format GUID
|
|
2662
|
+
*/
|
|
2663
|
+
siteId?: string | null;
|
|
2664
|
+
}
|
|
2665
|
+
interface ListTemplatesRequest {
|
|
2666
|
+
/**
|
|
2667
|
+
* Filter post templates by given template category ids
|
|
2668
|
+
* @maxSize 50
|
|
2669
|
+
* @format GUID
|
|
2670
|
+
*/
|
|
2671
|
+
categoryIds?: string[];
|
|
2672
|
+
/**
|
|
2673
|
+
* Filter post templates by provided language
|
|
2674
|
+
* @format LANGUAGE_TAG
|
|
2675
|
+
*/
|
|
2676
|
+
language?: string | null;
|
|
2677
|
+
/** Returns post template categories when set to TRUE */
|
|
2678
|
+
listTemplateCategories?: boolean;
|
|
2679
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2680
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2681
|
+
/** Pagination options. */
|
|
2682
|
+
paging?: BlogPaging;
|
|
2683
|
+
}
|
|
2684
|
+
declare enum GetPostTemplatesSort {
|
|
2685
|
+
/** Sort by ascending publishing date. */
|
|
2686
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2687
|
+
/** Sort by descending publishing date. */
|
|
2688
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2689
|
+
}
|
|
2690
|
+
/** @enumType */
|
|
2691
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2692
|
+
interface BlogPaging {
|
|
2693
|
+
/**
|
|
2694
|
+
* Number of items to skip in the current sort order.
|
|
2695
|
+
*
|
|
2696
|
+
*
|
|
2697
|
+
* Default: `0`
|
|
2698
|
+
*/
|
|
2699
|
+
offset?: number;
|
|
2700
|
+
/**
|
|
2701
|
+
* Number of items to return.
|
|
2702
|
+
*
|
|
2703
|
+
*
|
|
2704
|
+
* Default:`50`
|
|
2705
|
+
* @min 1
|
|
2706
|
+
* @max 100
|
|
2707
|
+
*/
|
|
2708
|
+
limit?: number;
|
|
2709
|
+
/**
|
|
2710
|
+
* Pointer to the next or previous page in the list of results.
|
|
2711
|
+
* @maxLength 2000
|
|
2712
|
+
*/
|
|
2713
|
+
cursor?: string | null;
|
|
2714
|
+
}
|
|
2715
|
+
interface ListTemplatesResponse {
|
|
2716
|
+
/** Available post templates */
|
|
2717
|
+
postTemplates?: Post[];
|
|
2718
|
+
/** Details on the paged set of posts templates returned. */
|
|
2719
|
+
postTemplatesMetaData?: MetaData;
|
|
2720
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2721
|
+
templateCategories?: Category[];
|
|
2722
|
+
}
|
|
2723
|
+
interface MetaData {
|
|
2724
|
+
/** Number of items returned in this response. */
|
|
2725
|
+
count?: number;
|
|
2726
|
+
/** Requested offset. */
|
|
2727
|
+
offset?: number;
|
|
2728
|
+
/** Total number of items that match the query. */
|
|
2729
|
+
total?: number;
|
|
2730
|
+
/**
|
|
2731
|
+
* Pointer to the next or previous page in the list of results.
|
|
2732
|
+
* @maxLength 2000
|
|
2733
|
+
*/
|
|
2734
|
+
cursor?: string | null;
|
|
2735
|
+
}
|
|
2736
|
+
interface Category {
|
|
2737
|
+
/**
|
|
2738
|
+
* Category ID.
|
|
2739
|
+
* @immutable
|
|
2740
|
+
* @maxLength 38
|
|
2741
|
+
*/
|
|
2742
|
+
_id?: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* Category label. Displayed in the Category Menu.
|
|
2745
|
+
* @maxLength 35
|
|
2746
|
+
*/
|
|
2747
|
+
label?: string;
|
|
2748
|
+
/**
|
|
2749
|
+
* Number of posts in the category.
|
|
2750
|
+
* @readonly
|
|
2751
|
+
*/
|
|
2752
|
+
postCount?: number;
|
|
2753
|
+
/**
|
|
2754
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2755
|
+
* @readonly
|
|
2756
|
+
*/
|
|
2757
|
+
url?: string;
|
|
2758
|
+
/**
|
|
2759
|
+
* Category description.
|
|
2760
|
+
* @maxLength 500
|
|
2761
|
+
*/
|
|
2762
|
+
description?: string | null;
|
|
2763
|
+
/**
|
|
2764
|
+
* Category title.
|
|
2765
|
+
* @maxLength 200
|
|
2766
|
+
* @deprecated Category title.
|
|
2767
|
+
* @targetRemovalDate 2025-07-16
|
|
2768
|
+
*/
|
|
2769
|
+
title?: string;
|
|
2770
|
+
/**
|
|
2771
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2772
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2773
|
+
*
|
|
2774
|
+
* Default: `-1`
|
|
2775
|
+
*/
|
|
2776
|
+
displayPosition?: number | null;
|
|
2777
|
+
/**
|
|
2778
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2779
|
+
* @format GUID
|
|
2780
|
+
*/
|
|
2781
|
+
translationId?: string | null;
|
|
2782
|
+
/**
|
|
2783
|
+
* Category language.
|
|
2784
|
+
*
|
|
2785
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2786
|
+
* @immutable
|
|
2787
|
+
*/
|
|
2788
|
+
language?: string | null;
|
|
2789
|
+
/**
|
|
2790
|
+
* 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`.
|
|
2791
|
+
* @maxLength 100
|
|
2792
|
+
*/
|
|
2793
|
+
slug?: string;
|
|
2507
2794
|
/** SEO data. */
|
|
2508
2795
|
seoData?: SeoSchema;
|
|
2509
2796
|
/** Category cover image. */
|
|
@@ -2628,453 +2915,180 @@ interface DraftPost {
|
|
|
2628
2915
|
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
2629
2916
|
* @format GUID
|
|
2630
2917
|
*/
|
|
2631
|
-
translationId?: string | null;
|
|
2632
|
-
/**
|
|
2633
|
-
* Language the draft post is written in.
|
|
2634
|
-
*
|
|
2635
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2636
|
-
* @format LANGUAGE_TAG
|
|
2637
|
-
*/
|
|
2638
|
-
language?: string | null;
|
|
2639
|
-
/**
|
|
2640
|
-
* Draft Post rich content.
|
|
2641
|
-
*
|
|
2642
|
-
* <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">
|
|
2643
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2644
|
-
* </widget>
|
|
2645
|
-
*/
|
|
2646
|
-
richContent?: RichContent;
|
|
2647
|
-
/**
|
|
2648
|
-
* Status of the draft post.
|
|
2649
|
-
* @readonly
|
|
2650
|
-
*/
|
|
2651
|
-
status?: StatusWithLiterals;
|
|
2652
|
-
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
2653
|
-
moderationDetails?: ModerationDetails;
|
|
2654
|
-
/**
|
|
2655
|
-
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
2656
|
-
* @readonly
|
|
2657
|
-
*/
|
|
2658
|
-
hasUnpublishedChanges?: boolean;
|
|
2659
|
-
/**
|
|
2660
|
-
* Date the draft post was last edited.
|
|
2661
|
-
* @readonly
|
|
2662
|
-
*/
|
|
2663
|
-
editedDate?: Date | null;
|
|
2664
|
-
/**
|
|
2665
|
-
* Date the draft post is scheduled to be published.
|
|
2666
|
-
* @readonly
|
|
2667
|
-
*/
|
|
2668
|
-
scheduledPublishDate?: Date | null;
|
|
2669
|
-
/** Date the post was first published. */
|
|
2670
|
-
firstPublishedDate?: Date | null;
|
|
2671
|
-
/** SEO data. */
|
|
2672
|
-
seoData?: SeoSchema;
|
|
2673
|
-
/**
|
|
2674
|
-
* Draft post URL preview. What the URL will look like once the post is published.
|
|
2675
|
-
* @readonly
|
|
2676
|
-
*/
|
|
2677
|
-
url?: string;
|
|
2678
|
-
/**
|
|
2679
|
-
* Date the draft post was first created.
|
|
2680
|
-
* @readonly
|
|
2681
|
-
*/
|
|
2682
|
-
_createdDate?: Date | null;
|
|
2683
|
-
/**
|
|
2684
|
-
* SEO slug.
|
|
2685
|
-
* @maxLength 100
|
|
2686
|
-
*/
|
|
2687
|
-
seoSlug?: string | null;
|
|
2688
|
-
/** Post cover media. */
|
|
2689
|
-
media?: Media;
|
|
2690
|
-
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2691
|
-
previewTextParagraph?: number | null;
|
|
2692
|
-
}
|
|
2693
|
-
declare enum Origin {
|
|
2694
|
-
UNKNOWN = "UNKNOWN",
|
|
2695
|
-
/** Changed by admin */
|
|
2696
|
-
ADMIN = "ADMIN",
|
|
2697
|
-
/** Categories were changed */
|
|
2698
|
-
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
2699
|
-
/** Saved automatically */
|
|
2700
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
2701
|
-
/** Copied from template */
|
|
2702
|
-
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
2703
|
-
/** Imported */
|
|
2704
|
-
IMPORT = "IMPORT",
|
|
2705
|
-
/** Imported in bulk */
|
|
2706
|
-
IMPORT_BULK = "IMPORT_BULK",
|
|
2707
|
-
/** Imported with html import */
|
|
2708
|
-
IMPORT_HTML = "IMPORT_HTML",
|
|
2709
|
-
/** Patch import */
|
|
2710
|
-
IMPORT_PATCH = "IMPORT_PATCH",
|
|
2711
|
-
/** Changed language */
|
|
2712
|
-
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
2713
|
-
/** Saved manually */
|
|
2714
|
-
MANUAL_SAVE = "MANUAL_SAVE",
|
|
2715
|
-
/** Affected by migration */
|
|
2716
|
-
MIGRATION = "MIGRATION",
|
|
2717
|
-
/** Affected by moderation */
|
|
2718
|
-
MODERATION = "MODERATION",
|
|
2719
|
-
/** Moved to trash */
|
|
2720
|
-
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
2721
|
-
/** Pricing plans were changed */
|
|
2722
|
-
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
2723
|
-
/** Was provisioned */
|
|
2724
|
-
PROVISION = "PROVISION",
|
|
2725
|
-
/** Was published */
|
|
2726
|
-
PUBLISH = "PUBLISH",
|
|
2727
|
-
/** Owner was reassigned */
|
|
2728
|
-
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
2729
|
-
/** Was reblogged */
|
|
2730
|
-
REBLOG = "REBLOG",
|
|
2731
|
-
/** Was restored */
|
|
2732
|
-
RESTORE = "RESTORE",
|
|
2733
|
-
/** Reverted to draft */
|
|
2734
|
-
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
2735
|
-
/** Was translated */
|
|
2736
|
-
TRANSLATION = "TRANSLATION",
|
|
2737
|
-
/** Was unpublished */
|
|
2738
|
-
UNPUBLISH = "UNPUBLISH",
|
|
2739
|
-
/** Was unscheduled */
|
|
2740
|
-
UNSCHEDULE = "UNSCHEDULE",
|
|
2741
|
-
/** New edit session started which updated editing_session_id id */
|
|
2742
|
-
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
2743
|
-
/** Was scheduled by Later */
|
|
2744
|
-
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
2745
|
-
/** Was unscheduled by Later */
|
|
2746
|
-
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
2747
|
-
/** Was published by Later */
|
|
2748
|
-
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
2749
|
-
/** Was scheduled */
|
|
2750
|
-
SCHEDULE = "SCHEDULE",
|
|
2751
|
-
/** Was removed from moderation */
|
|
2752
|
-
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
2753
|
-
/** Was rejected from moderation */
|
|
2754
|
-
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
2755
|
-
/** Was approved in moderation */
|
|
2756
|
-
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
2757
|
-
/** Tag was deleted */
|
|
2758
|
-
DELETE_TAG = "DELETE_TAG",
|
|
2759
|
-
/** Post was pinned */
|
|
2760
|
-
PIN = "PIN",
|
|
2761
|
-
/** Post was unpinned */
|
|
2762
|
-
UNPIN = "UNPIN",
|
|
2763
|
-
/** Saved automatically by AI tool. */
|
|
2764
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2765
|
-
}
|
|
2766
|
-
/** @enumType */
|
|
2767
|
-
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';
|
|
2768
|
-
declare enum Status {
|
|
2769
|
-
UNKNOWN = "UNKNOWN",
|
|
2770
|
-
/** Status indicating the draft post is published. */
|
|
2771
|
-
PUBLISHED = "PUBLISHED",
|
|
2772
|
-
/** Status indicating the draft post is unpublished. */
|
|
2773
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
2774
|
-
/** Status indicating the draft post is scheduled for publication. */
|
|
2775
|
-
SCHEDULED = "SCHEDULED",
|
|
2776
|
-
/** Status indicating the draft post is deleted. */
|
|
2777
|
-
DELETED = "DELETED",
|
|
2778
|
-
/** Status indicating the draft post is in review. */
|
|
2779
|
-
IN_REVIEW = "IN_REVIEW"
|
|
2780
|
-
}
|
|
2781
|
-
/** @enumType */
|
|
2782
|
-
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
2783
|
-
interface DraftPostTranslation {
|
|
2784
|
-
/**
|
|
2785
|
-
* Post ID.
|
|
2786
|
-
* @format GUID
|
|
2787
|
-
*/
|
|
2788
|
-
_id?: string;
|
|
2789
|
-
/** Post status. */
|
|
2790
|
-
status?: StatusWithLiterals;
|
|
2791
|
-
/**
|
|
2792
|
-
* Language the post is written in.
|
|
2793
|
-
* @format LANGUAGE_TAG
|
|
2794
|
-
*/
|
|
2795
|
-
language?: string | null;
|
|
2796
|
-
/**
|
|
2797
|
-
* Post slug. For example, 'post-slug'.
|
|
2798
|
-
* @maxLength 100
|
|
2799
|
-
*/
|
|
2800
|
-
slug?: string | null;
|
|
2801
|
-
/** SEO data. */
|
|
2802
|
-
seoData?: SeoSchema;
|
|
2803
|
-
/** Post URL. */
|
|
2804
|
-
url?: string;
|
|
2805
|
-
}
|
|
2806
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2807
|
-
createdEvent?: EntityCreatedEvent;
|
|
2808
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2809
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2810
|
-
actionEvent?: ActionEvent;
|
|
2811
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2812
|
-
_id?: string;
|
|
2813
|
-
/**
|
|
2814
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2815
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2816
|
-
*/
|
|
2817
|
-
entityFqdn?: string;
|
|
2818
|
-
/**
|
|
2819
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2820
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2821
|
-
*/
|
|
2822
|
-
slug?: string;
|
|
2823
|
-
/** ID of the entity associated with the event. */
|
|
2824
|
-
entityId?: string;
|
|
2825
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2826
|
-
eventTime?: Date | null;
|
|
2827
|
-
/**
|
|
2828
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2829
|
-
* (for example, GDPR).
|
|
2830
|
-
*/
|
|
2831
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2832
|
-
/** If present, indicates the action that triggered the event. */
|
|
2833
|
-
originatedFrom?: string | null;
|
|
2834
|
-
/**
|
|
2835
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
2836
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2837
|
-
*/
|
|
2838
|
-
entityEventSequence?: string | null;
|
|
2839
|
-
}
|
|
2840
|
-
/** @oneof */
|
|
2841
|
-
interface DomainEventBodyOneOf {
|
|
2842
|
-
createdEvent?: EntityCreatedEvent;
|
|
2843
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2844
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2845
|
-
actionEvent?: ActionEvent;
|
|
2846
|
-
}
|
|
2847
|
-
interface EntityCreatedEvent {
|
|
2848
|
-
entity?: string;
|
|
2849
|
-
}
|
|
2850
|
-
interface RestoreInfo {
|
|
2851
|
-
deletedDate?: Date | null;
|
|
2852
|
-
}
|
|
2853
|
-
interface EntityUpdatedEvent {
|
|
2854
|
-
/**
|
|
2855
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2856
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2857
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2858
|
-
*/
|
|
2859
|
-
currentEntity?: string;
|
|
2860
|
-
}
|
|
2861
|
-
interface EntityDeletedEvent {
|
|
2862
|
-
/** Entity that was deleted. */
|
|
2863
|
-
deletedEntity?: string | null;
|
|
2864
|
-
}
|
|
2865
|
-
interface ActionEvent {
|
|
2866
|
-
body?: string;
|
|
2867
|
-
}
|
|
2868
|
-
interface MessageEnvelope {
|
|
2869
|
-
/**
|
|
2870
|
-
* App instance ID.
|
|
2871
|
-
* @format GUID
|
|
2872
|
-
*/
|
|
2873
|
-
instanceId?: string | null;
|
|
2874
|
-
/**
|
|
2875
|
-
* Event type.
|
|
2876
|
-
* @maxLength 150
|
|
2877
|
-
*/
|
|
2878
|
-
eventType?: string;
|
|
2879
|
-
/** The identification type and identity data. */
|
|
2880
|
-
identity?: IdentificationData;
|
|
2881
|
-
/** Stringify payload. */
|
|
2882
|
-
data?: string;
|
|
2883
|
-
/** Details related to the account */
|
|
2884
|
-
accountInfo?: AccountInfo;
|
|
2885
|
-
}
|
|
2886
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2887
|
-
/**
|
|
2888
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2889
|
-
* @format GUID
|
|
2890
|
-
*/
|
|
2891
|
-
anonymousVisitorId?: string;
|
|
2892
|
-
/**
|
|
2893
|
-
* ID of a site visitor that has logged in to the site.
|
|
2894
|
-
* @format GUID
|
|
2895
|
-
*/
|
|
2896
|
-
memberId?: string;
|
|
2897
|
-
/**
|
|
2898
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2899
|
-
* @format GUID
|
|
2900
|
-
*/
|
|
2901
|
-
wixUserId?: string;
|
|
2902
|
-
/**
|
|
2903
|
-
* ID of an app.
|
|
2904
|
-
* @format GUID
|
|
2905
|
-
*/
|
|
2906
|
-
appId?: string;
|
|
2907
|
-
/** @readonly */
|
|
2908
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2909
|
-
}
|
|
2910
|
-
/** @oneof */
|
|
2911
|
-
interface IdentificationDataIdOneOf {
|
|
2912
|
-
/**
|
|
2913
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2914
|
-
* @format GUID
|
|
2915
|
-
*/
|
|
2916
|
-
anonymousVisitorId?: string;
|
|
2917
|
-
/**
|
|
2918
|
-
* ID of a site visitor that has logged in to the site.
|
|
2919
|
-
* @format GUID
|
|
2920
|
-
*/
|
|
2921
|
-
memberId?: string;
|
|
2922
|
-
/**
|
|
2923
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2924
|
-
* @format GUID
|
|
2925
|
-
*/
|
|
2926
|
-
wixUserId?: string;
|
|
2927
|
-
/**
|
|
2928
|
-
* ID of an app.
|
|
2929
|
-
* @format GUID
|
|
2930
|
-
*/
|
|
2931
|
-
appId?: string;
|
|
2932
|
-
}
|
|
2933
|
-
declare enum WebhookIdentityType {
|
|
2934
|
-
UNKNOWN = "UNKNOWN",
|
|
2935
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2936
|
-
MEMBER = "MEMBER",
|
|
2937
|
-
WIX_USER = "WIX_USER",
|
|
2938
|
-
APP = "APP"
|
|
2939
|
-
}
|
|
2940
|
-
/** @enumType */
|
|
2941
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2942
|
-
interface AccountInfo {
|
|
2943
|
-
/**
|
|
2944
|
-
* ID of the Wix account associated with the event.
|
|
2945
|
-
* @format GUID
|
|
2946
|
-
*/
|
|
2947
|
-
accountId?: string | null;
|
|
2948
|
-
/**
|
|
2949
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2950
|
-
* @format GUID
|
|
2951
|
-
*/
|
|
2952
|
-
parentAccountId?: string | null;
|
|
2953
|
-
/**
|
|
2954
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2955
|
-
* @format GUID
|
|
2956
|
-
*/
|
|
2957
|
-
siteId?: string | null;
|
|
2958
|
-
}
|
|
2959
|
-
/** Get Blog Publications Count Stats request */
|
|
2960
|
-
interface QueryPublicationsCountStatsRequest {
|
|
2961
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2962
|
-
rangeStart?: Date | null;
|
|
2963
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2964
|
-
rangeEnd?: Date | null;
|
|
2965
|
-
/** Order of the returned results. */
|
|
2966
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2967
|
-
/** Number of months to include in the response. */
|
|
2968
|
-
months?: number;
|
|
2918
|
+
translationId?: string | null;
|
|
2969
2919
|
/**
|
|
2970
|
-
* Language
|
|
2920
|
+
* Language the draft post is written in.
|
|
2971
2921
|
*
|
|
2972
2922
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2973
2923
|
* @format LANGUAGE_TAG
|
|
2974
2924
|
*/
|
|
2975
2925
|
language?: string | null;
|
|
2976
2926
|
/**
|
|
2977
|
-
*
|
|
2978
|
-
*
|
|
2979
|
-
*
|
|
2927
|
+
* Draft Post rich content.
|
|
2928
|
+
*
|
|
2929
|
+
* <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">
|
|
2930
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2931
|
+
* </widget>
|
|
2980
2932
|
*/
|
|
2981
|
-
|
|
2982
|
-
}
|
|
2983
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2984
|
-
UNKNOWN = "UNKNOWN",
|
|
2985
|
-
OLDEST = "OLDEST",
|
|
2986
|
-
NEWEST = "NEWEST"
|
|
2987
|
-
}
|
|
2988
|
-
/** @enumType */
|
|
2989
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2990
|
-
/** Get Blog Publications Count Stats response */
|
|
2991
|
-
interface QueryPublicationsCountStatsResponse {
|
|
2992
|
-
/** Chronologically ordered list of publications. */
|
|
2993
|
-
stats?: PeriodPublicationsCount[];
|
|
2994
|
-
}
|
|
2995
|
-
/** Publications count for a specific time period */
|
|
2996
|
-
interface PeriodPublicationsCount {
|
|
2997
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2998
|
-
periodStart?: Date | null;
|
|
2999
|
-
/** Number of posts published during this month. */
|
|
3000
|
-
publicationsCount?: number;
|
|
3001
|
-
}
|
|
3002
|
-
/** Get Blog Post Count Stats request */
|
|
3003
|
-
interface QueryPostCountStatsRequest {
|
|
3004
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3005
|
-
rangeStart?: Date | null;
|
|
2933
|
+
richContent?: RichContent;
|
|
3006
2934
|
/**
|
|
3007
|
-
*
|
|
3008
|
-
*
|
|
3009
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
3010
|
-
* - `NEWEST`: posts by date in descending order.
|
|
3011
|
-
*
|
|
3012
|
-
* Default: `OLDEST`
|
|
2935
|
+
* Status of the draft post.
|
|
2936
|
+
* @readonly
|
|
3013
2937
|
*/
|
|
3014
|
-
|
|
3015
|
-
/**
|
|
3016
|
-
|
|
2938
|
+
status?: StatusWithLiterals;
|
|
2939
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
2940
|
+
moderationDetails?: ModerationDetails;
|
|
3017
2941
|
/**
|
|
3018
|
-
*
|
|
3019
|
-
*
|
|
3020
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3021
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
3022
|
-
* @format LANGUAGE_TAG
|
|
2942
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
2943
|
+
* @readonly
|
|
3023
2944
|
*/
|
|
3024
|
-
|
|
2945
|
+
hasUnpublishedChanges?: boolean;
|
|
3025
2946
|
/**
|
|
3026
|
-
*
|
|
3027
|
-
*
|
|
3028
|
-
|
|
3029
|
-
|
|
2947
|
+
* Date the draft post was last edited.
|
|
2948
|
+
* @readonly
|
|
2949
|
+
*/
|
|
2950
|
+
editedDate?: Date | null;
|
|
2951
|
+
/**
|
|
2952
|
+
* Date the draft post is scheduled to be published.
|
|
2953
|
+
* @readonly
|
|
2954
|
+
*/
|
|
2955
|
+
scheduledPublishDate?: Date | null;
|
|
2956
|
+
/** Date the post was first published. */
|
|
2957
|
+
firstPublishedDate?: Date | null;
|
|
2958
|
+
/** SEO data. */
|
|
2959
|
+
seoData?: SeoSchema;
|
|
2960
|
+
/**
|
|
2961
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
|
2962
|
+
* @readonly
|
|
2963
|
+
*/
|
|
2964
|
+
url?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* Date the draft post was first created.
|
|
2967
|
+
* @readonly
|
|
2968
|
+
*/
|
|
2969
|
+
_createdDate?: Date | null;
|
|
2970
|
+
/**
|
|
2971
|
+
* SEO slug.
|
|
3030
2972
|
* @maxLength 100
|
|
3031
2973
|
*/
|
|
3032
|
-
|
|
2974
|
+
seoSlug?: string | null;
|
|
2975
|
+
/** Post cover media. */
|
|
2976
|
+
media?: Media;
|
|
2977
|
+
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2978
|
+
previewTextParagraph?: number | null;
|
|
3033
2979
|
}
|
|
3034
|
-
declare enum
|
|
2980
|
+
declare enum Origin {
|
|
3035
2981
|
UNKNOWN = "UNKNOWN",
|
|
3036
|
-
|
|
3037
|
-
|
|
2982
|
+
/** Changed by admin */
|
|
2983
|
+
ADMIN = "ADMIN",
|
|
2984
|
+
/** Categories were changed */
|
|
2985
|
+
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
2986
|
+
/** Saved automatically */
|
|
2987
|
+
AUTO_SAVE = "AUTO_SAVE",
|
|
2988
|
+
/** Copied from template */
|
|
2989
|
+
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
2990
|
+
/** Imported */
|
|
2991
|
+
IMPORT = "IMPORT",
|
|
2992
|
+
/** Imported in bulk */
|
|
2993
|
+
IMPORT_BULK = "IMPORT_BULK",
|
|
2994
|
+
/** Imported with html import */
|
|
2995
|
+
IMPORT_HTML = "IMPORT_HTML",
|
|
2996
|
+
/** Patch import */
|
|
2997
|
+
IMPORT_PATCH = "IMPORT_PATCH",
|
|
2998
|
+
/** Changed language */
|
|
2999
|
+
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
3000
|
+
/** Saved manually */
|
|
3001
|
+
MANUAL_SAVE = "MANUAL_SAVE",
|
|
3002
|
+
/** Affected by migration */
|
|
3003
|
+
MIGRATION = "MIGRATION",
|
|
3004
|
+
/** Affected by moderation */
|
|
3005
|
+
MODERATION = "MODERATION",
|
|
3006
|
+
/** Moved to trash */
|
|
3007
|
+
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
3008
|
+
/** Pricing plans were changed */
|
|
3009
|
+
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
3010
|
+
/** Was provisioned */
|
|
3011
|
+
PROVISION = "PROVISION",
|
|
3012
|
+
/** Was published */
|
|
3013
|
+
PUBLISH = "PUBLISH",
|
|
3014
|
+
/** Owner was reassigned */
|
|
3015
|
+
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
3016
|
+
/** Was reblogged */
|
|
3017
|
+
REBLOG = "REBLOG",
|
|
3018
|
+
/** Was restored */
|
|
3019
|
+
RESTORE = "RESTORE",
|
|
3020
|
+
/** Reverted to draft */
|
|
3021
|
+
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
3022
|
+
/** Was translated */
|
|
3023
|
+
TRANSLATION = "TRANSLATION",
|
|
3024
|
+
/** Was unpublished */
|
|
3025
|
+
UNPUBLISH = "UNPUBLISH",
|
|
3026
|
+
/** Was unscheduled */
|
|
3027
|
+
UNSCHEDULE = "UNSCHEDULE",
|
|
3028
|
+
/** New edit session started which updated editing_session_id id */
|
|
3029
|
+
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
3030
|
+
/** Was scheduled by Later */
|
|
3031
|
+
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
3032
|
+
/** Was unscheduled by Later */
|
|
3033
|
+
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
3034
|
+
/** Was published by Later */
|
|
3035
|
+
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
3036
|
+
/** Was scheduled */
|
|
3037
|
+
SCHEDULE = "SCHEDULE",
|
|
3038
|
+
/** Was removed from moderation */
|
|
3039
|
+
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
3040
|
+
/** Was rejected from moderation */
|
|
3041
|
+
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
3042
|
+
/** Was approved in moderation */
|
|
3043
|
+
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
3044
|
+
/** Tag was deleted */
|
|
3045
|
+
DELETE_TAG = "DELETE_TAG",
|
|
3046
|
+
/** Post was pinned */
|
|
3047
|
+
PIN = "PIN",
|
|
3048
|
+
/** Post was unpinned */
|
|
3049
|
+
UNPIN = "UNPIN",
|
|
3050
|
+
/** Saved automatically by AI tool. */
|
|
3051
|
+
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
3038
3052
|
}
|
|
3039
3053
|
/** @enumType */
|
|
3040
|
-
type
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
/**
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3054
|
+
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';
|
|
3055
|
+
declare enum Status {
|
|
3056
|
+
UNKNOWN = "UNKNOWN",
|
|
3057
|
+
/** Status indicating the draft post is published. */
|
|
3058
|
+
PUBLISHED = "PUBLISHED",
|
|
3059
|
+
/** Status indicating the draft post is unpublished. */
|
|
3060
|
+
UNPUBLISHED = "UNPUBLISHED",
|
|
3061
|
+
/** Status indicating the draft post is scheduled for publication. */
|
|
3062
|
+
SCHEDULED = "SCHEDULED",
|
|
3063
|
+
/** Status indicating the draft post is deleted. */
|
|
3064
|
+
DELETED = "DELETED",
|
|
3065
|
+
/** Status indicating the draft post is in review. */
|
|
3066
|
+
IN_REVIEW = "IN_REVIEW"
|
|
3052
3067
|
}
|
|
3053
|
-
|
|
3068
|
+
/** @enumType */
|
|
3069
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
3070
|
+
interface DraftPostTranslation {
|
|
3054
3071
|
/**
|
|
3055
|
-
*
|
|
3056
|
-
* @
|
|
3057
|
-
* @format LANGUAGE_TAG
|
|
3072
|
+
* Post ID.
|
|
3073
|
+
* @format GUID
|
|
3058
3074
|
*/
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
/** Total amount of publications. */
|
|
3063
|
-
total?: number;
|
|
3064
|
-
}
|
|
3065
|
-
interface GetTotalPostsRequest {
|
|
3075
|
+
_id?: string;
|
|
3076
|
+
/** Post status. */
|
|
3077
|
+
status?: StatusWithLiterals;
|
|
3066
3078
|
/**
|
|
3067
|
-
* Language
|
|
3068
|
-
*
|
|
3069
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3070
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
3079
|
+
* Language the post is written in.
|
|
3071
3080
|
* @format LANGUAGE_TAG
|
|
3072
3081
|
*/
|
|
3073
3082
|
language?: string | null;
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3083
|
+
/**
|
|
3084
|
+
* Post slug. For example, 'post-slug'.
|
|
3085
|
+
* @maxLength 100
|
|
3086
|
+
*/
|
|
3087
|
+
slug?: string | null;
|
|
3088
|
+
/** SEO data. */
|
|
3089
|
+
seoData?: SeoSchema;
|
|
3090
|
+
/** Post URL. */
|
|
3091
|
+
url?: string;
|
|
3078
3092
|
}
|
|
3079
3093
|
interface GetTotalLikesPerMemberRequest {
|
|
3080
3094
|
/**
|
|
@@ -3867,13 +3881,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3867
3881
|
/**
|
|
3868
3882
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3869
3883
|
*
|
|
3870
|
-
*
|
|
3871
|
-
* The
|
|
3872
|
-
*
|
|
3873
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3874
|
-
*
|
|
3875
|
-
*
|
|
3884
|
+
*
|
|
3885
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
3886
|
+
*
|
|
3887
|
+
* 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.
|
|
3888
|
+
*
|
|
3889
|
+
* >**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.
|
|
3876
3890
|
* @public
|
|
3891
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3877
3892
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3878
3893
|
* @applicableIdentity APP
|
|
3879
3894
|
* @returns Get Blog Post Count Stats response
|
|
@@ -3914,6 +3929,7 @@ interface QueryPostCountStatsOptions {
|
|
|
3914
3929
|
/**
|
|
3915
3930
|
* Retrieves the total amount of published posts of the blog.
|
|
3916
3931
|
* @public
|
|
3932
|
+
* @param options - Language Options.
|
|
3917
3933
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3918
3934
|
* @applicableIdentity APP
|
|
3919
3935
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -3934,12 +3950,12 @@ interface GetTotalPostsOptions {
|
|
|
3934
3950
|
* @param postId - Post ID.
|
|
3935
3951
|
* @public
|
|
3936
3952
|
* @requiredField postId
|
|
3953
|
+
* @param options - Options specifying which fields to return.
|
|
3937
3954
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3938
3955
|
* @applicableIdentity APP
|
|
3939
|
-
* @returns Retrieved post info.
|
|
3940
3956
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3941
3957
|
*/
|
|
3942
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
3958
|
+
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.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>>;
|
|
3943
3959
|
interface GetPostOptions {
|
|
3944
3960
|
/**
|
|
3945
3961
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3959,6 +3975,7 @@ interface GetPostOptions {
|
|
|
3959
3975
|
* @param slug - Slug of the post to retrieve.
|
|
3960
3976
|
* @public
|
|
3961
3977
|
* @requiredField slug
|
|
3978
|
+
* @param options - Options specifying which fields to return.
|
|
3962
3979
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3963
3980
|
* @applicableIdentity APP
|
|
3964
3981
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -3986,6 +4003,7 @@ interface GetPostBySlugOptions {
|
|
|
3986
4003
|
* - `paging.limit` is `50`.
|
|
3987
4004
|
* - `paging.offset` is `0`.
|
|
3988
4005
|
* @public
|
|
4006
|
+
* @param options - Sort, filter, and paging options.
|
|
3989
4007
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3990
4008
|
* @applicableIdentity APP
|
|
3991
4009
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4056,18 +4074,26 @@ interface ListPostsOptions {
|
|
|
4056
4074
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4057
4075
|
}
|
|
4058
4076
|
/**
|
|
4059
|
-
*
|
|
4077
|
+
* Creates a query to retrieve a list of posts.
|
|
4060
4078
|
*
|
|
4061
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4062
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4063
|
-
* - `paging.limit` is `50`.
|
|
4064
|
-
* - `paging.offset` is `0`.
|
|
4065
4079
|
*
|
|
4066
|
-
*
|
|
4067
|
-
*
|
|
4068
|
-
*
|
|
4069
|
-
*
|
|
4080
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4081
|
+
*
|
|
4082
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4083
|
+
*
|
|
4084
|
+
* 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.
|
|
4085
|
+
*
|
|
4086
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4087
|
+
* + `limit(50)`
|
|
4088
|
+
* + `descending('firstPublishedDate')`
|
|
4089
|
+
*
|
|
4090
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4091
|
+
*
|
|
4092
|
+
* To learn how to query posts, refer to the table below.
|
|
4093
|
+
*
|
|
4094
|
+
* 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`.
|
|
4070
4095
|
* @public
|
|
4096
|
+
* @param options - Options specifying which fields to return.
|
|
4071
4097
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4072
4098
|
* @applicableIdentity APP
|
|
4073
4099
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4323,9 +4349,12 @@ type PostQuery = {
|
|
|
4323
4349
|
}[];
|
|
4324
4350
|
};
|
|
4325
4351
|
declare const utils: {
|
|
4326
|
-
|
|
4327
|
-
|
|
4328
|
-
|
|
4352
|
+
query: {
|
|
4353
|
+
/** @enumType */
|
|
4354
|
+
QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
|
|
4355
|
+
Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
|
|
4356
|
+
Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
|
|
4357
|
+
};
|
|
4329
4358
|
};
|
|
4330
4359
|
/**
|
|
4331
4360
|
* Retrieves a post's metrics.
|
|
@@ -4340,4 +4369,4 @@ declare const utils: {
|
|
|
4340
4369
|
*/
|
|
4341
4370
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4342
4371
|
|
|
4343
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
|
|
4372
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
|