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