@wix/portfolio 1.0.62 → 1.0.63

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/portfolio",
-  "version": "1.0.62",
+  "version": "1.0.63",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "@wix/portfolio_collections": "1.0.13",
     "@wix/portfolio_project-in-collections": "1.0.13",
     "@wix/portfolio_project-items": "1.0.15",
-    "@wix/portfolio_projects": "1.0.14"
+    "@wix/portfolio_projects": "1.0.15"
   },
   "devDependencies": {
     "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "9b194ca6f1c7573e5442e09f049861c0d6ba74c183b0baf421f9e8ac"
+  "falconPackageHash": "e3ee25f64b51bcdfafe235b31550932a9a4b16ff09263051dfbf815d"
 }

package/type-bundles/context.bundle.d.ts

@@ -616,14 +616,14 @@ interface BulkCreateProjectItemsResponse {
     /** Array with all created items results. */
     results?: BulkCreateProjectItemResult[];
     /** Holds metadata of the entire bulk create operation */
-    bulkActionMetadata?: BulkActionMetadata;
+    bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkCreateProjectItemResult {
     /** Holds information about an item in bulk create - id, index in original request array, action successful, error (if failed) */
-    itemMetadata?: ItemMetadata;
+    itemMetadata?: ItemMetadata$1;
     item?: Item;
 }
-interface ItemMetadata {
+interface ItemMetadata$1 {
     /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
     _id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -631,9 +631,9 @@ interface ItemMetadata {
     /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
     success?: boolean;
     /** Details about the error in case of failure. */
-    error?: ApplicationError;
+    error?: ApplicationError$1;
 }
-interface ApplicationError {
+interface ApplicationError$1 {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -641,7 +641,7 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkActionMetadata {
+interface BulkActionMetadata$1 {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -649,7 +649,7 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface Paging {
+interface Paging$1 {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
@@ -691,11 +691,11 @@ interface BulkUpdateProjectItemsResponse {
     /** Array with all updated items results. */
     results?: BulkUpdateProjectItemResult[];
     /** Holds metadata of the entire bulk update operation */
-    bulkActionMetadata?: BulkActionMetadata;
+    bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkUpdateProjectItemResult {
     /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
-    itemMetadata?: ItemMetadata;
+    itemMetadata?: ItemMetadata$1;
     item?: Item;
 }
 interface DeleteProjectItemResponse {
@@ -708,11 +708,11 @@ interface BulkDeleteProjectItemsResponse {
     /** Array with all deleted items results */
     results?: BulkDeleteProjectItemResult[];
     /** Holds metadata of the entire bulk delete operation */
-    bulkActionMetadata?: BulkActionMetadata;
+    bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkDeleteProjectItemResult {
     /** Holds information about an item in bulk delete - id, index in original request array, action successful, error (if failed) */
-    itemMetadata?: ItemMetadata;
+    itemMetadata?: ItemMetadata$1;
     /** Id of the ProjectItem */
     itemId?: string;
 }
@@ -907,7 +907,7 @@ interface BulkCreateProjectItemsOptions {
 }
 interface ListProjectItemsOptions {
     /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
-    paging?: Paging;
+    paging?: Paging$1;
 }
 interface UpdateProjectItem {
     /** Information about the image. */
@@ -1249,10 +1249,115 @@ interface Cursors$1 {
     /** Cursor pointing to the previous page in the list of results. */
     prev?: string | null;
 }
+interface MaskedProject {
+    project?: Project$1;
+}
+interface BulkUpdateProjectsResponse {
+    /** Array with all updated items results. */
+    results?: BulkUpdateProjectsResult[];
+    /** Holds metadata of the entire bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateProjectsResult {
+    /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
+    itemMetadata?: ItemMetadata;
+    project?: Project$1;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
 interface DeleteProjectResponse {
     /** Id of the deleted Project */
     projectId?: string;
 }
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip 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 in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    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. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip 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;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface UpdateProjectOrderInCollectionResponse$1 {
+    /** project with new sort order set */
+    projectInCollection?: ProjectInCollection$1;
+}
+interface ProjectInCollection$1 {
+    /** Collection ID */
+    collectionId?: string;
+    /** Project */
+    project?: Project$1;
+    /** The sort order of the project in the given Collection */
+    sortOrder?: number | null;
+}
+interface QueryProjectWithCollectionInfoResponse {
+    /** The retrieved Projects in Collection */
+    projects?: ProjectInCollection$1[];
+    /** Paging metadata */
+    metadata?: PagingMetadataV2;
+}
 interface ListProjectsResponseNonNullableFields {
     projects: {
         coverImage?: {
@@ -1288,9 +1393,135 @@ interface ListProjectsResponseNonNullableFields {
         };
     }[];
 }
+interface BulkUpdateProjectsResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        project?: {
+            coverImage?: {
+                imageInfo: string;
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            coverVideo?: {
+                videoInfo: string;
+            };
+            collectionIds: string[];
+            details: {
+                text: string;
+                label: string;
+            }[];
+            url: string;
+            seoData?: {
+                tags: {
+                    type: string;
+                    children: string;
+                    custom: boolean;
+                    disabled: boolean;
+                }[];
+                settings?: {
+                    preventAutoRedirect: boolean;
+                    keywords: {
+                        term: string;
+                        isMain: boolean;
+                    }[];
+                };
+            };
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
 interface DeleteProjectResponseNonNullableFields {
     projectId: string;
 }
+interface UpdateProjectOrderInCollectionResponseNonNullableFields$1 {
+    projectInCollection?: {
+        collectionId: string;
+        project?: {
+            coverImage?: {
+                imageInfo: string;
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            coverVideo?: {
+                videoInfo: string;
+            };
+            collectionIds: string[];
+            details: {
+                text: string;
+                label: string;
+            }[];
+            url: string;
+            seoData?: {
+                tags: {
+                    type: string;
+                    children: string;
+                    custom: boolean;
+                    disabled: boolean;
+                }[];
+                settings?: {
+                    preventAutoRedirect: boolean;
+                    keywords: {
+                        term: string;
+                        isMain: boolean;
+                    }[];
+                };
+            };
+        };
+    };
+}
+interface QueryProjectWithCollectionInfoResponseNonNullableFields {
+    projects: {
+        collectionId: string;
+        project?: {
+            coverImage?: {
+                imageInfo: string;
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            coverVideo?: {
+                videoInfo: string;
+            };
+            collectionIds: string[];
+            details: {
+                text: string;
+                label: string;
+            }[];
+            url: string;
+            seoData?: {
+                tags: {
+                    type: string;
+                    children: string;
+                    custom: boolean;
+                    disabled: boolean;
+                }[];
+                settings?: {
+                    preventAutoRedirect: boolean;
+                    keywords: {
+                        term: string;
+                        isMain: boolean;
+                    }[];
+                };
+            };
+        };
+    }[];
+}
 interface BaseEventMetadata$1 {
     /** App instance ID. */
     instanceId?: string | null;
@@ -1402,6 +1633,11 @@ interface UpdateProject {
      */
     syncedProject?: boolean | null;
 }
+interface BulkUpdateProjectsOptions {
+    /** projects to be updated. */
+    projects?: MaskedProject[];
+    returnFullEntity?: boolean | null;
+}
 interface QueryProjectsOptions {
     includePageUrl?: boolean | null | undefined;
 }
@@ -1487,6 +1723,15 @@ interface ProjectsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ProjectsQueryResult>;
 }
+interface UpdateProjectOrderInCollectionIdentifiers$1 {
+    /** Id of the Project to update its order */
+    projectId: string;
+    /** Id of the collection in which the project will be re-ordered */
+    collectionId: string;
+}
+interface QueryProjectsWithCollectionInfoOptions {
+    includePageUrl?: boolean | null;
+}
 
 declare function createProject$1(httpClient: HttpClient): (project: Project$1) => Promise<Project$1 & {
     coverImage?: {
@@ -1588,8 +1833,11 @@ declare function updateProject$1(httpClient: HttpClient): (_id: string | null, p
         } | undefined;
     } | undefined;
 }>;
+declare function bulkUpdateProjects$1(httpClient: HttpClient): (options?: BulkUpdateProjectsOptions) => Promise<BulkUpdateProjectsResponse & BulkUpdateProjectsResponseNonNullableFields>;
 declare function deleteProject$1(httpClient: HttpClient): (projectId: string) => Promise<DeleteProjectResponse & DeleteProjectResponseNonNullableFields>;
 declare function queryProjects$1(httpClient: HttpClient): (options?: QueryProjectsOptions) => ProjectsQueryBuilder;
+declare function updateProjectOrderInCollection$3(httpClient: HttpClient): (identifiers: UpdateProjectOrderInCollectionIdentifiers$1, sortOrder: number | null) => Promise<UpdateProjectOrderInCollectionResponse$1 & UpdateProjectOrderInCollectionResponseNonNullableFields$1>;
+declare function queryProjectsWithCollectionInfo$1(httpClient: HttpClient): (query: QueryV2, options?: QueryProjectsWithCollectionInfoOptions) => Promise<QueryProjectWithCollectionInfoResponse & QueryProjectWithCollectionInfoResponseNonNullableFields>;
 declare const onProjectCreated$1: EventDefinition<ProjectCreatedEnvelope, "wix.portfolio.projects.v1.project_created">;
 declare const onProjectUpdated$1: EventDefinition<ProjectUpdatedEnvelope, "wix.portfolio.projects.v1.project_updated">;
 declare const onProjectDeleted$1: EventDefinition<ProjectDeletedEnvelope, "wix.portfolio.projects.v1.project_deleted">;
@@ -1598,12 +1846,16 @@ declare const createProject: BuildRESTFunction<typeof createProject$1>;
 declare const getProject: BuildRESTFunction<typeof getProject$1>;
 declare const listProjects: BuildRESTFunction<typeof listProjects$1>;
 declare const updateProject: BuildRESTFunction<typeof updateProject$1>;
+declare const bulkUpdateProjects: BuildRESTFunction<typeof bulkUpdateProjects$1>;
 declare const deleteProject: BuildRESTFunction<typeof deleteProject$1>;
 declare const queryProjects: BuildRESTFunction<typeof queryProjects$1>;
+declare const updateProjectOrderInCollection$2: BuildRESTFunction<typeof updateProjectOrderInCollection$3>;
+declare const queryProjectsWithCollectionInfo: BuildRESTFunction<typeof queryProjectsWithCollectionInfo$1>;
 declare const onProjectCreated: BuildEventDefinition<typeof onProjectCreated$1>;
 declare const onProjectUpdated: BuildEventDefinition<typeof onProjectUpdated$1>;
 declare const onProjectDeleted: BuildEventDefinition<typeof onProjectDeleted$1>;
 
+declare const context$1_bulkUpdateProjects: typeof bulkUpdateProjects;
 declare const context$1_createProject: typeof createProject;
 declare const context$1_deleteProject: typeof deleteProject;
 declare const context$1_getProject: typeof getProject;
@@ -1612,9 +1864,10 @@ declare const context$1_onProjectCreated: typeof onProjectCreated;
 declare const context$1_onProjectDeleted: typeof onProjectDeleted;
 declare const context$1_onProjectUpdated: typeof onProjectUpdated;
 declare const context$1_queryProjects: typeof queryProjects;
+declare const context$1_queryProjectsWithCollectionInfo: typeof queryProjectsWithCollectionInfo;
 declare const context$1_updateProject: typeof updateProject;
 declare namespace context$1 {
-  export { context$1_createProject as createProject, context$1_deleteProject as deleteProject, context$1_getProject as getProject, context$1_listProjects as listProjects, context$1_onProjectCreated as onProjectCreated, context$1_onProjectDeleted as onProjectDeleted, context$1_onProjectUpdated as onProjectUpdated, context$1_queryProjects as queryProjects, context$1_updateProject as updateProject };
+  export { context$1_bulkUpdateProjects as bulkUpdateProjects, context$1_createProject as createProject, context$1_deleteProject as deleteProject, context$1_getProject as getProject, context$1_listProjects as listProjects, context$1_onProjectCreated as onProjectCreated, context$1_onProjectDeleted as onProjectDeleted, context$1_onProjectUpdated as onProjectUpdated, context$1_queryProjects as queryProjects, context$1_queryProjectsWithCollectionInfo as queryProjectsWithCollectionInfo, context$1_updateProject as updateProject, updateProjectOrderInCollection$2 as updateProjectOrderInCollection };
 }
 
 interface ProjectInCollection {