@wix/portfolio 1.0.10 → 1.0.12

package/build/cjs/src/portfolio-project-items-v1-project-item.types.d.ts

@@ -4,7 +4,7 @@ export interface Item extends ItemMetadataOneOf {
      * Id of the Project the items are part of
      * Project must exist before adding items to it. project can be created/updated/deleted using this //TODO
      */
-    projectId?: string;
+    projectId?: string | null;
     /**
      * Item ID.
      * @readonly
@@ -65,21 +65,10 @@ export declare enum Type {
     VIDEO = "VIDEO"
 }
 export interface Image {
-    /** Image info - Wix Media Image. Required. */
+    /** Image info - Wix Media Image. */
     imageInfo?: CommonImage;
     /** Focal point of the image. */
     focalPoint?: Point;
-    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
-    exif?: Record<string, any> | null;
-    /**
-     * Image compression level. <br />
-     *
-     * Min: `30` <br />
-     * Max: `100`
-     */
-    quality?: number | null;
-    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
-    unsharpMasking?: UnsharpMasking;
 }
 export declare enum ImageType {
     UNDEFINED = "UNDEFINED",
@@ -128,8 +117,7 @@ export interface UnsharpMasking {
     threshold?: number | null;
 }
 export interface Video {
-    type?: VideoType;
-    /** Video info - can include Wix Media or an external link from YouTube or Vimeo. Required. */
+    /** Video info - Wix Media Image. */
     videoInfo?: VideoV2;
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
@@ -141,9 +129,9 @@ export declare enum VideoType {
     VIMEO = "VIMEO"
 }
 export interface VideoV2 {
-    /** WixMedia ID. Required when associating an existing Wix Media video. */
+    /** WixMedia ID. Required. */
     id?: string;
-    /** Video URL. Required when associating a video from an external source (YouTube/Vimeo). */
+    /** Video URL. */
     url?: string;
     /** Available resolutions for the video, starting with the optimal resolution. */
     resolutions?: VideoResolution[];
@@ -170,6 +158,19 @@ export interface Tags {
     /** List of tags assigned to the media item. */
     values?: string[];
 }
+export interface GenerateTokenForProjectItemsRequest {
+    /** Media ids of requested project items */
+    mediaIds?: string[];
+}
+export interface GenerateTokenForProjectItemsResponse {
+    mediaTokens?: ProjectItemMediaToken[];
+}
+export interface ProjectItemMediaToken {
+    /** Media id of project item */
+    mediaId?: string;
+    /** Generated media token for project item */
+    mediaToken?: string;
+}
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /** tell us why you're invalidating the cache. You don't need to add your app name */
     reason?: string | null;
@@ -218,12 +219,10 @@ export interface URI {
     uriPath?: string;
 }
 export interface CreateProjectItemRequest {
-    projectId: string;
     /** Item to be created */
     item: Item;
 }
 export interface CreateProjectItemResponse {
-    projectId?: string;
     /** The created item */
     item?: Item;
 }
@@ -235,6 +234,7 @@ export interface BulkCreateProjectItemsRequest {
     projectId: string;
     /** items to be created. */
     items: Item[];
+    returnFullEntity?: boolean | null;
 }
 export interface BulkCreateProjectItemsResponse {
     /** Id of the Project the item is part of */
@@ -260,8 +260,11 @@ export interface ItemMetadata {
     error?: ApplicationError;
 }
 export interface ApplicationError {
+    /** Error code. */
     code?: string;
+    /** Description of the error. */
     description?: string;
+    /** Data related to the error. */
     data?: Record<string, any> | null;
 }
 export interface BulkActionMetadata {
@@ -273,14 +276,10 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface GetProjectItemRequest {
-    /** Id of the Project the item is part of */
-    projectId: string;
     /** Id of the ProjectItem to retrieve */
     itemId: string;
 }
 export interface GetProjectItemResponse {
-    /** Id of the Project the item is part of */
-    projectId?: string;
     /** The retrieved ProjectItem */
     item?: Item;
 }
@@ -297,8 +296,6 @@ export interface Paging {
     offset?: number | null;
 }
 export interface ListProjectItemsResponse {
-    /** Id of the Project the item is part of */
-    projectId?: string;
     /** ProjectItems retrieved */
     items?: Item[];
     /** Paging metadata */
@@ -327,8 +324,6 @@ export interface Cursors {
 export interface QueryProjectItemsRequest {
     /** WQL expression */
     query?: QueryV2;
-    /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
-    paging?: Paging;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
     /**
@@ -390,14 +385,10 @@ export interface QueryProjectItemsResponse {
     metadata?: PagingMetadataV2;
 }
 export interface UpdateProjectItemRequest {
-    /** Id of the Project the item is part of */
-    projectId: string;
     /** ProjectItem to be updated, may be partial */
     item: Item;
 }
 export interface UpdateProjectItemResponse {
-    /** Id of the Project the item is part of */
-    projectId?: string;
     /** The updated ProjectItem */
     item?: Item;
 }
@@ -405,7 +396,12 @@ export interface BulkUpdateProjectItemsRequest {
     /** Id of the Project the items are part of */
     projectId: string;
     /** items to be updated. */
-    items: Item[];
+    items?: Item[];
+    returnFullEntity?: boolean | null;
+}
+export interface MaskedItem {
+    item?: Item;
+    fieldMask?: string[];
 }
 export interface BulkUpdateProjectItemsResponse {
     /** Id of the Project the item is part of */
@@ -421,8 +417,6 @@ export interface BulkUpdateProjectItemResult {
     item?: Item;
 }
 export interface DeleteProjectItemRequest {
-    /** Id of the Project the item is part of */
-    projectId: string;
     /** Id of the Item to delete */
     itemId: string;
 }

package/build/cjs/src/portfolio-project-items-v1-project-item.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"portfolio-project-items-v1-project-item.types.js","sourceRoot":"","sources":["../../../src/portfolio-project-items-v1-project-item.types.ts"],"names":[],"mappings":";;;AA+DA,IAAY,IAIX;AAJD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uBAAe,CAAA;IACf,uBAAe,CAAA;AACjB,CAAC,EAJW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAIf;AAoBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AAsDD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAgQD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}
+{"version":3,"file":"portfolio-project-items-v1-project-item.types.js","sourceRoot":"","sources":["../../../src/portfolio-project-items-v1-project-item.types.ts"],"names":[],"mappings":";;;AA+DA,IAAY,IAIX;AAJD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uBAAe,CAAA;IACf,uBAAe,CAAA;AACjB,CAAC,EAJW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAIf;AASD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AAqDD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA0QD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}

package/build/cjs/src/portfolio-project-items-v1-project-item.universal.d.ts

@@ -10,7 +10,7 @@ export interface Item extends ItemMetadataOneOf {
      * Id of the Project the items are part of
      * Project must exist before adding items to it. project can be created/updated/deleted using this //TODO
      */
-    projectId?: string;
+    projectId?: string | null;
     /**
      * Item ID.
      * @readonly
@@ -71,21 +71,10 @@ export declare enum Type {
     VIDEO = "VIDEO"
 }
 export interface Image {
-    /** Image info - Wix Media Image. Required. */
+    /** Image info - Wix Media Image. */
     imageInfo?: string;
     /** Focal point of the image. */
     focalPoint?: Point;
-    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
-    exif?: Record<string, any> | null;
-    /**
-     * Image compression level. <br />
-     *
-     * Min: `30` <br />
-     * Max: `100`
-     */
-    quality?: number | null;
-    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
-    unsharpMasking?: UnsharpMasking;
 }
 export declare enum ImageType {
     UNDEFINED = "UNDEFINED",
@@ -117,8 +106,7 @@ export interface UnsharpMasking {
     threshold?: number | null;
 }
 export interface Video {
-    type?: VideoType;
-    /** Video info - can include Wix Media or an external link from YouTube or Vimeo. Required. */
+    /** Video info - Wix Media Image. */
     videoInfo?: string;
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
@@ -147,6 +135,19 @@ export interface Tags {
     /** List of tags assigned to the media item. */
     values?: string[];
 }
+export interface GenerateTokenForProjectItemsRequest {
+    /** Media ids of requested project items */
+    mediaIds?: string[];
+}
+export interface GenerateTokenForProjectItemsResponse {
+    mediaTokens?: ProjectItemMediaToken[];
+}
+export interface ProjectItemMediaToken {
+    /** Media id of project item */
+    mediaId?: string;
+    /** Generated media token for project item */
+    mediaToken?: string;
+}
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /** tell us why you're invalidating the cache. You don't need to add your app name */
     reason?: string | null;
@@ -195,12 +196,10 @@ export interface URI {
     uriPath?: string;
 }
 export interface CreateProjectItemRequest {
-    projectId: string;
     /** Item to be created */
     item: Item;
 }
 export interface CreateProjectItemResponse {
-    projectId?: string;
     /** The created item */
     item?: Item;
 }
@@ -212,6 +211,7 @@ export interface BulkCreateProjectItemsRequest {
     projectId: string;
     /** items to be created. */
     items: Item[];
+    returnFullEntity?: boolean | null;
 }
 export interface BulkCreateProjectItemsResponse {
     /** Id of the Project the item is part of */
@@ -237,8 +237,11 @@ export interface ItemMetadata {
     error?: ApplicationError;
 }
 export interface ApplicationError {
+    /** Error code. */
     code?: string;
+    /** Description of the error. */
     description?: string;
+    /** Data related to the error. */
     data?: Record<string, any> | null;
 }
 export interface BulkActionMetadata {
@@ -250,14 +253,10 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface GetProjectItemRequest {
-    /** Id of the Project the item is part of */
-    projectId: string;
     /** Id of the ProjectItem to retrieve */
     itemId: string;
 }
 export interface GetProjectItemResponse {
-    /** Id of the Project the item is part of */
-    projectId?: string;
     /** The retrieved ProjectItem */
     item?: Item;
 }
@@ -274,8 +273,6 @@ export interface Paging {
     offset?: number | null;
 }
 export interface ListProjectItemsResponse {
-    /** Id of the Project the item is part of */
-    projectId?: string;
     /** ProjectItems retrieved */
     items?: Item[];
     /** Paging metadata */
@@ -304,8 +301,6 @@ export interface Cursors {
 export interface QueryProjectItemsRequest {
     /** WQL expression */
     query?: QueryV2;
-    /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
-    paging?: Paging;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
     /**
@@ -367,14 +362,10 @@ export interface QueryProjectItemsResponse {
     metadata?: PagingMetadataV2;
 }
 export interface UpdateProjectItemRequest {
-    /** Id of the Project the item is part of */
-    projectId: string;
     /** ProjectItem to be updated, may be partial */
     item: Item;
 }
 export interface UpdateProjectItemResponse {
-    /** Id of the Project the item is part of */
-    projectId?: string;
     /** The updated ProjectItem */
     item?: Item;
 }
@@ -382,7 +373,12 @@ export interface BulkUpdateProjectItemsRequest {
     /** Id of the Project the items are part of */
     projectId: string;
     /** items to be updated. */
-    items: Item[];
+    items?: Item[];
+    returnFullEntity?: boolean | null;
+}
+export interface MaskedItem {
+    item?: Item;
+    fieldMask?: string[];
 }
 export interface BulkUpdateProjectItemsResponse {
     /** Id of the Project the item is part of */
@@ -398,8 +394,6 @@ export interface BulkUpdateProjectItemResult {
     item?: Item;
 }
 export interface DeleteProjectItemRequest {
-    /** Id of the Project the item is part of */
-    projectId: string;
     /** Id of the Item to delete */
     itemId: string;
 }
@@ -528,42 +522,40 @@ export interface DuplicateProjectItemsResponse {
  * Creates a new ProjectItem
  * @param item - Item to be created
  * @public
+ * @documentationMaturity preview
  * @requiredField item
- * @requiredField projectId
+ * @returns The created item
  */
-export declare function createProjectItem(projectId: string, item: Item): Promise<CreateProjectItemResponse>;
+export declare function createProjectItem(item: Item): Promise<Item>;
 /**
  * Create items in bulk
  * @param projectId - Id of the Project the items are part of
  * Project must exist before adding items to it. project can be created/updated/deleted using this //TODO
  * @public
- * @requiredField options
+ * @documentationMaturity preview
  * @requiredField options.items
  * @requiredField projectId
  */
-export declare function bulkCreateProjectItems(projectId: string, options: BulkCreateProjectItemsOptions): Promise<BulkCreateProjectItemsResponse>;
+export declare function bulkCreateProjectItems(projectId: string, options?: BulkCreateProjectItemsOptions): Promise<BulkCreateProjectItemsResponse>;
 export interface BulkCreateProjectItemsOptions {
     /** items to be created. */
     items: Item[];
+    returnFullEntity?: boolean | null;
 }
 /**
  * Get a ProjectItem by id
+ * @param itemId - Id of the ProjectItem to retrieve
  * @public
- * @requiredField identifiers
- * @requiredField identifiers.itemId
- * @requiredField identifiers.projectId
+ * @documentationMaturity preview
+ * @requiredField itemId
+ * @returns The retrieved ProjectItem
  */
-export declare function getProjectItem(identifiers: GetProjectItemIdentifiers): Promise<GetProjectItemResponse>;
-export interface GetProjectItemIdentifiers {
-    /** Id of the Project the item is part of */
-    projectId: string;
-    /** Id of the ProjectItem to retrieve */
-    itemId: string;
-}
+export declare function getProjectItem(itemId: string): Promise<Item>;
 /**
  * List all items in project
  * @param projectId - Id of the Project the item is part of
  * @public
+ * @documentationMaturity preview
  * @requiredField projectId
  */
 export declare function listProjectItems(projectId: string, options?: ListProjectItemsOptions): Promise<ListProjectItemsResponse>;
@@ -573,28 +565,20 @@ export interface ListProjectItemsOptions {
 }
 /**
  * Update a ProjectItem, supports partial update
+ * @param _id - Item ID.
  * @public
- * @requiredField identifiers
- * @requiredField identifiers.itemId
- * @requiredField identifiers.projectId
+ * @documentationMaturity preview
+ * @requiredField _id
  * @requiredField item
+ * @returns The updated ProjectItem
  */
-export declare function updateProjectItem(identifiers: UpdateProjectItemIdentifiers, item: UpdateProjectItem): Promise<UpdateProjectItemResponse>;
-export interface UpdateProjectItemIdentifiers {
-    /** Id of the Project the item is part of */
-    projectId: string;
-    /**
-     * Item ID.
-     * @readonly
-     */
-    itemId?: string | null;
-}
+export declare function updateProjectItem(_id: string | null, item: UpdateProjectItem): Promise<Item>;
 export interface UpdateProjectItem {
     /**
      * Id of the Project the items are part of
      * Project must exist before adding items to it. project can be created/updated/deleted using this //TODO
      */
-    projectId?: string;
+    projectId?: string | null;
     /**
      * Item ID.
      * @readonly
@@ -646,34 +630,31 @@ export interface UpdateProjectItem {
  * Update ProjectItems in bulk
  * @param projectId - Id of the Project the items are part of
  * @public
- * @requiredField options
- * @requiredField options.items
+ * @documentationMaturity preview
+ * @requiredField maskedItems.item
+ * @requiredField maskedItems.item._id
  * @requiredField options.items._id
  * @requiredField projectId
  */
-export declare function bulkUpdateProjectItems(projectId: string, options: BulkUpdateProjectItemsOptions): Promise<BulkUpdateProjectItemsResponse>;
+export declare function bulkUpdateProjectItems(projectId: string, options?: BulkUpdateProjectItemsOptions): Promise<BulkUpdateProjectItemsResponse>;
 export interface BulkUpdateProjectItemsOptions {
     /** items to be updated. */
-    items: Item[];
+    items?: Item[];
+    returnFullEntity?: boolean | null;
 }
 /**
  * Delete a ProjectItem
+ * @param itemId - Id of the Item to delete
  * @public
- * @requiredField identifiers
- * @requiredField identifiers.itemId
- * @requiredField identifiers.projectId
+ * @documentationMaturity preview
+ * @requiredField itemId
  */
-export declare function deleteProjectItem(identifiers: DeleteProjectItemIdentifiers): Promise<DeleteProjectItemResponse>;
-export interface DeleteProjectItemIdentifiers {
-    /** Id of the Project the item is part of */
-    projectId: string;
-    /** Id of the Item to delete */
-    itemId: string;
-}
+export declare function deleteProjectItem(itemId: string): Promise<DeleteProjectItemResponse>;
 /**
  * Delete items in bulk
  * @param projectId - Id of the project
  * @public
+ * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.itemIds
  * @requiredField projectId