@wix/auto_sdk_portfolio_project-items 1.0.23 → 1.0.24

package/build/es/index.typings.d.mts

@@ -286,19 +286,28 @@ interface BulkCreateProjectItemsRequest {
      * @maxSize 1000
      */
     items: Item[];
-    /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
+    /**
+     * Whether to return the created project items.
+     *
+     * Set to `true` to return the project items in the response.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean | null;
 }
 interface BulkCreateProjectItemsResponse {
-    /** Project items created by bulk action. */
+    /** List of individual Bulk Create Project Items results. */
     results?: BulkCreateProjectItemResult[];
-    /** Bulk action metadata. */
+    /** Total number of successes and failures for Bulk Create Project Items. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkCreateProjectItemResult {
-    /** Information about successful action or error for failure. */
+    /**
+     * Information about the created project item.
+     * Including its ID, index in the bulk request and whether it was successfully created.
+     */
     itemMetadata?: ItemMetadata;
-    /** Newly created project item. */
+    /** Created project item. Only returned if `returnEntity` is set to `true` in the request. */
     item?: Item;
 }
 interface ItemMetadata {
@@ -467,11 +476,17 @@ interface UpdateProjectItemResponse {
 }
 interface BulkUpdateProjectItemsRequest {
     /**
-     * items to be updated.
+     * Project items to update.
      * @maxSize 100
      */
     items?: MaskedItem[];
-    /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
+    /**
+     * Whether to return the updated project items.
+     *
+     * Set to `true` to return the project items in the response.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean | null;
 }
 interface MaskedItem {
@@ -479,15 +494,18 @@ interface MaskedItem {
     item?: Item;
 }
 interface BulkUpdateProjectItemsResponse {
-    /** Project items updated by bulk action. */
+    /** List of individual Bulk Update Project Items results. */
     results?: BulkUpdateProjectItemResult[];
-    /** Bulk action metadata. */
+    /** Total number of successes and failures for Bulk Update Project Items. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUpdateProjectItemResult {
-    /** Information about successful action or error for failure. */
+    /**
+     * Information about the updated project item.
+     * Including its ID, index in the bulk request and whether it was successfully updated.
+     */
     itemMetadata?: ItemMetadata;
-    /** Updated project item. */
+    /** Updated project item. Only returned if `returnEntity` is set to `true` in the request. */
     item?: Item;
 }
 interface DeleteProjectItemRequest {
@@ -511,7 +529,7 @@ interface DeleteProjectItemResponse {
 }
 interface BulkDeleteProjectItemsRequest {
     /**
-     * Project item IDs.
+     * IDs of project items to delete.
      * @format GUID
      * @minSize 1
      * @maxLength 100
@@ -519,16 +537,19 @@ interface BulkDeleteProjectItemsRequest {
     itemIds: string[];
 }
 interface BulkDeleteProjectItemsResponse {
-    /** Project items deleted by bulk action. */
+    /** List of individual Bulk Delete Project Items results. */
     results?: BulkDeleteProjectItemResult[];
-    /** Bulk action metadata. */
+    /** Total number of successes and failures for Bulk Delete Project Items. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkDeleteProjectItemResult {
-    /** Information about successful action or error for failure. */
+    /**
+     * Information about the deleted project item.
+     * Including its ID, index in the bulk request and whether it was successfully deleted.
+     */
     itemMetadata?: ItemMetadata;
     /**
-     * Project item ID.
+     * ID of the deleted project item.
      * @format GUID
      */
     itemId?: string;
@@ -834,6 +855,8 @@ declare function onProjectItemUpdated(handler: (event: ProjectItemUpdatedEnvelop
 declare function createProjectItem(item: Item): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `type`, 4>>;
 /**
  * Creates multiple project items.
+ *
+ * To create a single project item, call Create Project Item.
  * @public
  * @requiredField options.items
  * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE
@@ -848,7 +871,13 @@ interface BulkCreateProjectItemsOptions {
      * @maxSize 1000
      */
     items: Item[];
-    /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
+    /**
+     * Whether to return the created project items.
+     *
+     * Set to `true` to return the project items in the response.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean | null;
 }
 /**
@@ -934,6 +963,8 @@ interface UpdateProjectItem {
 }
 /**
  * Updates multiple project items.
+ *
+ * To update a single project item, call Update Project Item.
  * @public
  * @requiredField options.items.item
  * @requiredField options.items.item._id
@@ -944,11 +975,17 @@ interface UpdateProjectItem {
 declare function bulkUpdateProjectItems(options?: NonNullablePaths<BulkUpdateProjectItemsOptions, `items.${number}.item` | `items.${number}.item._id`, 5>): Promise<NonNullablePaths<BulkUpdateProjectItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.type` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkUpdateProjectItemsOptions {
     /**
-     * items to be updated.
+     * Project items to update.
      * @maxSize 100
      */
     items?: MaskedItem[];
-    /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
+    /**
+     * Whether to return the updated project items.
+     *
+     * Set to `true` to return the project items in the response.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean | null;
 }
 /**
@@ -963,6 +1000,8 @@ interface BulkUpdateProjectItemsOptions {
 declare function deleteProjectItem(itemId: string): Promise<NonNullablePaths<DeleteProjectItemResponse, `projectId` | `itemId`, 2>>;
 /**
  * Deletes multiple project items.
+ *
+ * To delete a single project item, call Delete Project Item.
  * @public
  * @requiredField options
  * @requiredField options.itemIds
@@ -973,7 +1012,7 @@ declare function deleteProjectItem(itemId: string): Promise<NonNullablePaths<Del
 declare function bulkDeleteProjectItems(options: NonNullablePaths<BulkDeleteProjectItemsOptions, `itemIds`, 2>): Promise<NonNullablePaths<BulkDeleteProjectItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.itemId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkDeleteProjectItemsOptions {
     /**
-     * Project item IDs.
+     * IDs of project items to delete.
      * @format GUID
      * @minSize 1
      * @maxLength 100