@wix/auto_sdk_containers_projects 1.0.8 → 1.0.10

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

@@ -72,7 +72,7 @@ interface Project {
      * Platform that the project's app targets. Set when the project is created and can't be changed.
      * @immutable
      */
-    platform?: PlatformWithLiterals;
+    platform?: V1PlatformWithLiterals;
     /**
      * URL of the app's icon.
      * @maxLength 2000
@@ -112,7 +112,7 @@ declare enum SandboxStatus {
 }
 /** @enumType */
 type SandboxStatusWithLiterals = SandboxStatus | 'NONE' | 'CREATING';
-declare enum Platform {
+declare enum V1Platform {
     /** Native iOS app. Used by older projects. */
     IOS = "IOS",
     /** Native Android app. Used by older projects. */
@@ -124,7 +124,7 @@ declare enum Platform {
     HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
 }
 /** @enumType */
-type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
+type V1PlatformWithLiterals = V1Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
 /** Details of a request to start a project's remote development environment. */
 interface ProjectStartRequested {
     /**
@@ -1236,6 +1236,224 @@ interface GetHimalayaAuthorizationResponse {
     /** Whether the current user can save the project's design. */
     saveDesign?: boolean;
 }
+interface StartMobileBuildRequest {
+    /**
+     * ID of the project to build.
+     * @format GUID
+     */
+    projectId: string;
+    /**
+     * Platforms to build. One build is started for each platform.
+     * @minSize 1
+     * @maxSize 2
+     */
+    platforms: PlatformWithLiterals[];
+    /**
+     * ID of the app release to build. When not specified, the app's live release is built.
+     * @maxLength 200
+     */
+    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.
+     * @maxLength 50
+     */
+    appVersion?: string;
+    /**
+     * Short-lived control credential for the project's app.
+     *
+     * Used for this call only. It isn't stored or returned.
+     * @maxLength 4096
+     */
+    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).
+     *
+     * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
+     * @maxLength 200
+     */
+    canonicalApp?: string;
+    /**
+     * Android only. Kind of file to build. Default: `APK`.
+     *
+     * `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.
+     */
+    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.
+     *
+     * Used for this call only. It isn't stored or returned.
+     * @maxLength 4096
+     */
+    ownerAuthorization?: string;
+}
+/** Platform that an app-file build targets. */
+declare enum Platform {
+    /** iOS. The build makes an `.ipa` file and an install page. */
+    IOS = "IOS",
+    /** Android. The build makes an `.apk` file, or an `.aab` file for Google Play (see `androidFormat`). */
+    ANDROID = "ANDROID"
+}
+/** @enumType */
+type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID';
+/** Kind of file an Android build makes. */
+declare enum AndroidFormat {
+    /** An `.apk` file, to install on a phone and test. */
+    APK = "APK",
+    /** An `.aab` file (Android App Bundle), the file to upload to Google Play. It can't be installed on a phone. */
+    AAB = "AAB"
+}
+/** @enumType */
+type AndroidFormatWithLiterals = AndroidFormat | 'APK' | 'AAB';
+interface StartMobileBuildResponse {
+    /**
+     * Started builds, one for each platform that was accepted.
+     * @maxSize 2
+     */
+    builds?: MobileBuild[];
+    /**
+     * Platforms whose build couldn't be started. Empty when every platform was started.
+     * @maxSize 2
+     */
+    failedPlatforms?: FailedMobileBuildPlatform[];
+}
+/** One build of a project's installable app files, for one platform. */
+interface MobileBuild {
+    /**
+     * Build ID.
+     * @maxLength 200
+     */
+    jobId?: string;
+    /** Platform that the build targets. */
+    platform?: PlatformWithLiterals;
+    /**
+     * ID of the app release that was built.
+     * @maxLength 200
+     */
+    releaseId?: string;
+    /**
+     * Version label that the owner gave the build when it was started. Can be empty.
+     * @maxLength 50
+     */
+    appVersion?: string;
+    /** Build status. */
+    status?: StatusWithLiterals;
+    /** Why the build failed. Returned only when `status` is `FAILED`. */
+    failureKind?: FailureKindWithLiterals;
+    /**
+     * Status reported by the build system, for diagnostics only.
+     * @maxLength 50
+     */
+    himalayaStatus?: string;
+    /**
+     * Error text reported by the build system, for diagnostics only. Don't parse it.
+     * @maxLength 2000
+     */
+    errorMessage?: string;
+    /**
+     * URL of the built file: an `.ipa` file for iOS, or an `.apk` or `.aab` file for Android.
+     * Returned only when `status` is `SUCCEEDED`. Can be empty for iOS.
+     * @format WEB_URL
+     */
+    downloadUrl?: string;
+    /**
+     * iOS only. URL of the page that installs the app on an iPhone.
+     * Returned only when `status` is `SUCCEEDED`. Can be empty.
+     * @format WEB_URL
+     */
+    installPageUrl?: string;
+    /** Date and time the download links expire, about 7 days after the build. */
+    downloadExpiresDate?: Date | null;
+    /** Whether the download links have expired. To get new links, start a new build. */
+    downloadExpired?: boolean;
+    /** Date and time the build was started. */
+    _createdDate?: Date | null;
+    /** Date and time the build was first seen as `SUCCEEDED`. */
+    builtDate?: Date | null;
+    /** Date and time the build last changed. */
+    _updatedDate?: Date | null;
+    /** Android only. Kind of file the build made: an `.apk` to install and test, or an `.aab` to upload to Google Play. */
+    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`.
+     * @format WEB_URL
+     */
+    apkDownloadUrl?: string;
+}
+/** Status of an app-file build. */
+declare enum Status {
+    /** The build is queued or running. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** The build finished and its files can be downloaded until `downloadExpiresDate`. */
+    SUCCEEDED = "SUCCEEDED",
+    /** The build failed. See `failureKind`. */
+    FAILED = "FAILED",
+    /** The build was canceled. */
+    CANCELED = "CANCELED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'CANCELED';
+/** Why an app-file build failed. */
+declare enum FailureKind {
+    /** The app couldn't be signed. */
+    SIGNING = "SIGNING",
+    /** The build failed for another reason. */
+    BUILD = "BUILD"
+}
+/** @enumType */
+type FailureKindWithLiterals = FailureKind | 'SIGNING' | 'BUILD';
+/** A platform whose build couldn't be started. */
+interface FailedMobileBuildPlatform {
+    /** Platform. */
+    platform?: PlatformWithLiterals;
+    /**
+     * Error code reported by the build system.
+     * @maxLength 200
+     */
+    errorCode?: string;
+    /**
+     * Error text reported by the build system, for diagnostics only.
+     * @maxLength 2000
+     */
+    errorMessage?: string;
+}
+interface GetLatestMobileBuildsRequest {
+    /**
+     * ID of the project.
+     * @format GUID
+     */
+    projectId: string;
+    /**
+     * Short-lived control credential for the project's app.
+     *
+     * When specified, builds in progress are refreshed before the response. Used for this call only.
+     * It isn't stored or returned.
+     * @maxLength 4096
+     */
+    himalayaControlToken?: string;
+}
+interface GetLatestMobileBuildsResponse {
+    /**
+     * Latest builds for each platform: iOS first, then Android.
+     * @maxSize 2
+     */
+    platforms?: PlatformMobileBuilds[];
+    /** Whether refreshing builds in progress failed. When `true`, the stored state is returned. */
+    refreshFailed?: boolean;
+}
+/** The latest app-file builds of a project for one platform. */
+interface PlatformMobileBuilds {
+    /** Platform. */
+    platform?: PlatformWithLiterals;
+    /** The last build that was started, in any status. Not returned when no build was started. */
+    lastAttempt?: MobileBuild;
+    /** The last build that succeeded. Its links can be expired. Not returned when no build succeeded. */
+    lastSuccessfulBuild?: MobileBuild;
+}
 /**
  * Creates a project from a template.
  *
@@ -1347,7 +1565,7 @@ interface UpdateProject {
      * Platform that the project's app targets. Set when the project is created and can't be changed.
      * @immutable
      */
-    platform?: PlatformWithLiterals;
+    platform?: V1PlatformWithLiterals;
     /**
      * URL of the app's icon.
      * @maxLength 2000
@@ -1563,5 +1781,96 @@ interface ListProjectsOptions {
  * @fqn wix.containers.projects.v1.ContainersProjects.GetHimalayaAuthorization
  */
 declare function getHimalayaAuthorization(projectId: string): Promise<NonNullablePaths<GetHimalayaAuthorizationResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp` | `workerLaunch` | `saveDesign`, 0>>;
+/**
+ * Starts building the installable app files of a project, one build for each platform.
+ *
+ * The builds run in the background and take several minutes. To follow them, call
+ * [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
+ * [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`.
+ * @param projectId - ID of the project to build.
+ * @param platforms - Platforms to build. One build is started for each platform.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.himalayaControlToken
+ * @requiredField platforms
+ * @requiredField projectId
+ * @permissionId containers:projects:v1:project:start_mobile_build
+ * @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` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2>>;
+interface StartMobileBuildOptions {
+    /**
+     * ID of the app release to build. When not specified, the app's live release is built.
+     * @maxLength 200
+     */
+    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.
+     * @maxLength 50
+     */
+    appVersion?: string;
+    /**
+     * Short-lived control credential for the project's app.
+     *
+     * Used for this call only. It isn't stored or returned.
+     * @maxLength 4096
+     */
+    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).
+     *
+     * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
+     * @maxLength 200
+     */
+    canonicalApp?: string;
+    /**
+     * Android only. Kind of file to build. Default: `APK`.
+     *
+     * `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.
+     */
+    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.
+     *
+     * Used for this call only. It isn't stored or returned.
+     * @maxLength 4096
+     */
+    ownerAuthorization?: string;
+}
+/**
+ * Retrieves the latest app-file builds of a project: for each platform, the last build that was
+ * started and the last build that succeeded.
+ *
+ * The caller must be authorized to work on the project's app, as for
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
+ *
+ * When `himalayaControlToken` is specified, builds that are still in progress are refreshed
+ * before the response. Without it, the stored state is returned as is.
+ * @param projectId - ID of the project.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField projectId
+ * @permissionId containers:projects:v1:project:get_latest_mobile_builds
+ * @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` | `refreshFailed`, 3>>;
+interface GetLatestMobileBuildsOptions {
+    /**
+     * Short-lived control credential for the project's app.
+     *
+     * When specified, builds in progress are refreshed before the response. Used for this call only.
+     * It isn't stored or returned.
+     * @maxLength 4096
+     */
+    himalayaControlToken?: string;
+}
 
-export { type AccountInfo, type ActionEvent, type AdditionalDataFilterMismatchType, type AdditionalDataFilterMissingKey, type AdditionalDataFilterMustHaveKey, type AdditionalDataMissingValue, type AdditionalFilterCantBeEmpty, type ConductByScopeResponse, type ConductByScopesResponse, type ConductResponse, type ConductionException, type ConductionResult, type ConductionStatus, type ConductionStatusStatusOneOf, type CreateAgentSessionRequest, type CreateAgentSessionResponse, type CreateProjectRequest, type CreateProjectResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DeleteProjectRequest, type DeleteProjectResponse, type DidNotFindEligibleFilter, type DomainEvent, type DomainEventBodyOneOf, type DynamicConfigConductionResult, type DynamicConfigStatus, type DynamicConfigStatusStatusOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedToFetchExperiment, type FailedToRunToss, type FilterNotImplemented, type FilterNotSupported, type FilterOperandEmpty, type GeneralError, type GetAgentConfigRequest, type GetAgentConfigResponse, type GetAgentExperimentsRequest, type GetAgentExperimentsResponse, type GetHimalayaAuthorizationRequest, type GetHimalayaAuthorizationResponse, type GetProjectRequest, type GetProjectResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidLibraryConfiguration, type IsEnabledFieldNotFound, type IsEnabledFieldNotOfTypeBoolean, type ListProjectsForCurrentUserRequest, type ListProjectsForCurrentUserResponse, type ListProjectsOptions, type ListProjectsRequest, type ListProjectsResponse, type MessageEnvelope, type MissingElementInContextForBiProfileError, type MissingExperimentId, type MissingFilterTarget, type MissingPlugins, type MissingSeed, type MissingSeedKeyType, type MissingSeedType, type NoResultForConduction, type NotImplemented, Platform, type PlatformWithLiterals, type PopulationError, type Project, type ProjectPlanReady, type ProjectResumeRequested, type ProjectStartRequested, ProjectStatus, type ProjectStatusWithLiterals, type RefreshAgentSiteTokenRequest, type RefreshAgentSiteTokenResponse, type RegenerateProjectIconRequest, type RegenerateProjectIconResponse, type RegenerateProjectNameRequest, type RegenerateProjectNameResponse, type RestoreInfo, type RestoreReleaseOptions, type RestoreReleaseRequest, type RestoreReleaseResponse, type ResumeProjectRequest, type ResumeProjectResponse, SandboxStatus, type SandboxStatusWithLiterals, type SaveProjectDesignOptions, type SaveProjectDesignRequest, type SaveProjectDesignResponse, type StartProjectRequest, type StartProjectResponse, type SuccessfulResult, type UpdateProject, type UpdateProjectRequest, type UpdateProjectResponse, type V1AdditionalDataFilterMismatchType, type V1AdditionalDataFilterMissingKey, type V1AdditionalDataFilterMustHaveKey, type V1AdditionalDataMissingValue, type V1AdditionalFilterCantBeEmpty, type V1ConductionException, type V1DidNotFindEligibleFilter, type V1FailedToFetchExperiment, type V1FailedToRunToss, type V1FilterNotImplemented, type V1FilterNotSupported, type V1FilterOperandEmpty, type V1GeneralError, type V1MissingElementInContextForBiProfileError, type V1MissingExperimentId, type V1MissingFilterTarget, type V1MissingPlugins, type V1MissingSeed, type V1MissingSeedKeyType, type V1MissingSeedType, type V1NoResultForConduction, type V1PopulationError, type V1SuccessfulResult, Variant, type VariantValue, type VariantValueValueOneOf, type VariantWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createProject, deleteProject, getHimalayaAuthorization, getProject, listProjects, regenerateProjectIcon, regenerateProjectName, restoreRelease, resumeProject, saveProjectDesign, updateProject };
+export { type AccountInfo, type ActionEvent, type AdditionalDataFilterMismatchType, type AdditionalDataFilterMissingKey, type AdditionalDataFilterMustHaveKey, type AdditionalDataMissingValue, type AdditionalFilterCantBeEmpty, AndroidFormat, type AndroidFormatWithLiterals, type ConductByScopeResponse, type ConductByScopesResponse, type ConductResponse, type ConductionException, type ConductionResult, type ConductionStatus, type ConductionStatusStatusOneOf, type CreateAgentSessionRequest, type CreateAgentSessionResponse, type CreateProjectRequest, type CreateProjectResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DeleteProjectRequest, type DeleteProjectResponse, type DidNotFindEligibleFilter, type DomainEvent, type DomainEventBodyOneOf, type DynamicConfigConductionResult, type DynamicConfigStatus, type DynamicConfigStatusStatusOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedMobileBuildPlatform, type FailedToFetchExperiment, type FailedToRunToss, FailureKind, type FailureKindWithLiterals, type FilterNotImplemented, type FilterNotSupported, type FilterOperandEmpty, type GeneralError, type GetAgentConfigRequest, type GetAgentConfigResponse, type GetAgentExperimentsRequest, type GetAgentExperimentsResponse, type GetHimalayaAuthorizationRequest, type GetHimalayaAuthorizationResponse, type GetLatestMobileBuildsOptions, type GetLatestMobileBuildsRequest, type GetLatestMobileBuildsResponse, type GetProjectRequest, type GetProjectResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidLibraryConfiguration, type IsEnabledFieldNotFound, type IsEnabledFieldNotOfTypeBoolean, type ListProjectsForCurrentUserRequest, type ListProjectsForCurrentUserResponse, type ListProjectsOptions, type ListProjectsRequest, type ListProjectsResponse, type MessageEnvelope, type MissingElementInContextForBiProfileError, type MissingExperimentId, type MissingFilterTarget, type MissingPlugins, type MissingSeed, type MissingSeedKeyType, type MissingSeedType, type MobileBuild, type NoResultForConduction, type NotImplemented, Platform, type PlatformMobileBuilds, type PlatformWithLiterals, type PopulationError, type Project, type ProjectPlanReady, type ProjectResumeRequested, type ProjectStartRequested, ProjectStatus, type ProjectStatusWithLiterals, type RefreshAgentSiteTokenRequest, type RefreshAgentSiteTokenResponse, type RegenerateProjectIconRequest, type RegenerateProjectIconResponse, type RegenerateProjectNameRequest, type RegenerateProjectNameResponse, type RestoreInfo, type RestoreReleaseOptions, type RestoreReleaseRequest, type RestoreReleaseResponse, type ResumeProjectRequest, type ResumeProjectResponse, SandboxStatus, type SandboxStatusWithLiterals, type SaveProjectDesignOptions, type SaveProjectDesignRequest, type SaveProjectDesignResponse, type StartMobileBuildOptions, type StartMobileBuildRequest, type StartMobileBuildResponse, type StartProjectRequest, type StartProjectResponse, Status, type StatusWithLiterals, type SuccessfulResult, type UpdateProject, type UpdateProjectRequest, type UpdateProjectResponse, type V1AdditionalDataFilterMismatchType, type V1AdditionalDataFilterMissingKey, type V1AdditionalDataFilterMustHaveKey, type V1AdditionalDataMissingValue, type V1AdditionalFilterCantBeEmpty, type V1ConductionException, type V1DidNotFindEligibleFilter, type V1FailedToFetchExperiment, type V1FailedToRunToss, type V1FilterNotImplemented, type V1FilterNotSupported, type V1FilterOperandEmpty, type V1GeneralError, type V1MissingElementInContextForBiProfileError, type V1MissingExperimentId, type V1MissingFilterTarget, type V1MissingPlugins, type V1MissingSeed, type V1MissingSeedKeyType, type V1MissingSeedType, type V1NoResultForConduction, V1Platform, type V1PlatformWithLiterals, type V1PopulationError, type V1SuccessfulResult, Variant, type VariantValue, type VariantValueValueOneOf, type VariantWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createProject, deleteProject, getHimalayaAuthorization, getLatestMobileBuilds, getProject, listProjects, regenerateProjectIcon, regenerateProjectName, restoreRelease, resumeProject, saveProjectDesign, startMobileBuild, updateProject };