@wix/auto_sdk_containers_projects 1.0.27 → 1.0.29

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

@@ -2848,7 +2848,13 @@ interface StartMobileBuildRequest {
     releaseId?: string;
     /**
      * Version label for the builds, for example `1.2.0`. It's stored with the builds and returned by
-     * Get Latest Mobile Builds. It isn't written into the app.
+     * Get Latest Mobile Builds.
+     *
+     * When `androidFormat` is `AAB`, it's also written into the Google Play file as its version name,
+     * so Google Play shows it. It must then be 1 to 3 numbers separated by dots, for example `1.0.2`;
+     * otherwise the build isn't started and the error's `himalayaCode` is `store_build_version_invalid`.
+     * When not specified, the file keeps the build system's own version. Other builds don't write it
+     * into the app.
      * @maxLength 50
      */
     appVersion?: string;
@@ -2998,6 +3004,18 @@ interface MobileBuild {
     apkDownloadUrl?: string;
     /** Kind of build. Builds started before the field existed are `STORE`. */
     buildKind?: BuildKindWithLiterals;
+    /**
+     * App name that the build shows on the home screen: the project's `name` when the build was started.
+     * Empty for builds started before the field existed, and for `INTERNAL_DEBUG` builds.
+     * @maxLength 200
+     */
+    appName?: string;
+    /**
+     * URL of the app icon that the build carries: the project's `appIconUrl` when the build was started.
+     * Empty for builds started before the field existed, and for `INTERNAL_DEBUG` builds.
+     * @maxLength 2000
+     */
+    appIconUrl?: string;
 }
 /** Status of an app-file build. */
 declare enum Status {
@@ -3108,6 +3126,10 @@ type StartMobileBuildApplicationErrors = {
     code?: 'INTERNAL_DEBUG_STAFF_ONLY';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'APP_INFO_MISSING';
+    description?: string;
+    data?: Record<string, any>;
 };
 /**
  * Retrieves a project.
@@ -3392,7 +3414,7 @@ declare function getHimalayaAuthorization(projectId: string): Promise<NonNullabl
  * @applicableIdentity APP
  * @fqn wix.containers.projects.v1.ContainersProjects.StartMobileBuild
  */
-declare function startMobileBuild(projectId: string, platforms: PlatformWithLiterals[], options?: NonNullablePaths<StartMobileBuildOptions, `himalayaControlToken`, 0>): Promise<NonNullablePaths<StartMobileBuildResponse, `builds` | `builds.${number}.jobId` | `builds.${number}.platform` | `builds.${number}.releaseId` | `builds.${number}.appVersion` | `builds.${number}.status` | `builds.${number}.failureKind` | `builds.${number}.himalayaStatus` | `builds.${number}.errorMessage` | `builds.${number}.downloadUrl` | `builds.${number}.installPageUrl` | `builds.${number}.downloadExpired` | `builds.${number}.androidFormat` | `builds.${number}.apkDownloadUrl` | `builds.${number}.buildKind` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2> & {
+declare function startMobileBuild(projectId: string, platforms: PlatformWithLiterals[], options?: NonNullablePaths<StartMobileBuildOptions, `himalayaControlToken`, 0>): Promise<NonNullablePaths<StartMobileBuildResponse, `builds` | `builds.${number}.jobId` | `builds.${number}.platform` | `builds.${number}.releaseId` | `builds.${number}.appVersion` | `builds.${number}.status` | `builds.${number}.failureKind` | `builds.${number}.himalayaStatus` | `builds.${number}.errorMessage` | `builds.${number}.downloadUrl` | `builds.${number}.installPageUrl` | `builds.${number}.downloadExpired` | `builds.${number}.androidFormat` | `builds.${number}.apkDownloadUrl` | `builds.${number}.buildKind` | `builds.${number}.appName` | `builds.${number}.appIconUrl` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2> & {
     __applicationErrorsType?: StartMobileBuildApplicationErrors;
 }>;
 interface StartMobileBuildOptions {
@@ -3403,7 +3425,13 @@ interface StartMobileBuildOptions {
     releaseId?: string;
     /**
      * Version label for the builds, for example `1.2.0`. It's stored with the builds and returned by
-     * Get Latest Mobile Builds. It isn't written into the app.
+     * Get Latest Mobile Builds.
+     *
+     * When `androidFormat` is `AAB`, it's also written into the Google Play file as its version name,
+     * so Google Play shows it. It must then be 1 to 3 numbers separated by dots, for example `1.0.2`;
+     * otherwise the build isn't started and the error's `himalayaCode` is `store_build_version_invalid`.
+     * When not specified, the file keeps the build system's own version. Other builds don't write it
+     * into the app.
      * @maxLength 50
      */
     appVersion?: string;
@@ -3466,7 +3494,7 @@ interface StartMobileBuildOptions {
  * @applicableIdentity APP
  * @fqn wix.containers.projects.v1.ContainersProjects.GetLatestMobileBuilds
  */
-declare function getLatestMobileBuilds(projectId: string, options?: GetLatestMobileBuildsOptions): Promise<NonNullablePaths<GetLatestMobileBuildsResponse, `platforms` | `platforms.${number}.platform` | `platforms.${number}.lastAttempt.jobId` | `platforms.${number}.lastAttempt.platform` | `platforms.${number}.lastAttempt.releaseId` | `platforms.${number}.lastAttempt.appVersion` | `platforms.${number}.lastAttempt.status` | `platforms.${number}.lastAttempt.failureKind` | `platforms.${number}.lastAttempt.himalayaStatus` | `platforms.${number}.lastAttempt.errorMessage` | `platforms.${number}.lastAttempt.downloadUrl` | `platforms.${number}.lastAttempt.installPageUrl` | `platforms.${number}.lastAttempt.downloadExpired` | `platforms.${number}.lastAttempt.androidFormat` | `platforms.${number}.lastAttempt.apkDownloadUrl` | `platforms.${number}.lastAttempt.buildKind` | `platforms.${number}.buildKind` | `refreshFailed` | `supportedBuildKinds`, 3>>;
+declare function getLatestMobileBuilds(projectId: string, options?: GetLatestMobileBuildsOptions): Promise<NonNullablePaths<GetLatestMobileBuildsResponse, `platforms` | `platforms.${number}.platform` | `platforms.${number}.lastAttempt.jobId` | `platforms.${number}.lastAttempt.platform` | `platforms.${number}.lastAttempt.releaseId` | `platforms.${number}.lastAttempt.appVersion` | `platforms.${number}.lastAttempt.status` | `platforms.${number}.lastAttempt.failureKind` | `platforms.${number}.lastAttempt.himalayaStatus` | `platforms.${number}.lastAttempt.errorMessage` | `platforms.${number}.lastAttempt.downloadUrl` | `platforms.${number}.lastAttempt.installPageUrl` | `platforms.${number}.lastAttempt.downloadExpired` | `platforms.${number}.lastAttempt.androidFormat` | `platforms.${number}.lastAttempt.apkDownloadUrl` | `platforms.${number}.lastAttempt.buildKind` | `platforms.${number}.lastAttempt.appName` | `platforms.${number}.lastAttempt.appIconUrl` | `platforms.${number}.buildKind` | `refreshFailed` | `supportedBuildKinds`, 3>>;
 interface GetLatestMobileBuildsOptions {
     /**
      * Short-lived control credential for the project's app.