@wix/auto_sdk_blog_posts 1.0.108 → 1.0.109

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