@wix/auto_sdk_blog_posts 1.0.12 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/blog-v3-post-posts.context.d.ts +1 -1
- package/build/cjs/src/blog-v3-post-posts.http.d.ts +19 -21
- package/build/cjs/src/blog-v3-post-posts.http.js +19 -21
- package/build/cjs/src/blog-v3-post-posts.http.js.map +1 -1
- package/build/cjs/src/blog-v3-post-posts.public.d.ts +23 -30
- package/build/cjs/src/blog-v3-post-posts.public.js +5 -5
- package/build/cjs/src/blog-v3-post-posts.public.js.map +1 -1
- package/build/cjs/src/blog-v3-post-posts.universal.d.ts +22 -29
- package/build/cjs/src/blog-v3-post-posts.universal.js +45 -41
- package/build/cjs/src/blog-v3-post-posts.universal.js.map +1 -1
- package/build/es/src/blog-v3-post-posts.context.d.ts +1 -1
- package/build/es/src/blog-v3-post-posts.http.d.ts +19 -21
- package/build/es/src/blog-v3-post-posts.http.js +19 -21
- package/build/es/src/blog-v3-post-posts.http.js.map +1 -1
- package/build/es/src/blog-v3-post-posts.public.d.ts +23 -30
- package/build/es/src/blog-v3-post-posts.public.js +5 -5
- package/build/es/src/blog-v3-post-posts.public.js.map +1 -1
- package/build/es/src/blog-v3-post-posts.universal.d.ts +22 -29
- package/build/es/src/blog-v3-post-posts.universal.js +45 -41
- package/build/es/src/blog-v3-post-posts.universal.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +1 -1
- package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +19 -21
- package/build/internal/cjs/src/blog-v3-post-posts.http.js +19 -21
- package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +23 -30
- package/build/internal/cjs/src/blog-v3-post-posts.public.js +5 -5
- package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-post-posts.universal.d.ts +22 -29
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js +45 -41
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +1 -1
- package/build/internal/es/src/blog-v3-post-posts.context.d.ts +1 -1
- package/build/internal/es/src/blog-v3-post-posts.http.d.ts +19 -21
- package/build/internal/es/src/blog-v3-post-posts.http.js +19 -21
- package/build/internal/es/src/blog-v3-post-posts.http.js.map +1 -1
- package/build/internal/es/src/blog-v3-post-posts.public.d.ts +23 -30
- package/build/internal/es/src/blog-v3-post-posts.public.js +5 -5
- package/build/internal/es/src/blog-v3-post-posts.public.js.map +1 -1
- package/build/internal/es/src/blog-v3-post-posts.universal.d.ts +22 -29
- package/build/internal/es/src/blog-v3-post-posts.universal.js +45 -41
- package/build/internal/es/src/blog-v3-post-posts.universal.js.map +1 -1
- package/package.json +4 -4
@@ -1,5 +1,5 @@
|
|
1
1
|
import { EventDefinition, HttpClient } from '@wix/sdk-types';
|
2
|
-
import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions,
|
2
|
+
import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostNonNullableFields, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
|
3
3
|
export declare const __metadata: {
|
4
4
|
PACKAGE_NAME: string;
|
5
5
|
};
|
@@ -8,13 +8,12 @@ interface QueryPostCountStatsSignature {
|
|
8
8
|
/**
|
9
9
|
* Retrieves the number of published posts per month within a specified time range.
|
10
10
|
*
|
11
|
-
*
|
12
|
-
* The
|
13
|
-
*
|
14
|
-
*
|
15
|
-
*
|
16
|
-
*
|
17
|
-
* @param - Options specifying time frame, sort, and filter.
|
11
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
12
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
13
|
+
* includes the number of `months` following `rangeStart`.
|
14
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
15
|
+
* 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.
|
16
|
+
* > 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.
|
18
17
|
* @returns Get Blog Post Count Stats response
|
19
18
|
*/
|
20
19
|
(options?: QueryPostCountStatsOptions | undefined): Promise<QueryPostCountStatsResponse & QueryPostCountStatsResponseNonNullableFields>;
|
@@ -23,7 +22,6 @@ export declare function getTotalPosts(httpClient: HttpClient): GetTotalPostsSign
|
|
23
22
|
interface GetTotalPostsSignature {
|
24
23
|
/**
|
25
24
|
* Retrieves the total amount of published posts of the blog.
|
26
|
-
* @param - Language Options.
|
27
25
|
*/
|
28
26
|
(options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
|
29
27
|
}
|
@@ -32,9 +30,9 @@ interface GetPostSignature {
|
|
32
30
|
/**
|
33
31
|
* Retrieves a post by the specified ID.
|
34
32
|
* @param - Post ID.
|
35
|
-
* @
|
33
|
+
* @returns Retrieved post info.
|
36
34
|
*/
|
37
|
-
(postId: string, options?: GetPostOptions | undefined): Promise<
|
35
|
+
(postId: string, options?: GetPostOptions | undefined): Promise<Post & PostNonNullableFields>;
|
38
36
|
}
|
39
37
|
export declare function getPostBySlug(httpClient: HttpClient): GetPostBySlugSignature;
|
40
38
|
interface GetPostBySlugSignature {
|
@@ -46,7 +44,6 @@ interface GetPostBySlugSignature {
|
|
46
44
|
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
47
45
|
* unless specified otherwise.
|
48
46
|
* @param - Slug of the post to retrieve.
|
49
|
-
* @param - Options specifying which fields to return.
|
50
47
|
*/
|
51
48
|
(slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
|
52
49
|
}
|
@@ -59,32 +56,28 @@ interface ListPostsSignature {
|
|
59
56
|
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
60
57
|
* - `paging.limit` is `50`.
|
61
58
|
* - `paging.offset` is `0`.
|
62
|
-
* @param - Sort, filter, and paging options.
|
63
59
|
*/
|
64
60
|
(options?: ListPostsOptions | undefined): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
|
65
61
|
}
|
66
62
|
export declare function queryPosts(httpClient: HttpClient): QueryPostsSignature;
|
67
63
|
interface QueryPostsSignature {
|
68
64
|
/**
|
69
|
-
*
|
70
|
-
*
|
71
|
-
*
|
72
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
73
|
-
*
|
74
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
65
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
75
66
|
*
|
76
|
-
*
|
77
|
-
*
|
78
|
-
* `
|
79
|
-
*
|
80
|
-
* + `descending('firstPublishedDate')`
|
81
|
-
*
|
82
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
67
|
+
* Query Posts runs with these defaults, which you can override:
|
68
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
69
|
+
* - `paging.limit` is `50`.
|
70
|
+
* - `paging.offset` is `0`.
|
83
71
|
*
|
84
|
-
*
|
72
|
+
* For field support for filters and sorting, see
|
73
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
85
74
|
*
|
86
|
-
*
|
87
|
-
*
|
75
|
+
* To learn about working with _Query_ endpoints, see
|
76
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
77
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
78
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
79
|
+
* For a detailed list of supported filters and sortable fields, see
|
80
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
88
81
|
*/
|
89
82
|
(options?: QueryPostsOptions | undefined): PostsQueryBuilder;
|
90
83
|
}
|
@@ -103,4 +96,4 @@ export declare const onPostDeleted: EventDefinition<PostDeletedEnvelope, "wix.bl
|
|
103
96
|
export declare const onPostLiked: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
|
104
97
|
export declare const onPostUnliked: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
|
105
98
|
export declare const onPostUpdated: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
|
106
|
-
export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';
|
99
|
+
export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostNonNullableFields, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';
|
@@ -113,7 +113,7 @@ export const onPostCreated = EventDefinition('wix.blog.v3.post_created', true, (
|
|
113
113
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
114
114
|
paths: [{ path: 'entity.media.wixMedia.videoV2' }],
|
115
115
|
},
|
116
|
-
])
|
116
|
+
])))();
|
117
117
|
export const onPostDeleted = EventDefinition('wix.blog.v3.post_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
118
118
|
{
|
119
119
|
transformFn: transformRESTTimestampToSDKTimestamp,
|
@@ -182,19 +182,19 @@ export const onPostDeleted = EventDefinition('wix.blog.v3.post_deleted', true, (
|
|
182
182
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
183
183
|
paths: [{ path: 'entity.media.wixMedia.videoV2' }],
|
184
184
|
},
|
185
|
-
])
|
185
|
+
])))();
|
186
186
|
export const onPostLiked = EventDefinition('wix.blog.v3.post_liked', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
187
187
|
{
|
188
188
|
transformFn: transformRESTTimestampToSDKTimestamp,
|
189
189
|
paths: [{ path: 'metadata.eventTime' }],
|
190
190
|
},
|
191
|
-
])
|
191
|
+
])))();
|
192
192
|
export const onPostUnliked = EventDefinition('wix.blog.v3.post_unliked', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
193
193
|
{
|
194
194
|
transformFn: transformRESTTimestampToSDKTimestamp,
|
195
195
|
paths: [{ path: 'metadata.eventTime' }],
|
196
196
|
},
|
197
|
-
])
|
197
|
+
])))();
|
198
198
|
export const onPostUpdated = EventDefinition('wix.blog.v3.post_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
199
199
|
{
|
200
200
|
transformFn: transformRESTTimestampToSDKTimestamp,
|
@@ -263,6 +263,6 @@ export const onPostUpdated = EventDefinition('wix.blog.v3.post_updated', true, (
|
|
263
263
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
264
264
|
paths: [{ path: 'entity.media.wixMedia.videoV2' }],
|
265
265
|
},
|
266
|
-
])
|
266
|
+
])))();
|
267
267
|
export { Alignment, AppType, BackgroundType, Crop, DecorationType, Direction, Field, FontType, GIFType, GetPostTemplatesSort, GetPostsSort, InitialExpandedItems, LayoutType, LineStyle, MapType, ModerationStatusStatus, NodeType, NullValue, Order, Orientation, Origin, PluginContainerDataAlignment, PollLayoutDirection, PollLayoutType, Position, PostFieldField, QueryPublicationsCountStatsRequestOrder, SortOrder, Source, Status, Target, TextAlignment, ThumbnailsAlignment, Type, VerticalAlignment, ViewMode, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, } from './blog-v3-post-posts.universal.js';
|
268
268
|
//# sourceMappingURL=blog-v3-post-posts.public.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"blog-v3-post-posts.public.js","sourceRoot":"","sources":["../../../src/blog-v3-post-posts.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAyBL,OAAO,IAAI,gBAAgB,EAC3B,aAAa,IAAI,sBAAsB,EACvC,cAAc,IAAI,uBAAuB,EACzC,aAAa,IAAI,sBAAsB,EACvC,SAAS,IAAI,kBAAkB,EAC/B,mBAAmB,IAAI,4BAA4B,EACnD,UAAU,IAAI,mBAAmB,GAClC,MAAM,mCAAmC,CAAC;AAE3C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,OAAoC,EAAE,EAAE,CAC9C,4BAA4B,CAC1B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;
|
1
|
+
{"version":3,"file":"blog-v3-post-posts.public.js","sourceRoot":"","sources":["../../../src/blog-v3-post-posts.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAyBL,OAAO,IAAI,gBAAgB,EAC3B,aAAa,IAAI,sBAAsB,EACvC,cAAc,IAAI,uBAAuB,EACzC,aAAa,IAAI,sBAAsB,EACvC,SAAS,IAAI,kBAAkB,EAC/B,mBAAmB,IAAI,4BAA4B,EACnD,UAAU,IAAI,mBAAmB,GAClC,MAAM,mCAAmC,CAAC;AAE3C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,OAAoC,EAAE,EAAE,CAC9C,4BAA4B,CAC1B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,OAA8B,EAAE,EAAE,CACxC,sBAAsB,CACpB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,MAAc,EAAE,OAAwB,EAAE,EAAE,CAClD,gBAAgB,CACd,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,IAAY,EAAE,OAA8B,EAAE,EAAE,CACtD,sBAAsB,CACpB,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,OAA0B,EAAE,EAAE,CACpC,kBAAkB,CAChB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,OAA2B,EAAE,EAAE,CACrC,mBAAmB,CACjB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAwBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,uBAAuB,CACrB,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAC1C,0BAA0B,EAC1B,IAAI,EACJ,CAAC,KAA0B,EAAE,EAAE,CAC7B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,0BAA0B,EAAE;YACpC,EAAE,IAAI,EAAE,8CAA8C,EAAE;YACxD,EAAE,IAAI,EAAE,8CAA8C,EAAE;YACxD,EAAE,IAAI,EAAE,wCAAwC,EAAE;YAClD,EAAE,IAAI,EAAE,yCAAyC,EAAE;YACnD,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KACrE;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC5B,EAAE,IAAI,EAAE,yBAAyB,EAAE;YACnC,EAAE,IAAI,EAAE,6BAA6B,EAAE;SACxC;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,CAAC;KAClD;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KAC7C;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,8BAA8B,EAAE;YACxC;gBACE,IAAI,EAAE,iEAAiE;aACxE;YACD;gBACE,IAAI,EAAE,iEAAiE;aACxE;YACD;gBACE,IAAI,EAAE,qEAAqE;aAC5E;YACD,EAAE,IAAI,EAAE,yDAAyD,EAAE;YACnE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;YAC5D,EAAE,IAAI,EAAE,kDAAkD,EAAE;YAC5D,EAAE,IAAI,EAAE,uDAAuD,EAAE;YACjE;gBACE,IAAI,EAAE,+DAA+D;aACtE;YACD;gBACE,IAAI,EAAE,yEAAyE;aAChF;YACD,EAAE,IAAI,EAAE,sDAAsD,EAAE;YAChE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,uDAAuD,EAAE;YACjE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,wDAAwD,EAAE;SACnE;KACF;IACD;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC;KACnD;CACF,CAAC,CACH,CACJ,EAAuB,CAAC;AACzB,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAC1C,0BAA0B,EAC1B,IAAI,EACJ,CAAC,KAA0B,EAAE,EAAE,CAC7B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,0BAA0B,EAAE;YACpC,EAAE,IAAI,EAAE,8CAA8C,EAAE;YACxD,EAAE,IAAI,EAAE,8CAA8C,EAAE;YACxD,EAAE,IAAI,EAAE,wCAAwC,EAAE;YAClD,EAAE,IAAI,EAAE,yCAAyC,EAAE;YACnD,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KACrE;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC5B,EAAE,IAAI,EAAE,yBAAyB,EAAE;YACnC,EAAE,IAAI,EAAE,6BAA6B,EAAE;SACxC;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,CAAC;KAClD;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KAC7C;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,8BAA8B,EAAE;YACxC;gBACE,IAAI,EAAE,iEAAiE;aACxE;YACD;gBACE,IAAI,EAAE,iEAAiE;aACxE;YACD;gBACE,IAAI,EAAE,qEAAqE;aAC5E;YACD,EAAE,IAAI,EAAE,yDAAyD,EAAE;YACnE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;YAC5D,EAAE,IAAI,EAAE,kDAAkD,EAAE;YAC5D,EAAE,IAAI,EAAE,uDAAuD,EAAE;YACjE;gBACE,IAAI,EAAE,+DAA+D;aACtE;YACD;gBACE,IAAI,EAAE,yEAAyE;aAChF;YACD,EAAE,IAAI,EAAE,sDAAsD,EAAE;YAChE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,uDAAuD,EAAE;YACjE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,wDAAwD,EAAE;SACnE;KACF;IACD;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC;KACnD;CACF,CAAC,CACH,CACJ,EAAuB,CAAC;AACzB,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CACxC,wBAAwB,EACxB,IAAI,EACJ,CAAC,KAAwB,EAAE,EAAE,CAC3B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAAqB,CAAC;AACvB,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAC1C,0BAA0B,EAC1B,IAAI,EACJ,CAAC,KAA0B,EAAE,EAAE,CAC7B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAAuB,CAAC;AACzB,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAC1C,0BAA0B,EAC1B,IAAI,EACJ,CAAC,KAA0B,EAAE,EAAE,CAC7B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,0BAA0B,EAAE;YACpC,EAAE,IAAI,EAAE,8CAA8C,EAAE;YACxD,EAAE,IAAI,EAAE,8CAA8C,EAAE;YACxD,EAAE,IAAI,EAAE,wCAAwC,EAAE;YAClD,EAAE,IAAI,EAAE,yCAAyC,EAAE;YACnD,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KACrE;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC5B,EAAE,IAAI,EAAE,yBAAyB,EAAE;YACnC,EAAE,IAAI,EAAE,6BAA6B,EAAE;SACxC;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,CAAC;KAClD;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KAC7C;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,8BAA8B,EAAE;YACxC;gBACE,IAAI,EAAE,iEAAiE;aACxE;YACD;gBACE,IAAI,EAAE,iEAAiE;aACxE;YACD;gBACE,IAAI,EAAE,qEAAqE;aAC5E;YACD,EAAE,IAAI,EAAE,yDAAyD,EAAE;YACnE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;YAC5D,EAAE,IAAI,EAAE,kDAAkD,EAAE;YAC5D,EAAE,IAAI,EAAE,uDAAuD,EAAE;YACjE;gBACE,IAAI,EAAE,+DAA+D;aACtE;YACD;gBACE,IAAI,EAAE,yEAAyE;aAChF;YACD,EAAE,IAAI,EAAE,sDAAsD,EAAE;YAChE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,uDAAuD,EAAE;YACjE,EAAE,IAAI,EAAE,mDAAmD,EAAE;YAC7D,EAAE,IAAI,EAAE,wDAAwD,EAAE;SACnE;KACF;IACD;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC;KACnD;CACF,CAAC,CACH,CACJ,EAAuB,CAAC;AAEzB,OAAO,EAEL,SAAS,EAIT,OAAO,EAIP,cAAc,EA6Bd,IAAI,EAKJ,cAAc,EAGd,SAAS,EAgBT,KAAK,EAML,QAAQ,EAGR,OAAO,EAcP,oBAAoB,EACpB,YAAY,EAqBZ,oBAAoB,EAQpB,UAAU,EAGV,SAAS,EAmBT,OAAO,EASP,sBAAsB,EAItB,QAAQ,EACR,SAAS,EAMT,KAAK,EAEL,WAAW,EACX,MAAM,EAcN,4BAA4B,EAQ5B,mBAAmB,EACnB,cAAc,EAEd,QAAQ,EAQR,cAAc,EAuBd,uCAAuC,EASvC,SAAS,EAET,MAAM,EAGN,MAAM,EAMN,MAAM,EACN,aAAa,EAKb,mBAAmB,EACnB,IAAI,EAMJ,iBAAiB,EAIjB,QAAQ,EAGR,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,KAAK,EACL,SAAS,GAEV,MAAM,mCAAmC,CAAC"}
|
@@ -3491,7 +3491,7 @@ interface PostTranslationNonNullableFields {
|
|
3491
3491
|
seoData?: SeoSchemaNonNullableFields;
|
3492
3492
|
url: string;
|
3493
3493
|
}
|
3494
|
-
interface PostNonNullableFields {
|
3494
|
+
export interface PostNonNullableFields {
|
3495
3495
|
_id: string;
|
3496
3496
|
title: string;
|
3497
3497
|
excerpt: string;
|
@@ -3694,15 +3694,14 @@ export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => v
|
|
3694
3694
|
/**
|
3695
3695
|
* Retrieves the number of published posts per month within a specified time range.
|
3696
3696
|
*
|
3697
|
-
*
|
3698
|
-
* The
|
3699
|
-
*
|
3700
|
-
*
|
3701
|
-
*
|
3702
|
-
*
|
3697
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
3698
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
3699
|
+
* includes the number of `months` following `rangeStart`.
|
3700
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
3701
|
+
* 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.
|
3702
|
+
* > 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
3703
|
* @public
|
3704
3704
|
* @documentationMaturity preview
|
3705
|
-
* @param options - Options specifying time frame, sort, and filter.
|
3706
3705
|
* @permissionId BLOG.READ-PUBLICATION
|
3707
3706
|
* @permissionScope Read Blog
|
3708
3707
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -3751,7 +3750,6 @@ export interface QueryPostCountStatsOptions {
|
|
3751
3750
|
* Retrieves the total amount of published posts of the blog.
|
3752
3751
|
* @public
|
3753
3752
|
* @documentationMaturity preview
|
3754
|
-
* @param options - Language Options.
|
3755
3753
|
* @permissionId BLOG.READ-PUBLICATION
|
3756
3754
|
* @permissionScope Read Blog
|
3757
3755
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -3779,7 +3777,6 @@ export interface GetTotalPostsOptions {
|
|
3779
3777
|
* @param postId - Post ID.
|
3780
3778
|
* @public
|
3781
3779
|
* @requiredField postId
|
3782
|
-
* @param options - Options specifying which fields to return.
|
3783
3780
|
* @permissionId BLOG.READ-PUBLICATION
|
3784
3781
|
* @permissionScope Read Blog
|
3785
3782
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -3789,9 +3786,10 @@ export interface GetTotalPostsOptions {
|
|
3789
3786
|
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3790
3787
|
* @applicableIdentity APP
|
3791
3788
|
* @applicableIdentity VISITOR
|
3789
|
+
* @returns Retrieved post info.
|
3792
3790
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3793
3791
|
*/
|
3794
|
-
export declare function getPost(postId: string, options?: GetPostOptions): Promise<
|
3792
|
+
export declare function getPost(postId: string, options?: GetPostOptions): Promise<Post & PostNonNullableFields>;
|
3795
3793
|
export interface GetPostOptions {
|
3796
3794
|
/**
|
3797
3795
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
@@ -3811,7 +3809,6 @@ export interface GetPostOptions {
|
|
3811
3809
|
* @param slug - Slug of the post to retrieve.
|
3812
3810
|
* @public
|
3813
3811
|
* @requiredField slug
|
3814
|
-
* @param options - Options specifying which fields to return.
|
3815
3812
|
* @permissionId BLOG.READ-PUBLICATION
|
3816
3813
|
* @permissionScope Read Blog
|
3817
3814
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -3841,7 +3838,6 @@ export interface GetPostBySlugOptions {
|
|
3841
3838
|
* - `paging.limit` is `50`.
|
3842
3839
|
* - `paging.offset` is `0`.
|
3843
3840
|
* @public
|
3844
|
-
* @param options - Sort, filter, and paging options.
|
3845
3841
|
* @permissionId BLOG.READ-PUBLICATION
|
3846
3842
|
* @permissionScope Read Blog
|
3847
3843
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -3919,26 +3915,23 @@ export interface ListPostsOptions {
|
|
3919
3915
|
fieldsets?: PostFieldField[];
|
3920
3916
|
}
|
3921
3917
|
/**
|
3922
|
-
*
|
3923
|
-
*
|
3924
|
-
*
|
3925
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
3926
|
-
*
|
3927
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
3918
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
3928
3919
|
*
|
3929
|
-
*
|
3930
|
-
*
|
3931
|
-
* `
|
3932
|
-
*
|
3933
|
-
* + `descending('firstPublishedDate')`
|
3934
|
-
*
|
3935
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
3920
|
+
* Query Posts runs with these defaults, which you can override:
|
3921
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3922
|
+
* - `paging.limit` is `50`.
|
3923
|
+
* - `paging.offset` is `0`.
|
3936
3924
|
*
|
3937
|
-
*
|
3925
|
+
* For field support for filters and sorting, see
|
3926
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3938
3927
|
*
|
3939
|
-
*
|
3928
|
+
* To learn about working with _Query_ endpoints, see
|
3929
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
3930
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
3931
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
3932
|
+
* For a detailed list of supported filters and sortable fields, see
|
3933
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3940
3934
|
* @public
|
3941
|
-
* @param options - Options specifying which fields to return.
|
3942
3935
|
* @permissionScope Read Blog
|
3943
3936
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3944
3937
|
* @permissionScope Manage Blog
|
@@ -492,15 +492,14 @@ export var SortOrder;
|
|
492
492
|
/**
|
493
493
|
* Retrieves the number of published posts per month within a specified time range.
|
494
494
|
*
|
495
|
-
*
|
496
|
-
* The
|
497
|
-
*
|
498
|
-
*
|
499
|
-
*
|
500
|
-
*
|
495
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
496
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
497
|
+
* includes the number of `months` following `rangeStart`.
|
498
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
499
|
+
* 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.
|
500
|
+
* > 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.
|
501
501
|
* @public
|
502
502
|
* @documentationMaturity preview
|
503
|
-
* @param options - Options specifying time frame, sort, and filter.
|
504
503
|
* @permissionId BLOG.READ-PUBLICATION
|
505
504
|
* @permissionScope Read Blog
|
506
505
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -522,13 +521,13 @@ export async function queryPostCountStats(options) {
|
|
522
521
|
months: options?.months,
|
523
522
|
language: options?.language,
|
524
523
|
timeZone: options?.timeZone,
|
525
|
-
}
|
524
|
+
});
|
526
525
|
const reqOpts = ambassadorWixBlogV3Post.queryPostCountStats(payload);
|
527
526
|
sideEffects?.onSiteCall?.();
|
528
527
|
try {
|
529
528
|
const result = await httpClient.request(reqOpts);
|
530
529
|
sideEffects?.onSuccess?.(result);
|
531
|
-
return renameKeysFromRESTResponseToSDKResponse(result.data
|
530
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
532
531
|
}
|
533
532
|
catch (err) {
|
534
533
|
const transformedError = sdkTransformError(err, {
|
@@ -550,7 +549,6 @@ export async function queryPostCountStats(options) {
|
|
550
549
|
* Retrieves the total amount of published posts of the blog.
|
551
550
|
* @public
|
552
551
|
* @documentationMaturity preview
|
553
|
-
* @param options - Language Options.
|
554
552
|
* @permissionId BLOG.READ-PUBLICATION
|
555
553
|
* @permissionScope Read Blog
|
556
554
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -565,13 +563,15 @@ export async function queryPostCountStats(options) {
|
|
565
563
|
export async function getTotalPosts(options) {
|
566
564
|
// @ts-ignore
|
567
565
|
const { httpClient, sideEffects } = arguments[1];
|
568
|
-
const payload = renameKeysFromSDKRequestToRESTRequest({
|
566
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
567
|
+
language: options?.language,
|
568
|
+
});
|
569
569
|
const reqOpts = ambassadorWixBlogV3Post.getTotalPosts(payload);
|
570
570
|
sideEffects?.onSiteCall?.();
|
571
571
|
try {
|
572
572
|
const result = await httpClient.request(reqOpts);
|
573
573
|
sideEffects?.onSuccess?.(result);
|
574
|
-
return renameKeysFromRESTResponseToSDKResponse(result.data
|
574
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
575
575
|
}
|
576
576
|
catch (err) {
|
577
577
|
const transformedError = sdkTransformError(err, {
|
@@ -588,7 +588,6 @@ export async function getTotalPosts(options) {
|
|
588
588
|
* @param postId - Post ID.
|
589
589
|
* @public
|
590
590
|
* @requiredField postId
|
591
|
-
* @param options - Options specifying which fields to return.
|
592
591
|
* @permissionId BLOG.READ-PUBLICATION
|
593
592
|
* @permissionScope Read Blog
|
594
593
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -598,12 +597,16 @@ export async function getTotalPosts(options) {
|
|
598
597
|
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
599
598
|
* @applicableIdentity APP
|
600
599
|
* @applicableIdentity VISITOR
|
600
|
+
* @returns Retrieved post info.
|
601
601
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
602
602
|
*/
|
603
603
|
export async function getPost(postId, options) {
|
604
604
|
// @ts-ignore
|
605
605
|
const { httpClient, sideEffects } = arguments[2];
|
606
|
-
const payload = renameKeysFromSDKRequestToRESTRequest({
|
606
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
607
|
+
postId: postId,
|
608
|
+
fieldsets: options?.fieldsets,
|
609
|
+
});
|
607
610
|
const reqOpts = ambassadorWixBlogV3Post.getPost(payload);
|
608
611
|
sideEffects?.onSiteCall?.();
|
609
612
|
try {
|
@@ -630,7 +633,7 @@ export async function getPost(postId, options) {
|
|
630
633
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
631
634
|
paths: [{ path: 'post.media.wixMedia.videoV2' }],
|
632
635
|
},
|
633
|
-
])
|
636
|
+
]))?.post;
|
634
637
|
}
|
635
638
|
catch (err) {
|
636
639
|
const transformedError = sdkTransformError(err, {
|
@@ -655,7 +658,6 @@ export async function getPost(postId, options) {
|
|
655
658
|
* @param slug - Slug of the post to retrieve.
|
656
659
|
* @public
|
657
660
|
* @requiredField slug
|
658
|
-
* @param options - Options specifying which fields to return.
|
659
661
|
* @permissionId BLOG.READ-PUBLICATION
|
660
662
|
* @permissionScope Read Blog
|
661
663
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -670,7 +672,10 @@ export async function getPost(postId, options) {
|
|
670
672
|
export async function getPostBySlug(slug, options) {
|
671
673
|
// @ts-ignore
|
672
674
|
const { httpClient, sideEffects } = arguments[2];
|
673
|
-
const payload = renameKeysFromSDKRequestToRESTRequest({
|
675
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
676
|
+
slug: slug,
|
677
|
+
fieldsets: options?.fieldsets,
|
678
|
+
});
|
674
679
|
const reqOpts = ambassadorWixBlogV3Post.getPostBySlug(payload);
|
675
680
|
sideEffects?.onSiteCall?.();
|
676
681
|
try {
|
@@ -697,7 +702,7 @@ export async function getPostBySlug(slug, options) {
|
|
697
702
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
698
703
|
paths: [{ path: 'post.media.wixMedia.videoV2' }],
|
699
704
|
},
|
700
|
-
])
|
705
|
+
]));
|
701
706
|
}
|
702
707
|
catch (err) {
|
703
708
|
const transformedError = sdkTransformError(err, {
|
@@ -717,7 +722,6 @@ export async function getPostBySlug(slug, options) {
|
|
717
722
|
* - `paging.limit` is `50`.
|
718
723
|
* - `paging.offset` is `0`.
|
719
724
|
* @public
|
720
|
-
* @param options - Sort, filter, and paging options.
|
721
725
|
* @permissionId BLOG.READ-PUBLICATION
|
722
726
|
* @permissionScope Read Blog
|
723
727
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
@@ -742,7 +746,7 @@ export async function listPosts(options) {
|
|
742
746
|
language: options?.language,
|
743
747
|
memberId: options?.memberId,
|
744
748
|
fieldsets: options?.fieldsets,
|
745
|
-
}
|
749
|
+
});
|
746
750
|
const reqOpts = ambassadorWixBlogV3Post.listPosts(payload);
|
747
751
|
sideEffects?.onSiteCall?.();
|
748
752
|
try {
|
@@ -769,7 +773,7 @@ export async function listPosts(options) {
|
|
769
773
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
770
774
|
paths: [{ path: 'posts.media.wixMedia.videoV2' }],
|
771
775
|
},
|
772
|
-
])
|
776
|
+
]));
|
773
777
|
}
|
774
778
|
catch (err) {
|
775
779
|
const transformedError = sdkTransformError(err, {
|
@@ -792,26 +796,23 @@ export async function listPosts(options) {
|
|
792
796
|
}
|
793
797
|
}
|
794
798
|
/**
|
795
|
-
*
|
796
|
-
*
|
797
|
-
*
|
798
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
799
|
-
*
|
800
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
801
|
-
*
|
802
|
-
* 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.
|
799
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
803
800
|
*
|
804
|
-
*
|
805
|
-
*
|
806
|
-
*
|
807
|
-
*
|
808
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
801
|
+
* Query Posts runs with these defaults, which you can override:
|
802
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
803
|
+
* - `paging.limit` is `50`.
|
804
|
+
* - `paging.offset` is `0`.
|
809
805
|
*
|
810
|
-
*
|
806
|
+
* For field support for filters and sorting, see
|
807
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
811
808
|
*
|
812
|
-
*
|
809
|
+
* To learn about working with _Query_ endpoints, see
|
810
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
811
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
812
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
813
|
+
* For a detailed list of supported filters and sortable fields, see
|
814
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
813
815
|
* @public
|
814
|
-
* @param options - Options specifying which fields to return.
|
815
816
|
* @permissionScope Read Blog
|
816
817
|
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
817
818
|
* @permissionScope Manage Blog
|
@@ -845,7 +846,10 @@ export function queryPosts(options) {
|
|
845
846
|
},
|
846
847
|
requestTransformer: (query) => {
|
847
848
|
const args = [query, options];
|
848
|
-
return renameKeysFromSDKRequestToRESTRequest({
|
849
|
+
return renameKeysFromSDKRequestToRESTRequest({
|
850
|
+
...args?.[1],
|
851
|
+
query: args?.[0],
|
852
|
+
});
|
849
853
|
},
|
850
854
|
responseTransformer: ({ data }) => {
|
851
855
|
const transformedData = renameKeysFromRESTResponseToSDKResponse(transformPaths(data, [
|
@@ -869,7 +873,7 @@ export function queryPosts(options) {
|
|
869
873
|
transformFn: transformRESTVideoV2ToSDKVideoV2,
|
870
874
|
paths: [{ path: 'posts.media.wixMedia.videoV2' }],
|
871
875
|
},
|
872
|
-
])
|
876
|
+
]));
|
873
877
|
return {
|
874
878
|
items: transformedData?.posts,
|
875
879
|
pagingMetadata: transformedData?.pagingMetadata,
|
@@ -908,13 +912,13 @@ export function queryPosts(options) {
|
|
908
912
|
export async function getPostMetrics(postId) {
|
909
913
|
// @ts-ignore
|
910
914
|
const { httpClient, sideEffects } = arguments[1];
|
911
|
-
const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId }
|
915
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId });
|
912
916
|
const reqOpts = ambassadorWixBlogV3Post.getPostMetrics(payload);
|
913
917
|
sideEffects?.onSiteCall?.();
|
914
918
|
try {
|
915
919
|
const result = await httpClient.request(reqOpts);
|
916
920
|
sideEffects?.onSuccess?.(result);
|
917
|
-
return renameKeysFromRESTResponseToSDKResponse(result.data
|
921
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
918
922
|
}
|
919
923
|
catch (err) {
|
920
924
|
const transformedError = sdkTransformError(err, {
|