@wix/auto_sdk_portfolio_projects 1.0.0 → 1.0.2

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

@@ -6,6 +6,7 @@ export interface Project extends ProjectCoverOneOf {
     /**
      * Project ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /**
@@ -13,13 +14,20 @@ export interface Project extends ProjectCoverOneOf {
      * @readonly
      */
     revision?: string | null;
-    /** Project title. */
+    /**
+     * Project title.
+     * @maxLength 100
+     */
     title?: string | null;
     /** Project description. */
     description?: string | null;
     /** Whether the project is hidden from the portfolio. Default: `false` */
     hidden?: boolean | null;
-    /** IDs of the collections that include the project. */
+    /**
+     * IDs of the collections that include the project.
+     * @format GUID
+     * @maxSize 1000
+     */
     collectionIds?: string[];
     /** Project details. */
     details?: ProjectDetail[];
@@ -36,7 +44,7 @@ export interface Project extends ProjectCoverOneOf {
      */
     _updatedDate?: Date | null;
     /**
-     * Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.
+     * Project page URL and relative path. Returned when `includePageUrl` is `true` in the request.
      * @readonly
      */
     url?: string;
@@ -73,6 +81,7 @@ export interface UnsharpMasking {
      *
      * Min: `0` <br />
      * Max: `5`
+     * @max 5
      */
     amount?: number | null;
     /** Unsharp masking radius in pixels. Controls the sharpening width. */
@@ -82,6 +91,7 @@ export interface UnsharpMasking {
      *
      * Min: `0` <br />
      * Max: `1`
+     * @max 1
      */
     threshold?: number | null;
 }
@@ -129,7 +139,10 @@ export interface ProjectDetailValueOneOf {
 export interface DetailsLink {
     /** Display text of the link. */
     text?: string | null;
-    /** Target URL of the link. */
+    /**
+     * Target URL of the link.
+     * @format WEB_URL
+     */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of:
@@ -139,15 +152,31 @@ export interface DetailsLink {
     target?: string | null;
 }
 export interface ProjectSource {
-    /** App definition id */
+    /**
+     * App definition id
+     * @immutable
+     */
     appDefId?: string;
-    /** External source id */
+    /**
+     * External source id
+     * @immutable
+     */
     externalId?: string;
-    /** Source name */
+    /**
+     * Source name
+     * @maxLength 100
+     * @immutable
+     */
     sourceName?: string;
-    /** Source description */
+    /**
+     * Source description
+     * @immutable
+     */
     description?: string | null;
-    /** link to external source */
+    /**
+     * link to external source
+     * @format WEB_URL
+     */
     link?: string | null;
     /** Sync status */
     syncStatus?: SyncStatus;
@@ -177,7 +206,10 @@ export interface Keyword {
     term?: string;
     /** Whether the keyword is the main focus keyword. */
     isMain?: boolean;
-    /** The source that added the keyword terms to the SEO settings. */
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
     origin?: string | null;
 }
 export interface Tag {
@@ -210,7 +242,10 @@ export interface Settings {
      * Default: `false` (Auto Redirect is enabled.)
      */
     preventAutoRedirect?: boolean;
-    /** User-selected keyword terms for a specific page. */
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
     keywords?: Keyword[];
 }
 export interface MenuSettingUpdatedEvent {
@@ -230,7 +265,10 @@ export interface GetProjectPageDataResponse {
     nextProject?: ProjectSlug;
 }
 export interface ProjectSlug {
-    /** Project id */
+    /**
+     * Project id
+     * @format GUID
+     */
     projectId?: string;
     /** Project slug */
     slug?: string;
@@ -270,7 +308,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     studioAssigned?: StudioAssigned;
     /** Emitted when Studio is detached. */
     studioUnassigned?: StudioUnassigned;
-    /** A meta site id. */
+    /**
+     * A meta site id.
+     * @format GUID
+     */
     metaSiteId?: string;
     /** A meta site version. Monotonically increasing. */
     version?: string;
@@ -279,6 +320,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     /**
      * TODO(meta-site): Change validation once validations are disabled for consumers
      * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     * @maxSize 4000
      */
     assets?: Asset[];
 }
@@ -316,9 +358,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
     studioUnassigned?: StudioUnassigned;
 }
 export interface Asset {
-    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    /**
+     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** An instance id. For legacy reasons may be UUID or a string. */
+    /**
+     * An instance id. For legacy reasons may be UUID or a string.
+     * @maxLength 200
+     */
     instanceId?: string;
     /** An application state. */
     state?: State;
@@ -331,9 +379,15 @@ export declare enum State {
     DEMO = "DEMO"
 }
 export interface SiteCreated {
-    /** A template identifier (empty if not created from a template). */
+    /**
+     * A template identifier (empty if not created from a template).
+     * @maxLength 36
+     */
     originTemplateId?: string;
-    /** An account id of the owner. */
+    /**
+     * An account id of the owner.
+     * @format GUID
+     */
     ownerId?: string;
     /** A context in which meta site was created. */
     context?: SiteCreatedContext;
@@ -342,9 +396,13 @@ export interface SiteCreated {
      *
      * In case of a creation from a template it's a template id.
      * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     * @format GUID
      */
     originMetaSiteId?: string | null;
-    /** A meta site name (URL slug). */
+    /**
+     * A meta site name (URL slug).
+     * @maxLength 20
+     */
     siteName?: string;
     /** A namespace. */
     namespace?: Namespace;
@@ -441,9 +499,15 @@ export declare enum Namespace {
 }
 /** Site transferred to another user. */
 export interface SiteTransferred {
-    /** A previous owner id (user that transfers meta site). */
+    /**
+     * A previous owner id (user that transfers meta site).
+     * @format GUID
+     */
     oldOwnerId?: string;
-    /** A new owner id (user that accepts meta site). */
+    /**
+     * A new owner id (user that accepts meta site).
+     * @format GUID
+     */
     newOwnerId?: string;
 }
 /** Soft deletion of the meta site. Could be restored. */
@@ -456,9 +520,15 @@ export interface DeleteContext {
     dateDeleted?: Date | null;
     /** A status. */
     deleteStatus?: DeleteStatus;
-    /** A reason (flow). */
+    /**
+     * A reason (flow).
+     * @maxLength 255
+     */
     deleteOrigin?: string;
-    /** A service that deleted it. */
+    /**
+     * A service that deleted it.
+     * @maxLength 255
+     */
     initiatorId?: string | null;
 }
 export declare enum DeleteStatus {
@@ -474,7 +544,11 @@ export interface SiteUndeleted {
 export interface SitePublished {
 }
 export interface SiteUnpublished {
-    /** A list of URLs previously associated with the meta site. */
+    /**
+     * A list of URLs previously associated with the meta site.
+     * @maxLength 4000
+     * @maxSize 10000
+     */
     urls?: string[];
 }
 export interface SiteMarkedAsTemplate {
@@ -497,30 +571,60 @@ export interface SiteMarkedAsWixSite {
  * To ensure this, the TPA on the template gets a new instance_id.
  */
 export interface ServiceProvisioned {
-    /** Either UUID or EmbeddedServiceType. */
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** Not only UUID. Something here could be something weird. */
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
     instanceId?: string;
-    /** An instance id from which this instance is originated. */
+    /**
+     * An instance id from which this instance is originated.
+     * @maxLength 36
+     */
     originInstanceId?: string;
-    /** A version. */
+    /**
+     * A version.
+     * @maxLength 500
+     */
     version?: string | null;
-    /** The origin meta site id */
+    /**
+     * The origin meta site id
+     * @format GUID
+     */
     originMetaSiteId?: string | null;
 }
 export interface ServiceRemoved {
-    /** Either UUID or EmbeddedServiceType. */
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** Not only UUID. Something here could be something weird. */
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
     instanceId?: string;
-    /** A version. */
+    /**
+     * A version.
+     * @maxLength 500
+     */
     version?: string | null;
 }
 /** Rename of the site. Meaning, free public url has been changed as well. */
 export interface SiteRenamed {
-    /** A new meta site name (URL slug). */
+    /**
+     * A new meta site name (URL slug).
+     * @maxLength 20
+     */
     newSiteName?: string;
-    /** A previous meta site name (URL slug). */
+    /**
+     * A previous meta site name (URL slug).
+     * @maxLength 255
+     */
     oldSiteName?: string;
 }
 /**
@@ -547,9 +651,15 @@ export interface StudioUnassigned {
 export interface Empty {
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -557,26 +667,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -587,9 +721,15 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -599,7 +739,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     uri?: URI;
     /** Invalidate by file (for media files such as PDFs) */
     file?: File;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    /**
+     * tell us why you're invalidating the cache. You don't need to add your app name
+     * @maxLength 256
+     */
     reason?: string | null;
     /** Is local DS */
     localDc?: boolean;
@@ -607,9 +750,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
 }
 /** @oneof */
 export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -621,37 +770,71 @@ export interface InvalidateCacheGetByOneOf {
     file?: File;
 }
 export interface App {
-    /** The AppDefId */
+    /**
+     * The AppDefId
+     * @minLength 1
+     */
     appDefId?: string;
-    /** The instance Id */
+    /**
+     * The instance Id
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface Page {
-    /** the msid the page is on */
+    /**
+     * the msid the page is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Page ID */
+    /**
+     * Invalidate by Page ID
+     * @minLength 1
+     */
     pageId?: string;
 }
 export interface URI {
-    /** the msid the URI is on */
+    /**
+     * the msid the URI is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    /**
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
+     */
     uriPath?: string;
 }
 export interface File {
-    /** the msid the file is related to */
+    /**
+     * the msid the file is related to
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by filename (for media files such as PDFs) */
+    /**
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
+     */
     fileName?: string;
 }
 export interface SyncProjectWithCollectionMappings {
-    /** Id of recently updated Project */
+    /**
+     * Id of recently updated Project
+     * @format GUID
+     */
     projectId?: string;
-    /** fields that were updated in the given project */
+    /**
+     * fields that were updated in the given project
+     * @maxSize 100
+     */
     fieldMaskPaths?: string[];
 }
 export interface DeletedProjectRestored {
-    /** the id of the project that was restored */
+    /**
+     * the id of the project that was restored
+     * @format GUID
+     */
     projectId?: string;
     /** timestamp for when the project was originally deleted. */
     deletionTimestamp?: Date | null;
@@ -665,7 +848,10 @@ export interface CreateProjectResponse {
     project?: Project;
 }
 export interface GetProjectRequest {
-    /** ID of the project to retrieve. */
+    /**
+     * ID of the project to retrieve.
+     * @format GUID
+     */
     projectId: string;
     /** Whether to include the project's relative path and full URL in the response. Default: `false` */
     includePageUrl?: boolean | null;
@@ -681,13 +867,17 @@ export interface ListProjectsRequest {
     includePageUrl?: boolean | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -710,9 +900,15 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface UpdateProjectRequest {
@@ -724,7 +920,10 @@ export interface UpdateProjectResponse {
     project?: Project;
 }
 export interface BulkUpdateProjectsRequest {
-    /** Projects to update. */
+    /**
+     * Projects to update.
+     * @maxSize 100
+     */
     projects?: MaskedProject[];
     /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
     returnFullEntity?: boolean | null;
@@ -772,11 +971,17 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface DeleteProjectRequest {
-    /** ID of the project to delete. */
+    /**
+     * ID of the project to delete.
+     * @format GUID
+     */
     projectId: string;
 }
 export interface DeleteProjectResponse {
-    /** ID of the deleted project. */
+    /**
+     * ID of the deleted project.
+     * @format GUID
+     */
     projectId?: string;
 }
 export interface QueryProjectsRequest {
@@ -815,7 +1020,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -837,9 +1045,15 @@ export interface QueryProjectsResponse {
     metadata?: PagingMetadataV2;
 }
 export interface UpdateProjectOrderInCollectionRequest {
-    /** ID of the project to update. */
+    /**
+     * ID of the project to update.
+     * @format GUID
+     */
     projectId: string;
-    /** Collection ID. */
+    /**
+     * Collection ID.
+     * @format GUID
+     */
     collectionId: string;
     /** Index that determines the placement of a project within the collection. */
     sortOrder: number | null;
@@ -849,7 +1063,10 @@ export interface UpdateProjectOrderInCollectionResponse {
     projectInCollection?: ProjectsInCollections;
 }
 export interface ProjectsInCollections {
-    /** Collection ID. */
+    /**
+     * Collection ID.
+     * @format GUID
+     */
     collectionId?: string;
     /** Project object. */
     project?: Project;
@@ -862,6 +1079,7 @@ export interface ProjectsInCollections {
     /**
      * Project placement ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
 }
@@ -878,7 +1096,10 @@ export interface QueryProjectWithCollectionInfoResponse {
     metadata?: PagingMetadataV2;
 }
 export interface RestoreProjectFromTrashBinRequest {
-    /** id of deleted project to restore from trash bin. */
+    /**
+     * id of deleted project to restore from trash bin.
+     * @format GUID
+     */
     projectId?: string;
 }
 export interface RestoreProjectFromTrashBinResponse {
@@ -1057,9 +1278,15 @@ export interface QueryProjectWithCollectionInfoResponseNonNullableFields {
     projects: ProjectsInCollectionsNonNullableFields[];
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1113,6 +1340,8 @@ export interface ProjectCreatedEnvelope {
  * @permissionId PORTFOLIO.PROJECT_READ
  * @webhook
  * @eventType wix.portfolio.projects.v1.project_created
+ * @serviceIdentifier com.wixpress.portfolio.projects.ProjectsService
+ * @slug created
  * @documentationMaturity preview
  */
 export declare function onProjectCreated(handler: (event: ProjectCreatedEnvelope) => void | Promise<void>): void;
@@ -1126,6 +1355,8 @@ export interface ProjectDeletedEnvelope {
  * @permissionId PORTFOLIO.PROJECT_READ
  * @webhook
  * @eventType wix.portfolio.projects.v1.project_deleted
+ * @serviceIdentifier com.wixpress.portfolio.projects.ProjectsService
+ * @slug deleted
  * @documentationMaturity preview
  */
 export declare function onProjectDeleted(handler: (event: ProjectDeletedEnvelope) => void | Promise<void>): void;
@@ -1140,6 +1371,8 @@ export interface ProjectUpdatedEnvelope {
  * @permissionId PORTFOLIO.PROJECT_READ
  * @webhook
  * @eventType wix.portfolio.projects.v1.project_updated
+ * @serviceIdentifier com.wixpress.portfolio.projects.ProjectsService
+ * @slug updated
  * @documentationMaturity preview
  */
 export declare function onProjectUpdated(handler: (event: ProjectUpdatedEnvelope) => void | Promise<void>): void;
@@ -1218,6 +1451,7 @@ export interface UpdateProject {
     /**
      * Project ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /**
@@ -1225,13 +1459,20 @@ export interface UpdateProject {
      * @readonly
      */
     revision?: string | null;
-    /** Project title. */
+    /**
+     * Project title.
+     * @maxLength 100
+     */
     title?: string | null;
     /** Project description. */
     description?: string | null;
     /** Whether the project is hidden from the portfolio. Default: `false` */
     hidden?: boolean | null;
-    /** IDs of the collections that include the project. */
+    /**
+     * IDs of the collections that include the project.
+     * @format GUID
+     * @maxSize 1000
+     */
     collectionIds?: string[];
     /** Project details. */
     details?: ProjectDetail[];
@@ -1248,7 +1489,7 @@ export interface UpdateProject {
      */
     _updatedDate?: Date | null;
     /**
-     * Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.
+     * Project page URL and relative path. Returned when `includePageUrl` is `true` in the request.
      * @readonly
      */
     url?: string;
@@ -1270,7 +1511,10 @@ export interface UpdateProject {
  */
 export declare function bulkUpdateProjects(options?: BulkUpdateProjectsOptions): Promise<BulkUpdateProjectsResponse & BulkUpdateProjectsResponseNonNullableFields>;
 export interface BulkUpdateProjectsOptions {
-    /** Projects to update. */
+    /**
+     * Projects to update.
+     * @maxSize 100
+     */
     projects?: MaskedProject[];
     /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
     returnFullEntity?: boolean | null;
@@ -1418,9 +1662,15 @@ export interface ProjectsQueryBuilder {
  */
 export declare function updateProjectOrderInCollection(identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse & UpdateProjectOrderInCollectionResponseNonNullableFields>;
 export interface UpdateProjectOrderInCollectionIdentifiers {
-    /** ID of the project to update. */
+    /**
+     * ID of the project to update.
+     * @format GUID
+     */
     projectId: string;
-    /** Collection ID. */
+    /**
+     * Collection ID.
+     * @format GUID
+     */
     collectionId: string;
 }
 /**