@wix/blog - npm Package Compare versions

Comparing version 1.0.201 to 1.0.202

build/cjs/src/blog-v3-draft.http.d.ts

@@ -20,3 +20,8 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
 export declare function listDeletedDraftPosts(payload: ListDeletedDraftPostsRequest): RequestOptionsFactory<ListDeletedDraftPostsResponse & ListDeletedDraftPostsResponseNonNullableFields>;
-/** Gets a draft post by the provided ID. */
+/**
+ * Gets a draft post by the provided ID.
+ *
+ *
+ * Uses the provided `draftPostId` to retrieve a draft post.
+ */
 export declare function getDraftPost(payload: GetDraftPostRequest): RequestOptionsFactory<GetDraftPostResponse & GetDraftPostResponseNonNullableFields>;
@@ -27,3 +32,3 @@ /** Updates a specified draft post. */
  * Moves a draft post with the provided ID to the trash bin.
- * A published posts can also be deleted by its provided `draftPostId`.
+ * A published post can also be deleted by its provided `draftPostId`.
  *
@@ -33,3 +38,8 @@ * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
 export declare function deleteDraftPost(payload: DeleteDraftPostRequest): RequestOptionsFactory<DeleteDraftPostResponse>;
-/** Permanently deletes a draft post by the provided ID from the trash bin. */
+/**
+ * Permanently deletes a draft post by the provided ID from the trash bin.
+ *
+ *
+ * Deleting a draft post from the trash bin is permanent and cannot be reversed.
+ */
 export declare function removeFromTrashBin(payload: RemoveFromTrashBinRequest): RequestOptionsFactory<RemoveFromTrashBinResponse>;
@@ -45,5 +55,15 @@ /**
 export declare function listDraftPosts(payload: ListDraftPostsRequest): RequestOptionsFactory<ListDraftPostsResponse & ListDraftPostsResponseNonNullableFields>;
-/** Gets a deleted draft post from the trash bin by the provided ID. */
+/**
+ * Gets a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Retrieves a previously deleted draft post from the trash bin using it's `draftPostId`.
+ */
 export declare function getDeletedDraftPost(payload: GetDeletedDraftPostRequest): RequestOptionsFactory<GetDeletedDraftPostResponse & GetDeletedDraftPostResponseNonNullableFields>;
-/** Restores a deleted draft post from the trash-bin by the provided ID. */
+/**
+ * Restores a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Use the `draftPostId` to restore a draft post from the trash bin.
+ */
 export declare function restoreFromTrashBin(payload: RestoreFromTrashBinRequest): RequestOptionsFactory<RestoreFromTrashBinResponse & RestoreFromTrashBinResponseNonNullableFields>;
@@ -61,4 +81,6 @@ /**
  * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
+ *
+ *
  * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
  */
 export declare function publishDraftPost(payload: PublishDraftPostRequest): RequestOptionsFactory<PublishDraftPostResponse & PublishDraftPostResponseNonNullableFields>;

build/cjs/src/blog-v3-draft.http.js

@@ -442,3 +442,8 @@ "use strict";
 exports.listDeletedDraftPosts = listDeletedDraftPosts;
-/** Gets a draft post by the provided ID. */
+/**
+ * Gets a draft post by the provided ID.
+ *
+ *
+ * Uses the provided `draftPostId` to retrieve a draft post.
+ */
 function getDraftPost(payload) {
@@ -589,3 +594,3 @@ const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getDraftPostRequest, {});
  * Moves a draft post with the provided ID to the trash bin.
- * A published posts can also be deleted by its provided `draftPostId`.
+ * A published post can also be deleted by its provided `draftPostId`.
  *
@@ -617,3 +622,8 @@ * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
 exports.deleteDraftPost = deleteDraftPost;
-/** Permanently deletes a draft post by the provided ID from the trash bin. */
+/**
+ * Permanently deletes a draft post by the provided ID from the trash bin.
+ *
+ *
+ * Deleting a draft post from the trash bin is permanent and cannot be reversed.
+ */
 function removeFromTrashBin(payload) {
@@ -701,3 +711,8 @@ const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_removeFromTrashBinRequest, {});
 exports.listDraftPosts = listDraftPosts;
-/** Gets a deleted draft post from the trash bin by the provided ID. */
+/**
+ * Gets a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Retrieves a previously deleted draft post from the trash bin using it's `draftPostId`.
+ */
 function getDeletedDraftPost(payload) {
@@ -758,3 +773,8 @@ const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getDeletedDraftPostRequest, {});
 exports.getDeletedDraftPost = getDeletedDraftPost;
-/** Restores a deleted draft post from the trash-bin by the provided ID. */
+/**
+ * Restores a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Use the `draftPostId` to restore a draft post from the trash bin.
+ */
 function restoreFromTrashBin(payload) {
@@ -876,2 +896,4 @@ const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_restoreFromTrashBinRequest, {});
  * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
+ *
+ *
  * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
@@ -878,0 +900,0 @@ */

build/cjs/src/blog-v3-draft.universal.js

@@ -780,2 +780,5 @@ "use strict";
  * Gets a draft post by the provided ID.
+ *
+ *
+ * Uses the provided `draftPostId` to retrieve a draft post.
  * @param draftPostId - Draft post ID.
@@ -935,3 +938,3 @@ * @public
  * Moves a draft post with the provided ID to the trash bin.
- * A published posts can also be deleted by its provided `draftPostId`.
+ * A published post can also be deleted by its provided `draftPostId`.
  *
@@ -997,2 +1000,5 @@ * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
  * Permanently deletes a draft post by the provided ID from the trash bin.
+ *
+ *
+ * Deleting a draft post from the trash bin is permanent and cannot be reversed.
  * @param draftPostId - Draft post ID.
@@ -1122,2 +1128,5 @@ * @public
  * Gets a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Retrieves a previously deleted draft post from the trash bin using it's `draftPostId`.
  * @param draftPostId - Draft post ID.
@@ -1183,3 +1192,6 @@ * @public
 /**
- * Restores a deleted draft post from the trash-bin by the provided ID.
+ * Restores a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Use the `draftPostId` to restore a draft post from the trash bin.
  * @param draftPostId - Draft post ID.
@@ -1319,2 +1331,4 @@ * @public
  * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
+ *
+ *
  * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
@@ -1321,0 +1335,0 @@ * @param draftPostId - Draft post ID.

build/es/src/blog-v3-draft.http.d.ts

@@ -20,3 +20,8 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
 export declare function listDeletedDraftPosts(payload: ListDeletedDraftPostsRequest): RequestOptionsFactory<ListDeletedDraftPostsResponse & ListDeletedDraftPostsResponseNonNullableFields>;
-/** Gets a draft post by the provided ID. */
+/**
+ * Gets a draft post by the provided ID.
+ *
+ *
+ * Uses the provided `draftPostId` to retrieve a draft post.
+ */
 export declare function getDraftPost(payload: GetDraftPostRequest): RequestOptionsFactory<GetDraftPostResponse & GetDraftPostResponseNonNullableFields>;
@@ -27,3 +32,3 @@ /** Updates a specified draft post. */
  * Moves a draft post with the provided ID to the trash bin.
- * A published posts can also be deleted by its provided `draftPostId`.
+ * A published post can also be deleted by its provided `draftPostId`.
  *
@@ -33,3 +38,8 @@ * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
 export declare function deleteDraftPost(payload: DeleteDraftPostRequest): RequestOptionsFactory<DeleteDraftPostResponse>;
-/** Permanently deletes a draft post by the provided ID from the trash bin. */
+/**
+ * Permanently deletes a draft post by the provided ID from the trash bin.
+ *
+ *
+ * Deleting a draft post from the trash bin is permanent and cannot be reversed.
+ */
 export declare function removeFromTrashBin(payload: RemoveFromTrashBinRequest): RequestOptionsFactory<RemoveFromTrashBinResponse>;
@@ -45,5 +55,15 @@ /**
 export declare function listDraftPosts(payload: ListDraftPostsRequest): RequestOptionsFactory<ListDraftPostsResponse & ListDraftPostsResponseNonNullableFields>;
-/** Gets a deleted draft post from the trash bin by the provided ID. */
+/**
+ * Gets a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Retrieves a previously deleted draft post from the trash bin using it's `draftPostId`.
+ */
 export declare function getDeletedDraftPost(payload: GetDeletedDraftPostRequest): RequestOptionsFactory<GetDeletedDraftPostResponse & GetDeletedDraftPostResponseNonNullableFields>;
-/** Restores a deleted draft post from the trash-bin by the provided ID. */
+/**
+ * Restores a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Use the `draftPostId` to restore a draft post from the trash bin.
+ */
 export declare function restoreFromTrashBin(payload: RestoreFromTrashBinRequest): RequestOptionsFactory<RestoreFromTrashBinResponse & RestoreFromTrashBinResponseNonNullableFields>;
@@ -61,4 +81,6 @@ /**
  * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
+ *
+ *
  * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
  */
 export declare function publishDraftPost(payload: PublishDraftPostRequest): RequestOptionsFactory<PublishDraftPostResponse & PublishDraftPostResponseNonNullableFields>;

build/es/src/blog-v3-draft.http.js

@@ -436,3 +436,8 @@ import { toURLSearchParams } from '@wix/metro-runtime';
 }
-/** Gets a draft post by the provided ID. */
+/**
+ * Gets a draft post by the provided ID.
+ *
+ *
+ * Uses the provided `draftPostId` to retrieve a draft post.
+ */
 export function getDraftPost(payload) {
@@ -581,3 +586,3 @@ const { toJSON: toReq, fromJSON: fromReq } = serializer(_getDraftPostRequest, {});
  * Moves a draft post with the provided ID to the trash bin.
- * A published posts can also be deleted by its provided `draftPostId`.
+ * A published post can also be deleted by its provided `draftPostId`.
  *
@@ -608,3 +613,8 @@ * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
 }
-/** Permanently deletes a draft post by the provided ID from the trash bin. */
+/**
+ * Permanently deletes a draft post by the provided ID from the trash bin.
+ *
+ *
+ * Deleting a draft post from the trash bin is permanent and cannot be reversed.
+ */
 export function removeFromTrashBin(payload) {
@@ -690,3 +700,8 @@ const { toJSON: toReq, fromJSON: fromReq } = serializer(_removeFromTrashBinRequest, {});
 }
-/** Gets a deleted draft post from the trash bin by the provided ID. */
+/**
+ * Gets a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Retrieves a previously deleted draft post from the trash bin using it's `draftPostId`.
+ */
 export function getDeletedDraftPost(payload) {
@@ -746,3 +761,8 @@ const { toJSON: toReq, fromJSON: fromReq } = serializer(_getDeletedDraftPostRequest, {});
 }
-/** Restores a deleted draft post from the trash-bin by the provided ID. */
+/**
+ * Restores a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Use the `draftPostId` to restore a draft post from the trash bin.
+ */
 export function restoreFromTrashBin(payload) {
@@ -862,2 +882,4 @@ const { toJSON: toReq, fromJSON: fromReq } = serializer(_restoreFromTrashBinRequest, {});
  * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
+ *
+ *
  * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
@@ -864,0 +886,0 @@ */

build/es/src/blog-v3-draft.universal.js

@@ -755,2 +755,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
  * Gets a draft post by the provided ID.
+ *
+ *
+ * Uses the provided `draftPostId` to retrieve a draft post.
  * @param draftPostId - Draft post ID.
@@ -908,3 +911,3 @@ * @public
  * Moves a draft post with the provided ID to the trash bin.
- * A published posts can also be deleted by its provided `draftPostId`.
+ * A published post can also be deleted by its provided `draftPostId`.
  *
@@ -969,2 +972,5 @@ * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
  * Permanently deletes a draft post by the provided ID from the trash bin.
+ *
+ *
+ * Deleting a draft post from the trash bin is permanent and cannot be reversed.
  * @param draftPostId - Draft post ID.
@@ -1092,2 +1098,5 @@ * @public
  * Gets a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Retrieves a previously deleted draft post from the trash bin using it's `draftPostId`.
  * @param draftPostId - Draft post ID.
@@ -1152,3 +1161,6 @@ * @public
 /**
- * Restores a deleted draft post from the trash-bin by the provided ID.
+ * Restores a deleted draft post from the trash bin by the provided ID.
+ *
+ *
+ * Use the `draftPostId` to restore a draft post from the trash bin.
  * @param draftPostId - Draft post ID.
@@ -1286,2 +1298,4 @@ * @public
  * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
+ *
+ *
  * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
@@ -1288,0 +1302,0 @@ * @param draftPostId - Draft post ID.

package.json

 {
   "name": "@wix/blog",
-  "version": "1.0.201",
+  "version": "1.0.202",
   "publishConfig": {
@@ -37,3 +37,3 @@ "registry": "https://registry.npmjs.org/",
   },
-  "falconPackageHash": "eb2d1888c71819a229b00398462764fd865085cc46b77c6defb26a49"
+  "falconPackageHash": "ad4412545b8d7f1f18ed6c9188924ff4b051f2244671712e977425f4"
 }

No alert changes

Improved metrics

Total package byte prevSize

3090473

increased by0.09%

Lines of code

77312

increased by0.19%

No dependency changes