@wix/auto_sdk_blog_posts 1.0.16 → 1.0.18

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 (53) hide show
  1. package/build/cjs/src/blog-v3-post-posts.context.d.ts +1 -1
  2. package/build/cjs/src/blog-v3-post-posts.http.d.ts +19 -21
  3. package/build/cjs/src/blog-v3-post-posts.http.js +19 -21
  4. package/build/cjs/src/blog-v3-post-posts.http.js.map +1 -1
  5. package/build/cjs/src/blog-v3-post-posts.meta.d.ts +7 -7
  6. package/build/cjs/src/blog-v3-post-posts.meta.js.map +1 -1
  7. package/build/cjs/src/blog-v3-post-posts.public.d.ts +28 -35
  8. package/build/cjs/src/blog-v3-post-posts.public.js +5 -5
  9. package/build/cjs/src/blog-v3-post-posts.public.js.map +1 -1
  10. package/build/cjs/src/blog-v3-post-posts.types.d.ts +0 -416
  11. package/build/cjs/src/blog-v3-post-posts.universal.d.ts +32 -413
  12. package/build/cjs/src/blog-v3-post-posts.universal.js +45 -41
  13. package/build/cjs/src/blog-v3-post-posts.universal.js.map +1 -1
  14. package/build/es/src/blog-v3-post-posts.context.d.ts +1 -1
  15. package/build/es/src/blog-v3-post-posts.http.d.ts +19 -21
  16. package/build/es/src/blog-v3-post-posts.http.js +19 -21
  17. package/build/es/src/blog-v3-post-posts.http.js.map +1 -1
  18. package/build/es/src/blog-v3-post-posts.meta.d.ts +7 -7
  19. package/build/es/src/blog-v3-post-posts.meta.js.map +1 -1
  20. package/build/es/src/blog-v3-post-posts.public.d.ts +28 -35
  21. package/build/es/src/blog-v3-post-posts.public.js +5 -5
  22. package/build/es/src/blog-v3-post-posts.public.js.map +1 -1
  23. package/build/es/src/blog-v3-post-posts.types.d.ts +0 -416
  24. package/build/es/src/blog-v3-post-posts.universal.d.ts +32 -413
  25. package/build/es/src/blog-v3-post-posts.universal.js +45 -41
  26. package/build/es/src/blog-v3-post-posts.universal.js.map +1 -1
  27. package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +1 -1
  28. package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +19 -21
  29. package/build/internal/cjs/src/blog-v3-post-posts.http.js +19 -21
  30. package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +1 -1
  31. package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +7 -7
  32. package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +1 -1
  33. package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +28 -35
  34. package/build/internal/cjs/src/blog-v3-post-posts.public.js +5 -5
  35. package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +1 -1
  36. package/build/internal/cjs/src/blog-v3-post-posts.types.d.ts +0 -416
  37. package/build/internal/cjs/src/blog-v3-post-posts.universal.d.ts +32 -413
  38. package/build/internal/cjs/src/blog-v3-post-posts.universal.js +45 -41
  39. package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +1 -1
  40. package/build/internal/es/src/blog-v3-post-posts.context.d.ts +1 -1
  41. package/build/internal/es/src/blog-v3-post-posts.http.d.ts +19 -21
  42. package/build/internal/es/src/blog-v3-post-posts.http.js +19 -21
  43. package/build/internal/es/src/blog-v3-post-posts.http.js.map +1 -1
  44. package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +7 -7
  45. package/build/internal/es/src/blog-v3-post-posts.meta.js.map +1 -1
  46. package/build/internal/es/src/blog-v3-post-posts.public.d.ts +28 -35
  47. package/build/internal/es/src/blog-v3-post-posts.public.js +5 -5
  48. package/build/internal/es/src/blog-v3-post-posts.public.js.map +1 -1
  49. package/build/internal/es/src/blog-v3-post-posts.types.d.ts +0 -416
  50. package/build/internal/es/src/blog-v3-post-posts.universal.d.ts +32 -413
  51. package/build/internal/es/src/blog-v3-post-posts.universal.js +45 -41
  52. package/build/internal/es/src/blog-v3-post-posts.universal.js.map +1 -1
  53. package/package.json +3 -3
@@ -1,3 +1,4 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
1
2
  export interface Post {
2
3
  /**
3
4
  * Post ID.
@@ -3171,386 +3172,6 @@ export interface OldBlogMigratedEvent {
3171
3172
  */
3172
3173
  oldBlogInstanceId?: string;
3173
3174
  }
3174
- interface PeriodPostCountNonNullableFields {
3175
- postCount: number;
3176
- }
3177
- export interface QueryPostCountStatsResponseNonNullableFields {
3178
- stats: PeriodPostCountNonNullableFields[];
3179
- }
3180
- export interface GetTotalPostsResponseNonNullableFields {
3181
- total: number;
3182
- }
3183
- interface CoverMediaNonNullableFields {
3184
- image: string;
3185
- video: string;
3186
- enabled: boolean;
3187
- displayed: boolean;
3188
- custom: boolean;
3189
- }
3190
- interface PostCountInfoNonNullableFields {
3191
- comments: number;
3192
- likes: number;
3193
- views: number;
3194
- }
3195
- interface MetricsNonNullableFields {
3196
- comments: number;
3197
- likes: number;
3198
- views: number;
3199
- totalRatings: number;
3200
- averageRating: number;
3201
- }
3202
- interface TagNonNullableFields {
3203
- type: string;
3204
- children: string;
3205
- custom: boolean;
3206
- disabled: boolean;
3207
- }
3208
- interface KeywordNonNullableFields {
3209
- term: string;
3210
- isMain: boolean;
3211
- }
3212
- interface SettingsNonNullableFields {
3213
- preventAutoRedirect: boolean;
3214
- keywords: KeywordNonNullableFields[];
3215
- }
3216
- interface SeoSchemaNonNullableFields {
3217
- tags: TagNonNullableFields[];
3218
- settings?: SettingsNonNullableFields;
3219
- }
3220
- interface PluginContainerDataWidthNonNullableFields {
3221
- size: WidthType;
3222
- }
3223
- interface PluginContainerDataNonNullableFields {
3224
- width?: PluginContainerDataWidthNonNullableFields;
3225
- alignment: PluginContainerDataAlignment;
3226
- }
3227
- interface LinkNonNullableFields {
3228
- url: string;
3229
- anchor: string;
3230
- target: Target;
3231
- }
3232
- interface ButtonDataNonNullableFields {
3233
- containerData?: PluginContainerDataNonNullableFields;
3234
- type: Type;
3235
- link?: LinkNonNullableFields;
3236
- }
3237
- interface TextStyleNonNullableFields {
3238
- textAlignment: TextAlignment;
3239
- }
3240
- interface CodeBlockDataNonNullableFields {
3241
- textStyle?: TextStyleNonNullableFields;
3242
- }
3243
- interface DividerDataNonNullableFields {
3244
- containerData?: PluginContainerDataNonNullableFields;
3245
- lineStyle: LineStyle;
3246
- width: Width;
3247
- alignment: Alignment;
3248
- }
3249
- interface PDFSettingsNonNullableFields {
3250
- viewMode: ViewMode;
3251
- }
3252
- interface FileDataNonNullableFields {
3253
- containerData?: PluginContainerDataNonNullableFields;
3254
- pdfSettings?: PDFSettingsNonNullableFields;
3255
- }
3256
- interface ImageNonNullableFields {
3257
- link?: LinkNonNullableFields;
3258
- }
3259
- interface ItemNonNullableFields {
3260
- image?: ImageNonNullableFields;
3261
- }
3262
- interface LayoutNonNullableFields {
3263
- type: LayoutType;
3264
- orientation: Orientation;
3265
- }
3266
- interface ItemStyleNonNullableFields {
3267
- crop: Crop;
3268
- }
3269
- interface ThumbnailsNonNullableFields {
3270
- placement: ThumbnailsAlignment;
3271
- }
3272
- interface GalleryOptionsNonNullableFields {
3273
- layout?: LayoutNonNullableFields;
3274
- item?: ItemStyleNonNullableFields;
3275
- thumbnails?: ThumbnailsNonNullableFields;
3276
- }
3277
- interface GalleryDataNonNullableFields {
3278
- containerData?: PluginContainerDataNonNullableFields;
3279
- items: ItemNonNullableFields[];
3280
- options?: GalleryOptionsNonNullableFields;
3281
- }
3282
- interface GIFDataNonNullableFields {
3283
- containerData?: PluginContainerDataNonNullableFields;
3284
- height: number;
3285
- width: number;
3286
- gifType: GIFType;
3287
- }
3288
- interface HeadingDataNonNullableFields {
3289
- level: number;
3290
- textStyle?: TextStyleNonNullableFields;
3291
- }
3292
- interface HTMLDataNonNullableFields {
3293
- url: string;
3294
- html: string;
3295
- containerData?: PluginContainerDataNonNullableFields;
3296
- source: Source;
3297
- }
3298
- interface ImageDataNonNullableFields {
3299
- containerData?: PluginContainerDataNonNullableFields;
3300
- link?: LinkNonNullableFields;
3301
- }
3302
- interface LinkPreviewDataNonNullableFields {
3303
- containerData?: PluginContainerDataNonNullableFields;
3304
- link?: LinkNonNullableFields;
3305
- }
3306
- interface MapSettingsNonNullableFields {
3307
- mapType: MapType;
3308
- }
3309
- interface MapDataNonNullableFields {
3310
- containerData?: PluginContainerDataNonNullableFields;
3311
- mapSettings?: MapSettingsNonNullableFields;
3312
- }
3313
- interface ParagraphDataNonNullableFields {
3314
- textStyle?: TextStyleNonNullableFields;
3315
- }
3316
- interface PermissionsNonNullableFields {
3317
- view: ViewRole;
3318
- vote: VoteRole;
3319
- }
3320
- interface PollSettingsNonNullableFields {
3321
- permissions?: PermissionsNonNullableFields;
3322
- }
3323
- interface PollNonNullableFields {
3324
- settings?: PollSettingsNonNullableFields;
3325
- }
3326
- interface PollLayoutNonNullableFields {
3327
- type: PollLayoutType;
3328
- direction: PollLayoutDirection;
3329
- }
3330
- interface PollDataLayoutNonNullableFields {
3331
- poll?: PollLayoutNonNullableFields;
3332
- }
3333
- interface BackgroundNonNullableFields {
3334
- type: BackgroundType;
3335
- }
3336
- interface PollDesignNonNullableFields {
3337
- background?: BackgroundNonNullableFields;
3338
- }
3339
- interface DesignNonNullableFields {
3340
- poll?: PollDesignNonNullableFields;
3341
- }
3342
- interface PollDataNonNullableFields {
3343
- containerData?: PluginContainerDataNonNullableFields;
3344
- poll?: PollNonNullableFields;
3345
- layout?: PollDataLayoutNonNullableFields;
3346
- design?: DesignNonNullableFields;
3347
- }
3348
- interface AnchorDataNonNullableFields {
3349
- anchor: string;
3350
- }
3351
- interface LinkDataNonNullableFields {
3352
- link?: LinkNonNullableFields;
3353
- }
3354
- interface MentionDataNonNullableFields {
3355
- name: string;
3356
- slug: string;
3357
- }
3358
- interface FontSizeDataNonNullableFields {
3359
- unit: FontType;
3360
- }
3361
- interface DecorationNonNullableFields {
3362
- anchorData?: AnchorDataNonNullableFields;
3363
- linkData?: LinkDataNonNullableFields;
3364
- mentionData?: MentionDataNonNullableFields;
3365
- fontSizeData?: FontSizeDataNonNullableFields;
3366
- type: DecorationType;
3367
- }
3368
- interface TextDataNonNullableFields {
3369
- text: string;
3370
- decorations: DecorationNonNullableFields[];
3371
- }
3372
- interface AppEmbedDataNonNullableFields {
3373
- type: AppType;
3374
- }
3375
- interface VideoDataNonNullableFields {
3376
- containerData?: PluginContainerDataNonNullableFields;
3377
- }
3378
- interface EmbedDataNonNullableFields {
3379
- containerData?: PluginContainerDataNonNullableFields;
3380
- }
3381
- interface CollapsibleListDataNonNullableFields {
3382
- containerData?: PluginContainerDataNonNullableFields;
3383
- initialExpandedItems: InitialExpandedItems;
3384
- direction: Direction;
3385
- }
3386
- interface DimensionsNonNullableFields {
3387
- colsWidthRatio: number[];
3388
- rowsHeight: number[];
3389
- colsMinWidth: number[];
3390
- }
3391
- interface TableDataNonNullableFields {
3392
- containerData?: PluginContainerDataNonNullableFields;
3393
- dimensions?: DimensionsNonNullableFields;
3394
- }
3395
- interface CellStyleNonNullableFields {
3396
- verticalAlignment: VerticalAlignment;
3397
- }
3398
- interface TableCellDataNonNullableFields {
3399
- cellStyle?: CellStyleNonNullableFields;
3400
- }
3401
- interface AudioDataNonNullableFields {
3402
- containerData?: PluginContainerDataNonNullableFields;
3403
- }
3404
- interface OrderedListDataNonNullableFields {
3405
- indentation: number;
3406
- }
3407
- interface BulletedListDataNonNullableFields {
3408
- indentation: number;
3409
- }
3410
- interface BlockquoteDataNonNullableFields {
3411
- indentation: number;
3412
- }
3413
- interface CaptionDataNonNullableFields {
3414
- textStyle?: TextStyleNonNullableFields;
3415
- }
3416
- interface NodeNonNullableFields {
3417
- buttonData?: ButtonDataNonNullableFields;
3418
- codeBlockData?: CodeBlockDataNonNullableFields;
3419
- dividerData?: DividerDataNonNullableFields;
3420
- fileData?: FileDataNonNullableFields;
3421
- galleryData?: GalleryDataNonNullableFields;
3422
- gifData?: GIFDataNonNullableFields;
3423
- headingData?: HeadingDataNonNullableFields;
3424
- htmlData?: HTMLDataNonNullableFields;
3425
- imageData?: ImageDataNonNullableFields;
3426
- linkPreviewData?: LinkPreviewDataNonNullableFields;
3427
- mapData?: MapDataNonNullableFields;
3428
- paragraphData?: ParagraphDataNonNullableFields;
3429
- pollData?: PollDataNonNullableFields;
3430
- textData?: TextDataNonNullableFields;
3431
- appEmbedData?: AppEmbedDataNonNullableFields;
3432
- videoData?: VideoDataNonNullableFields;
3433
- embedData?: EmbedDataNonNullableFields;
3434
- collapsibleListData?: CollapsibleListDataNonNullableFields;
3435
- tableData?: TableDataNonNullableFields;
3436
- tableCellData?: TableCellDataNonNullableFields;
3437
- audioData?: AudioDataNonNullableFields;
3438
- orderedListData?: OrderedListDataNonNullableFields;
3439
- bulletedListData?: BulletedListDataNonNullableFields;
3440
- blockquoteData?: BlockquoteDataNonNullableFields;
3441
- captionData?: CaptionDataNonNullableFields;
3442
- type: NodeType;
3443
- _id: string;
3444
- nodes: NodeNonNullableFields[];
3445
- }
3446
- interface MetadataNonNullableFields {
3447
- version: number;
3448
- }
3449
- interface TextNodeStyleNonNullableFields {
3450
- decorations: DecorationNonNullableFields[];
3451
- }
3452
- interface DocumentStyleNonNullableFields {
3453
- headerOne?: TextNodeStyleNonNullableFields;
3454
- headerTwo?: TextNodeStyleNonNullableFields;
3455
- headerThree?: TextNodeStyleNonNullableFields;
3456
- headerFour?: TextNodeStyleNonNullableFields;
3457
- headerFive?: TextNodeStyleNonNullableFields;
3458
- headerSix?: TextNodeStyleNonNullableFields;
3459
- paragraph?: TextNodeStyleNonNullableFields;
3460
- blockquote?: TextNodeStyleNonNullableFields;
3461
- codeBlock?: TextNodeStyleNonNullableFields;
3462
- }
3463
- interface RichContentNonNullableFields {
3464
- nodes: NodeNonNullableFields[];
3465
- metadata?: MetadataNonNullableFields;
3466
- documentStyle?: DocumentStyleNonNullableFields;
3467
- }
3468
- interface ModerationDetailsNonNullableFields {
3469
- submittedBy: string;
3470
- status: ModerationStatusStatus;
3471
- }
3472
- interface WixMediaNonNullableFields {
3473
- image: string;
3474
- videoV2: string;
3475
- }
3476
- interface EmbedThumbnailNonNullableFields {
3477
- url: string;
3478
- width: number;
3479
- height: number;
3480
- }
3481
- interface EmbedVideoNonNullableFields {
3482
- url: string;
3483
- width: number;
3484
- height: number;
3485
- }
3486
- interface EmbedMediaNonNullableFields {
3487
- thumbnail?: EmbedThumbnailNonNullableFields;
3488
- video?: EmbedVideoNonNullableFields;
3489
- }
3490
- interface MediaNonNullableFields {
3491
- wixMedia?: WixMediaNonNullableFields;
3492
- embedMedia?: EmbedMediaNonNullableFields;
3493
- displayed: boolean;
3494
- custom: boolean;
3495
- }
3496
- interface PostTranslationNonNullableFields {
3497
- _id: string;
3498
- seoData?: SeoSchemaNonNullableFields;
3499
- url: string;
3500
- }
3501
- interface PostNonNullableFields {
3502
- _id: string;
3503
- title: string;
3504
- excerpt: string;
3505
- url: string;
3506
- slug: string;
3507
- featured: boolean;
3508
- pinned: boolean;
3509
- categoryIds: string[];
3510
- coverMedia?: CoverMediaNonNullableFields;
3511
- memberId: string;
3512
- hashtags: string[];
3513
- commentingEnabled: boolean;
3514
- postCountInfo?: PostCountInfoNonNullableFields;
3515
- minutesToRead: number;
3516
- heroImage: string;
3517
- tagIds: string[];
3518
- relatedPostIds: string[];
3519
- pricingPlanIds: string[];
3520
- metrics?: MetricsNonNullableFields;
3521
- seoData?: SeoSchemaNonNullableFields;
3522
- richContent?: RichContentNonNullableFields;
3523
- preview: boolean;
3524
- moderationDetails?: ModerationDetailsNonNullableFields;
3525
- media?: MediaNonNullableFields;
3526
- hasUnpublishedChanges: boolean;
3527
- translations: PostTranslationNonNullableFields[];
3528
- customExcerpt: boolean;
3529
- internalCategoryIds: string[];
3530
- internalRelatedPostIds: string[];
3531
- }
3532
- export interface GetPostResponseNonNullableFields {
3533
- post?: PostNonNullableFields;
3534
- }
3535
- export interface GetPostBySlugResponseNonNullableFields {
3536
- post?: PostNonNullableFields;
3537
- }
3538
- interface MetaDataNonNullableFields {
3539
- count: number;
3540
- offset: number;
3541
- total: number;
3542
- }
3543
- export interface ListPostsResponseNonNullableFields {
3544
- posts: PostNonNullableFields[];
3545
- metaData?: MetaDataNonNullableFields;
3546
- }
3547
- export interface QueryPostsResponseNonNullableFields {
3548
- posts: PostNonNullableFields[];
3549
- metaData?: MetaDataNonNullableFields;
3550
- }
3551
- export interface GetPostMetricsResponseNonNullableFields {
3552
- metrics?: MetricsNonNullableFields;
3553
- }
3554
3175
  export interface BaseEventMetadata {
3555
3176
  /**
3556
3177
  * App instance ID.
@@ -3698,18 +3319,18 @@ export interface PostUpdatedEnvelope {
3698
3319
  * @slug updated
3699
3320
  */
3700
3321
  export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
3322
+ type PostNonNullablePaths = `_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` | `richContent.nodes` | `richContent.nodes.${number}.buttonData.containerData.width.size` | `richContent.nodes.${number}.buttonData.containerData.alignment` | `richContent.nodes.${number}.buttonData.type` | `richContent.nodes.${number}.buttonData.link.url` | `richContent.nodes.${number}.buttonData.link.anchor` | `richContent.nodes.${number}.buttonData.link.target` | `richContent.nodes.${number}.codeBlockData.textStyle.textAlignment` | `richContent.nodes.${number}.dividerData.lineStyle` | `richContent.nodes.${number}.dividerData.width` | `richContent.nodes.${number}.dividerData.alignment` | `richContent.nodes.${number}.fileData.pdfSettings.viewMode` | `richContent.nodes.${number}.galleryData.items` | `richContent.nodes.${number}.galleryData.options.layout.type` | `richContent.nodes.${number}.galleryData.options.layout.orientation` | `richContent.nodes.${number}.galleryData.options.item.crop` | `richContent.nodes.${number}.galleryData.options.thumbnails.placement` | `richContent.nodes.${number}.gifData.height` | `richContent.nodes.${number}.gifData.width` | `richContent.nodes.${number}.gifData.gifType` | `richContent.nodes.${number}.headingData.level` | `richContent.nodes.${number}.htmlData.url` | `richContent.nodes.${number}.htmlData.html` | `richContent.nodes.${number}.htmlData.source` | `richContent.nodes.${number}.mapData.mapSettings.mapType` | `richContent.nodes.${number}.pollData.poll.options` | `richContent.nodes.${number}.pollData.poll.settings.permissions.view` | `richContent.nodes.${number}.pollData.poll.settings.permissions.vote` | `richContent.nodes.${number}.pollData.layout.poll.type` | `richContent.nodes.${number}.pollData.layout.poll.direction` | `richContent.nodes.${number}.pollData.design.poll.background.type` | `richContent.nodes.${number}.textData.text` | `richContent.nodes.${number}.textData.decorations` | `richContent.nodes.${number}.textData.decorations.${number}.anchorData.anchor` | `richContent.nodes.${number}.textData.decorations.${number}.mentionData.name` | `richContent.nodes.${number}.textData.decorations.${number}.mentionData.slug` | `richContent.nodes.${number}.textData.decorations.${number}.fontSizeData.unit` | `richContent.nodes.${number}.textData.decorations.${number}.type` | `richContent.nodes.${number}.appEmbedData.type` | `richContent.nodes.${number}.collapsibleListData.initialExpandedItems` | `richContent.nodes.${number}.collapsibleListData.direction` | `richContent.nodes.${number}.tableData.dimensions.colsWidthRatio` | `richContent.nodes.${number}.tableData.dimensions.rowsHeight` | `richContent.nodes.${number}.tableData.dimensions.colsMinWidth` | `richContent.nodes.${number}.tableCellData.cellStyle.verticalAlignment` | `richContent.nodes.${number}.orderedListData.indentation` | `richContent.nodes.${number}.bulletedListData.indentation` | `richContent.nodes.${number}.blockquoteData.indentation` | `richContent.nodes.${number}.type` | `richContent.nodes.${number}._id` | `richContent.nodes.${number}.nodes` | `richContent.metadata.version` | `richContent.documentStyle.headerOne.decorations` | `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`;
3701
3323
  /**
3702
3324
  * Retrieves the number of published posts per month within a specified time range.
3703
3325
  *
3704
- *
3705
- * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
3706
- *
3707
- * 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.
3708
- *
3709
- * >**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.
3326
+ * The time range is set using the `rangeStart` and `months` properties.
3327
+ * The time range always starts on the 1st day of the month set in `rangeStart` and
3328
+ * includes the number of `months` following `rangeStart`.
3329
+ * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
3330
+ * 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.
3331
+ * > 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.
3710
3332
  * @public
3711
3333
  * @documentationMaturity preview
3712
- * @param options - Options specifying time frame, sort, and filter.
3713
3334
  * @permissionId BLOG.READ-PUBLICATION
3714
3335
  * @permissionScope Read Blog
3715
3336
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3722,7 +3343,7 @@ export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => v
3722
3343
  * @returns Get Blog Post Count Stats response
3723
3344
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
3724
3345
  */
3725
- export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<QueryPostCountStatsResponse & QueryPostCountStatsResponseNonNullableFields>;
3346
+ export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
3726
3347
  export interface QueryPostCountStatsOptions {
3727
3348
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3728
3349
  rangeStart?: Date | null;
@@ -3758,7 +3379,6 @@ export interface QueryPostCountStatsOptions {
3758
3379
  * Retrieves the total amount of published posts of the blog.
3759
3380
  * @public
3760
3381
  * @documentationMaturity preview
3761
- * @param options - Language Options.
3762
3382
  * @permissionId BLOG.READ-PUBLICATION
3763
3383
  * @permissionScope Read Blog
3764
3384
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3770,7 +3390,7 @@ export interface QueryPostCountStatsOptions {
3770
3390
  * @applicableIdentity VISITOR
3771
3391
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
3772
3392
  */
3773
- export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
3393
+ export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
3774
3394
  export interface GetTotalPostsOptions {
3775
3395
  /**
3776
3396
  * Language filter.
@@ -3786,7 +3406,6 @@ export interface GetTotalPostsOptions {
3786
3406
  * @param postId - Post ID.
3787
3407
  * @public
3788
3408
  * @requiredField postId
3789
- * @param options - Options specifying which fields to return.
3790
3409
  * @permissionId BLOG.READ-PUBLICATION
3791
3410
  * @permissionScope Read Blog
3792
3411
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3796,9 +3415,10 @@ export interface GetTotalPostsOptions {
3796
3415
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3797
3416
  * @applicableIdentity APP
3798
3417
  * @applicableIdentity VISITOR
3418
+ * @returns Retrieved post info.
3799
3419
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
3800
3420
  */
3801
- export declare function getPost(postId: string, options?: GetPostOptions): Promise<GetPostResponse & GetPostResponseNonNullableFields>;
3421
+ export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, PostNonNullablePaths>>;
3802
3422
  export interface GetPostOptions {
3803
3423
  /**
3804
3424
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -3818,7 +3438,6 @@ export interface GetPostOptions {
3818
3438
  * @param slug - Slug of the post to retrieve.
3819
3439
  * @public
3820
3440
  * @requiredField slug
3821
- * @param options - Options specifying which fields to return.
3822
3441
  * @permissionId BLOG.READ-PUBLICATION
3823
3442
  * @permissionScope Read Blog
3824
3443
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3830,7 +3449,9 @@ export interface GetPostOptions {
3830
3449
  * @applicableIdentity VISITOR
3831
3450
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
3832
3451
  */
3833
- export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
3452
+ export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
3453
+ [P in PostNonNullablePaths]: `post.${P}`;
3454
+ }[PostNonNullablePaths]>>;
3834
3455
  export interface GetPostBySlugOptions {
3835
3456
  /**
3836
3457
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -3848,7 +3469,6 @@ export interface GetPostBySlugOptions {
3848
3469
  * - `paging.limit` is `50`.
3849
3470
  * - `paging.offset` is `0`.
3850
3471
  * @public
3851
- * @param options - Sort, filter, and paging options.
3852
3472
  * @permissionId BLOG.READ-PUBLICATION
3853
3473
  * @permissionScope Read Blog
3854
3474
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3860,7 +3480,9 @@ export interface GetPostBySlugOptions {
3860
3480
  * @applicableIdentity VISITOR
3861
3481
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
3862
3482
  */
3863
- export declare function listPosts(options?: ListPostsOptions): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
3483
+ export declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
3484
+ [P in PostNonNullablePaths]: `posts.${number}.${P}`;
3485
+ }[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
3864
3486
  export interface ListPostsOptions {
3865
3487
  /**
3866
3488
  * Whether to return only featured posts.
@@ -3926,26 +3548,23 @@ export interface ListPostsOptions {
3926
3548
  fieldsets?: PostFieldField[];
3927
3549
  }
3928
3550
  /**
3929
- * Creates a query to retrieve a list of posts.
3930
- *
3931
- *
3932
- * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
3551
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
3933
3552
  *
3934
- * The returned object contains the query definition which is typically used to run the query using the `find()` function.
3935
- *
3936
- * 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.
3937
- *
3938
- * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
3939
- * + `limit(50)`
3940
- * + `descending('firstPublishedDate')`
3941
- *
3942
- * Note that the default limit is `'50'`, but the max limit is `'100'`.
3553
+ * Query Posts runs with these defaults, which you can override:
3554
+ * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
3555
+ * - `paging.limit` is `50`.
3556
+ * - `paging.offset` is `0`.
3943
3557
  *
3944
- * To learn how to query posts, refer to the table below.
3558
+ * For field support for filters and sorting, see
3559
+ * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3945
3560
  *
3946
- * 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`.
3561
+ * To learn about working with _Query_ endpoints, see
3562
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
3563
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
3564
+ * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3565
+ * For a detailed list of supported filters and sortable fields, see
3566
+ * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3947
3567
  * @public
3948
- * @param options - Options specifying which fields to return.
3949
3568
  * @permissionScope Read Blog
3950
3569
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3951
3570
  * @permissionScope Manage Blog
@@ -4047,5 +3666,5 @@ export interface PostsQueryBuilder {
4047
3666
  * @applicableIdentity VISITOR
4048
3667
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
4049
3668
  */
4050
- export declare function getPostMetrics(postId: string): Promise<GetPostMetricsResponse & GetPostMetricsResponseNonNullableFields>;
3669
+ export declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
4051
3670
  export {};