@wix/auto_sdk_portfolio_project-items 1.0.16 → 1.0.18

package/build/internal/cjs/{portfolio-project-items-v1-project-item-project-items.universal-BMVN9bZC.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Item extends ItemMetadataOneOf {
     /** Information about the Wix Media image. */
     image?: Image;
@@ -70,6 +72,8 @@ declare enum ImageType {
     WIX_MEDIA = "WIX_MEDIA",
     EXTERNAL = "EXTERNAL"
 }
+/** @enumType */
+type ImageTypeWithLiterals = ImageType | 'UNDEFINED' | 'WIX_MEDIA' | 'EXTERNAL';
 interface Point {
     /** X-coordinate of the focal point. */
     x?: number;
@@ -377,20 +381,20 @@ interface QueryProjectItemsRequest {
     query?: QueryV2;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /** Paging options to limit and offset the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
      * Filter object.
      *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
      * Sort object.
      *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      */
     sort?: Sorting[];
     /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -400,7 +404,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
 }
 /** @oneof */
 interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /** Paging options to limit and offset the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
@@ -768,13 +772,69 @@ interface ProjectItemCreatedEnvelope {
     entity: Item;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a project item is created.
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionId PORTFOLIO.PROJECT_ITEM_READ
+ * @webhook
+ * @eventType wix.portfolio.project_items.v1.project_item_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onProjectItemCreated(handler: (event: ProjectItemCreatedEnvelope) => void | Promise<void>): void;
 interface ProjectItemDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a project item is deleted.
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionId PORTFOLIO.PROJECT_ITEM_READ
+ * @webhook
+ * @eventType wix.portfolio.project_items.v1.project_item_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onProjectItemDeleted(handler: (event: ProjectItemDeletedEnvelope) => void | Promise<void>): void;
 interface ProjectItemUpdatedEnvelope {
     entity: Item;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a project item is updated.
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionId PORTFOLIO.PROJECT_ITEM_READ
+ * @webhook
+ * @eventType wix.portfolio.project_items.v1.project_item_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onProjectItemUpdated(handler: (event: ProjectItemUpdatedEnvelope) => void | Promise<void>): void;
+type ProjectItemNonNullablePaths = `image.focalPoint.x` | `image.focalPoint.y` | `type`;
+/**
+ * Creates a project item.
+ * @param item - Project item to create.
+ * @public
+ * @requiredField item
+ * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE
+ * @applicableIdentity APP
+ * @returns Newly created project item.
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.CreateProjectItem
+ */
+declare function createProjectItem(item: Item): Promise<NonNullablePaths<Item, ProjectItemNonNullablePaths>>;
+/**
+ * Creates multiple project items.
+ * @public
+ * @requiredField options.items
+ * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.BulkCreateProjectItems
+ */
+declare function bulkCreateProjectItems(options?: NonNullablePaths<BulkCreateProjectItemsOptions, `items`>): Promise<NonNullablePaths<BulkCreateProjectItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in ProjectItemNonNullablePaths]: `results.${number}.item.${P}`;
+}[ProjectItemNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkCreateProjectItemsOptions {
     /**
      * Project items to create.
@@ -785,10 +845,47 @@ interface BulkCreateProjectItemsOptions {
     /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
     returnFullEntity?: boolean | null;
 }
+/**
+ * Retrieves a project item.
+ * @param itemId - Project item ID.
+ * @public
+ * @requiredField itemId
+ * @permissionId PORTFOLIO.PROJECT_ITEM_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Project item.
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.GetProjectItem
+ */
+declare function getProjectItem(itemId: string): Promise<NonNullablePaths<Item, ProjectItemNonNullablePaths>>;
+/**
+ * Retrieves a list of all project items in the specified project.
+ * @param projectId - Project ID.
+ * @public
+ * @requiredField projectId
+ * @permissionId PORTFOLIO.PROJECT_ITEM_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.ListProjectItems
+ */
+declare function listProjectItems(projectId: string, options?: ListProjectItemsOptions): Promise<NonNullablePaths<ListProjectItemsResponse, {
+    [P in ProjectItemNonNullablePaths]: `items.${number}.${P}`;
+}[ProjectItemNonNullablePaths]>>;
 interface ListProjectItemsOptions {
     /** Maximum number of items to return in the results. */
     paging?: Paging;
 }
+/**
+ * Updates a project item.
+ * @param _id - Project item ID.
+ * @public
+ * @requiredField _id
+ * @requiredField item
+ * @permissionId PORTFOLIO.PROJECT_ITEM_UPDATE
+ * @applicableIdentity APP
+ * @returns The updated project item.
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.UpdateProjectItem
+ */
+declare function updateProjectItem(_id: string, item: UpdateProjectItem): Promise<NonNullablePaths<Item, ProjectItemNonNullablePaths>>;
 interface UpdateProjectItem {
     /** Information about the Wix Media image. */
     image?: Image;
@@ -833,6 +930,18 @@ interface UpdateProjectItem {
     /** Project item link. */
     link?: Link;
 }
+/**
+ * Updates multiple project items.
+ * @public
+ * @requiredField options.items.item
+ * @requiredField options.items.item._id
+ * @permissionId PORTFOLIO.PROJECT_ITEM_UPDATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.BulkUpdateProjectItems
+ */
+declare function bulkUpdateProjectItems(options?: NonNullablePaths<BulkUpdateProjectItemsOptions, `items.${number}.item` | `items.${number}.item._id`>): Promise<NonNullablePaths<BulkUpdateProjectItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in ProjectItemNonNullablePaths]: `results.${number}.item.${P}`;
+}[ProjectItemNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkUpdateProjectItemsOptions {
     /**
      * items to be updated.
@@ -842,6 +951,26 @@ interface BulkUpdateProjectItemsOptions {
     /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
     returnFullEntity?: boolean | null;
 }
+/**
+ * Deletes a project item.
+ * @param itemId - ID of the project item to delete.
+ * @public
+ * @requiredField itemId
+ * @permissionId PORTFOLIO.PROJECT_ITEM_DELETE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.DeleteProjectItem
+ */
+declare function deleteProjectItem(itemId: string): Promise<NonNullablePaths<DeleteProjectItemResponse, `projectId` | `itemId`>>;
+/**
+ * Deletes multiple project items.
+ * @public
+ * @requiredField options
+ * @requiredField options.itemIds
+ * @permissionId PORTFOLIO.PROJECT_ITEM_DELETE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.BulkDeleteProjectItems
+ */
+declare function bulkDeleteProjectItems(options: NonNullablePaths<BulkDeleteProjectItemsOptions, `itemIds`>): 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`>>;
 interface BulkDeleteProjectItemsOptions {
     /**
      * Project item IDs.
@@ -851,6 +980,24 @@ interface BulkDeleteProjectItemsOptions {
      */
     itemIds: string[];
 }
+/**
+ * Duplicates project items from one project (the origin) to another project (the target).
+ *
+ * <blockquote class="important">
+ * <strong>Important:</strong>
+ *
+ * Both the origin and target projects must exist before calling this method.
+ * </blockquote>
+ * @param originProjectId - ID of the project containing the items to duplicate.
+ * @public
+ * @requiredField options
+ * @requiredField options.targetProjectId
+ * @requiredField originProjectId
+ * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.portfolio.projectitems.ProjectItemsService.DuplicateProjectItems
+ */
+declare function duplicateProjectItems(originProjectId: string, options: NonNullablePaths<DuplicateProjectItemsOptions, `targetProjectId`>): Promise<NonNullablePaths<DuplicateProjectItemsResponse, `projectId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface DuplicateProjectItemsOptions {
     /**
      * ID of the project where the duplicated items will be added.
@@ -858,5 +1005,15 @@ interface DuplicateProjectItemsOptions {
      */
     targetProjectId: string;
 }
+/**
+ * Generate media token for project items
+ * @param mediaIds - Media ids of requested project items
+ * @public
+ * @requiredField mediaIds
+ * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.portfolio.portfolioapp.MediaService.GenerateTokenForProjectItems
+ */
+declare function generateTokenForProjectItems(mediaIds: string[]): Promise<NonNullablePaths<GenerateTokenForProjectItemsResponse, `mediaTokens` | `mediaTokens.${number}.mediaId` | `mediaTokens.${number}.mediaToken`>>;
 
-export { type CursorPaging as $, type App as A, type BulkCreateProjectItemsOptions as B, type CustomTag as C, type DeleteProjectItemResponse as D, type ItemMetadata as E, type File as F, type GenerateTokenForProjectItemsResponse as G, type ApplicationError as H, type Item as I, type BulkActionMetadata as J, type GetProjectItemRequest as K, type ListProjectItemsOptions as L, type GetProjectItemResponse as M, type ListProjectItemsRequest as N, type Paging as O, type ProjectItemCreatedEnvelope as P, type PagingMetadataV2 as Q, type Cursors as R, SortOrder as S, Type as T, type UpdateProjectItem as U, type Video as V, WebhookIdentityType as W, type QueryProjectItemsRequest as X, type QueryV2 as Y, type QueryV2PagingMethodOneOf as Z, type Sorting as _, type BulkCreateProjectItemsResponse as a, type QueryProjectItemsResponse as a0, type UpdateProjectItemRequest as a1, type UpdateProjectItemResponse as a2, type BulkUpdateProjectItemsRequest as a3, type MaskedItem as a4, type BulkUpdateProjectItemResult as a5, type DeleteProjectItemRequest as a6, type BulkDeleteProjectItemsRequest as a7, type BulkDeleteProjectItemResult as a8, type CreateProjectGalleryRequest as a9, type CreateProjectGalleryResponse as aa, type DomainEvent as ab, type DomainEventBodyOneOf as ac, type EntityCreatedEvent as ad, type RestoreInfo as ae, type EntityUpdatedEvent as af, type EntityDeletedEvent as ag, type ActionEvent as ah, type Empty as ai, type DeletedProjectRestored as aj, type DuplicateProjectItemsRequest as ak, type MessageEnvelope as al, type IdentificationData as am, type IdentificationDataIdOneOf as an, type GenerateTokenForProjectItemsRequest as ao, type ProjectItemMediaToken as ap, type BaseEventMetadata as aq, type EventMetadata as ar, type ListProjectItemsResponse as b, type BulkUpdateProjectItemsOptions as c, type BulkUpdateProjectItemsResponse as d, type BulkDeleteProjectItemsOptions as e, type BulkDeleteProjectItemsResponse as f, type DuplicateProjectItemsOptions as g, type DuplicateProjectItemsResponse as h, type ProjectItemDeletedEnvelope as i, type ProjectItemUpdatedEnvelope as j, ImageType as k, type ItemMetadataOneOf as l, type Image as m, type Point as n, type UnsharpMasking as o, type VideoResolution as p, type Tags as q, type Link as r, type InvalidateCache as s, type InvalidateCacheGetByOneOf as t, type Page as u, type URI as v, type CreateProjectItemRequest as w, type CreateProjectItemResponse as x, type BulkCreateProjectItemsRequest as y, type BulkCreateProjectItemResult as z };
+export { type ActionEvent, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateProjectItemResult, type BulkCreateProjectItemsOptions, type BulkCreateProjectItemsRequest, type BulkCreateProjectItemsResponse, type BulkDeleteProjectItemResult, type BulkDeleteProjectItemsOptions, type BulkDeleteProjectItemsRequest, type BulkDeleteProjectItemsResponse, type BulkUpdateProjectItemResult, type BulkUpdateProjectItemsOptions, type BulkUpdateProjectItemsRequest, type BulkUpdateProjectItemsResponse, type CreateProjectGalleryRequest, type CreateProjectGalleryResponse, type CreateProjectItemRequest, type CreateProjectItemResponse, type CursorPaging, type Cursors, type CustomTag, type DeleteProjectItemRequest, type DeleteProjectItemResponse, type DeletedProjectRestored, type DomainEvent, type DomainEventBodyOneOf, type DuplicateProjectItemsOptions, type DuplicateProjectItemsRequest, type DuplicateProjectItemsResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type GenerateTokenForProjectItemsRequest, type GenerateTokenForProjectItemsResponse, type GetProjectItemRequest, type GetProjectItemResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, ImageType, type ImageTypeWithLiterals, type InvalidateCache, type InvalidateCacheGetByOneOf, type Item, type ItemMetadata, type ItemMetadataOneOf, type Link, type ListProjectItemsOptions, type ListProjectItemsRequest, type ListProjectItemsResponse, type MaskedItem, type MessageEnvelope, type Page, type Paging, type PagingMetadataV2, type Point, type ProjectItemCreatedEnvelope, type ProjectItemDeletedEnvelope, type ProjectItemMediaToken, type ProjectItemUpdatedEnvelope, type QueryProjectItemsRequest, type QueryProjectItemsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Tags, Type, type TypeWithLiterals, type URI, type UnsharpMasking, type UpdateProjectItem, type UpdateProjectItemRequest, type UpdateProjectItemResponse, type Video, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateProjectItems, bulkDeleteProjectItems, bulkUpdateProjectItems, createProjectItem, deleteProjectItem, duplicateProjectItems, generateTokenForProjectItems, getProjectItem, listProjectItems, onProjectItemCreated, onProjectItemDeleted, onProjectItemUpdated, updateProjectItem };