@wix/auto_sdk_containers_projects 1.0.24 → 1.0.25

package/build/cjs/index.typings.d.ts

@@ -90,8 +90,9 @@ interface Project {
      */
     headReleaseId?: string | null;
     /**
-     * Internal migration lifecycle. Absent for ordinary projects. Only dedicated migration
-     * operations may set this field; standard create and update requests cannot change it.
+     * Migration details of the project.
+     *
+     * Returned only for projects that were created by a migration.
      * @readonly
      */
     oneAppMigration?: OneAppMigration;
@@ -131,47 +132,81 @@ declare enum V1Platform {
 }
 /** @enumType */
 type V1PlatformWithLiterals = V1Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
-/** Tracks the exact draft offered to the site owner. */
+/** Migration details of a project. */
 interface OneAppMigration {
+    /** Migration state. */
     state?: OneAppMigrationStateWithLiterals;
     /**
-     * Present in OFFERED and ACCEPTED; remains fixed after the offer.
+     * ID of the release that was offered to the site owner.
+     *
+     * Returned only when `state` is `OFFERED` or `ACCEPTED`.
      * @maxLength 200
      */
     offeredReleaseId?: string | null;
-    /** @format GUID */
+    /**
+     * ID of the Wix site that the project was migrated from.
+     * @format GUID
+     */
     sourceMetaSiteId?: string;
-    /** @format GUID */
+    /**
+     * ID of the migration job that's currently running.
+     * @format GUID
+     */
     activeJobId?: string | null;
-    /** @maxLength 200 */
+    /**
+     * ID of the release that the running migration job started from.
+     * @maxLength 200
+     */
     activeBaseReleaseId?: string | null;
+    /** Whether the migrated project is reserved to be offered to the site owner. */
     offerReserved?: boolean;
-    /** Includes the expiry of already-issued worker keys, Himi control-token lifetime and clock skew. */
+    /** Date and time until which a running migration job can still write to the project. */
     workerWriteDrainUntil?: Date | null;
-    /** @maxLength 50 */
+    /**
+     * Type of the migration job that's currently running.
+     * @maxLength 50
+     */
     activeJobType?: string;
-    /** @format GUID */
+    /**
+     * ID of the request that started the running migration job.
+     * @format GUID
+     */
     activeRequestId?: string | null;
     /**
-     * SHA-256 of the trusted operation, site, instructions and retry reference. No prompt is kept here.
+     * Fingerprint of the request that started the running migration job.
      * @maxLength 64
      */
     activeRequestFingerprint?: string;
-    /** @format GUID */
+    /**
+     * ID of the earlier migration job that the running job retries.
+     * @format GUID
+     */
     activeRetryOfJobId?: string | null;
-    /** @maxLength 200 */
+    /**
+     * ID of the release that the last migration job produced and that was verified.
+     * @maxLength 200
+     */
     verifiedReleaseId?: string | null;
-    /** @maxLength 64 */
+    /**
+     * Hash of the email address of the developer who started the running migration job.
+     * @maxLength 64
+     */
     activeDeveloperEmailSha256?: string;
     /**
-     * Set only when initial Start failed before the Jobs row was recorded.
+     * Date and time the migration failed to start.
+     *
+     * Returned only when the migration failed before its first job was recorded.
      * @readonly
      */
     startupFailedAt?: Date | null;
 }
+/** Migration state of a project. */
 declare enum OneAppMigrationState {
+    /** The migrated project is a draft that isn't offered to the site owner yet. */
     DRAFT = "DRAFT",
+    /** The migrated project is offered to the site owner. */
     OFFERED = "OFFERED",
+    /** The site owner accepted the migrated project. */
     ACCEPTED = "ACCEPTED"
 }
 /** @enumType */
@@ -2613,24 +2648,27 @@ interface StartMobileBuildRequest {
      */
     canonicalApp?: string;
     /**
-     * Android only. Kind of file to build. Default: `APK`.
+     * Android only. Kind of file to build.
      *
-     * `AAB` builds the file to upload to Google Play, under the package name saved for the app in
-     * Himalaya. With `AAB`, `platforms` must be only `ANDROID`, and `owner_authorization` is required.
+     * `AAB` builds the file to upload to Google Play, under the package name saved for the app. With
+     * `AAB`, `platforms` must contain only `ANDROID`, and `ownerAuthorization` is required.
+     *
+     * Default: `APK`
      */
     androidFormat?: AndroidFormatWithLiterals;
     /**
      * The site owner's dashboard authorization: the signed `Authorization` header of this request.
-     * Required with `android_format: AAB`: Himalaya checks that whoever starts a Google Play file owns the site.
+     *
+     * Required when `androidFormat` is `AAB`, to confirm that the caller owns the site.
      *
      * Used for this call only. It isn't stored or returned.
      * @maxLength 4096
      */
     ownerAuthorization?: string;
     /**
-     * Kind of build. Default: `STORE`.
+     * Kind of build.
      *
-     * `INTERNAL_DEBUG` is for Wix staff only, and can't be combined with `androidFormat: AAB`.
+     * Default: `STORE`
      */
     buildKind?: BuildKindWithLiterals;
 }
@@ -2656,7 +2694,7 @@ type AndroidFormatWithLiterals = AndroidFormat | 'APK' | 'AAB';
 declare enum BuildKind {
     /** A build of the owner's app, to install and test or to submit to a store. */
     STORE = "STORE",
-    /** A debug build, for Wix staff only. */
+    /** Debug build. */
     INTERNAL_DEBUG = "INTERNAL_DEBUG"
 }
 /** @enumType */
@@ -2732,7 +2770,7 @@ interface MobileBuild {
     androidFormat?: AndroidFormatWithLiterals;
     /**
      * Android `AAB` builds only. URL of an `.apk` file of the same build, to install on a phone and test.
-     * Returned only when `status` is `SUCCEEDED`. Can be empty. Expires with `download_url`.
+     * Returned only when `status` is `SUCCEEDED`. Can be empty. Expires with `downloadUrl`.
      * @format WEB_URL
      */
     apkDownloadUrl?: string;
@@ -2793,15 +2831,15 @@ interface GetLatestMobileBuildsRequest {
 }
 interface GetLatestMobileBuildsResponse {
     /**
-     * Latest builds for each platform: iOS first, then Android. For Wix staff, an `INTERNAL_DEBUG`
-     * entry follows for each platform that has a debug build.
+     * Latest builds for each platform: iOS first, then Android.
      * @maxSize 4
      */
     platforms?: PlatformMobileBuilds[];
     /** Whether refreshing builds in progress failed. When `true`, the stored state is returned. */
     refreshFailed?: boolean;
     /**
-     * Kinds of build that Start Mobile Build supports. Returned on every read.
+     * Kinds of build that the caller can start with
+     * [Start Mobile Build](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/start-mobile-build).
      * @maxSize 2
      */
     supportedBuildKinds?: BuildKindWithLiterals[];
@@ -2946,8 +2984,9 @@ interface UpdateProject {
      */
     headReleaseId?: string | null;
     /**
-     * Internal migration lifecycle. Absent for ordinary projects. Only dedicated migration
-     * operations may set this field; standard create and update requests cannot change it.
+     * Migration details of the project.
+     *
+     * Returned only for projects that were created by a migration.
      * @readonly
      */
     oneAppMigration?: OneAppMigration;
@@ -3164,24 +3203,27 @@ interface StartMobileBuildOptions {
      */
     canonicalApp?: string;
     /**
-     * Android only. Kind of file to build. Default: `APK`.
+     * Android only. Kind of file to build.
      *
-     * `AAB` builds the file to upload to Google Play, under the package name saved for the app in
-     * Himalaya. With `AAB`, `platforms` must be only `ANDROID`, and `owner_authorization` is required.
+     * `AAB` builds the file to upload to Google Play, under the package name saved for the app. With
+     * `AAB`, `platforms` must contain only `ANDROID`, and `ownerAuthorization` is required.
+     *
+     * Default: `APK`
      */
     androidFormat?: AndroidFormatWithLiterals;
     /**
      * The site owner's dashboard authorization: the signed `Authorization` header of this request.
-     * Required with `android_format: AAB`: Himalaya checks that whoever starts a Google Play file owns the site.
+     *
+     * Required when `androidFormat` is `AAB`, to confirm that the caller owns the site.
      *
      * Used for this call only. It isn't stored or returned.
      * @maxLength 4096
      */
     ownerAuthorization?: string;
     /**
-     * Kind of build. Default: `STORE`.
+     * Kind of build.
      *
-     * `INTERNAL_DEBUG` is for Wix staff only, and can't be combined with `androidFormat: AAB`.
+     * Default: `STORE`
      */
     buildKind?: BuildKindWithLiterals;
 }