@wix/auto_sdk_containers_projects 1.0.22 → 1.0.23

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

@@ -2358,7 +2358,9 @@ interface SaveProjectDesignRequest {
     himalayaControlToken: string;
     /**
      * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
-     * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
+     * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+     * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
+     * for an already claimed project.
      * This isn't the app's ID.
      *
      * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -2553,7 +2555,9 @@ interface StartMobileBuildRequest {
     himalayaControlToken: string;
     /**
      * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
-     * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
+     * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+     * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
+     * for an already claimed project.
      *
      * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
      * @maxLength 200
@@ -2766,26 +2770,26 @@ interface PlatformMobileBuilds {
 }
 interface ClaimHimalayaAppRequest {
     /**
-     * Site-tenanted Containers project to claim a Himalaya app for.
+     * ID of the site project whose app to claim or retrieve.
      * @format GUID
      */
     projectId: string;
 }
 interface ClaimHimalayaAppResponse {
-    /** Version of the authorization capability contract. Matches GetHimalayaAuthorizationResponse. */
+    /** Version of the response format. Currently always `1`. */
     authorizationVersion?: number;
     /**
-     * Trusted MetaSite selected from request identity context, never from the request body.
+     * ID of the Wix site that owns the project.
      * @format GUID
      */
     metaSiteId?: string;
     /**
-     * Site-tenanted Containers project the app is bound to.
+     * ID of the project the app is associated with.
      * @format GUID
      */
     projectId?: string;
     /**
-     * Canonical Himalaya app slug, newly claimed or already bound.
+     * Canonical app slug, newly claimed or already associated with the project.
      * @maxLength 200
      */
     canonicalApp?: string;
@@ -2932,9 +2936,12 @@ declare function resumeProject(projectId: string): Promise<NonNullablePaths<Resu
  * A `CHECKPOINT` message is then added to the conversation. If the checkpoint can't be added, the
  * design is still saved.
  *
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
+ * For a new `HIMALAYA_MOBILE` project, call
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+ * and specify its returned `canonicalApp` when saving the design. For an already claimed project,
+ * call
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
- * first, and specify the returned `canonicalApp`.
+ * and specify the returned `canonicalApp`.
  * @param projectId - ID of the project whose design to save.
  * @param baseReleaseId - ID of the release that the user is currently viewing.
  *
@@ -2968,7 +2975,9 @@ interface SaveProjectDesignOptions {
     himalayaControlToken: string;
     /**
      * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
-     * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
+     * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+     * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
+     * for an already claimed project.
      * This isn't the app's ID.
      *
      * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -3054,9 +3063,14 @@ declare function getHimalayaAuthorization(projectId: string): Promise<NonNullabl
  * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
  * with `himalayaControlToken`.
  *
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
+ * For a new `HIMALAYA_MOBILE` project, call
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+ * before starting a build. For an existing project, call
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
- * first, and specify the returned `canonicalApp`.
+ * and specify the returned `canonicalApp`.
+ *
+ * If a build can't start for a platform, the response lists that platform in
+ * `failedPlatforms` while returning any builds that did start in `builds`.
  * @param projectId - ID of the project to build.
  * @param platforms - Platforms to build. One build is started for each platform.
  * @public
@@ -3092,7 +3106,9 @@ interface StartMobileBuildOptions {
     himalayaControlToken: string;
     /**
      * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
-     * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
+     * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+     * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
+     * for an already claimed project.
      *
      * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
      * @maxLength 200
@@ -3149,18 +3165,11 @@ interface GetLatestMobileBuildsOptions {
     himalayaControlToken?: string;
 }
 /**
- * Claims the canonical Himalaya app for a NEW site-tenanted project, or returns the one already
- * bound to it.
- *
- * This exists so the BROWSER never asserts the (MetaSite, project) pair to Himalaya. Containers
- * is the authority on project -> MetaSite: it reads the project from its own store with a
- * consistent read and takes the MetaSite from this call's identity context, then claims
- * server-to-server with a site USER token minted for the initiating collaborator. Himalaya
- * recognises that token as minted by THIS service and trusts the pair on that basis. A dashboard
- * calling Himalaya directly could name another site's project UUID and reserve its global slug.
+ * Claims the app associated with a project, or retrieves its existing claim.
  *
- * Idempotent per pair: an already-claimed project returns its existing canonical app.
- * @param projectId - Site-tenanted Containers project to claim a Himalaya app for.
+ * An authorized site collaborator can call this method for a new `HIMALAYA_MOBILE` project
+ * before using its app. Repeating the call for the same project returns the same `canonicalApp`.
+ * @param projectId - ID of the site project whose app to claim or retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField projectId