@wix/auto_sdk_containers_projects 1.0.8 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { Project, UpdateProject, ResumeProjectResponse, RegenerateProjectNameResponse, RegenerateProjectIconResponse, SaveProjectDesignOptions, SaveProjectDesignResponse, RestoreReleaseOptions, RestoreReleaseResponse, ListProjectsOptions, ListProjectsResponse, GetHimalayaAuthorizationResponse } from './index.typings.mjs';
3
- export { AccountInfo, ActionEvent, AdditionalDataFilterMismatchType, AdditionalDataFilterMissingKey, AdditionalDataFilterMustHaveKey, AdditionalDataMissingValue, AdditionalFilterCantBeEmpty, ConductByScopeResponse, ConductByScopesResponse, ConductResponse, ConductionException, ConductionResult, ConductionStatus, ConductionStatusStatusOneOf, CreateAgentSessionRequest, CreateAgentSessionResponse, CreateProjectRequest, CreateProjectResponse, CursorPaging, CursorPagingMetadata, Cursors, DeleteProjectRequest, DeleteProjectResponse, DidNotFindEligibleFilter, DomainEvent, DomainEventBodyOneOf, DynamicConfigConductionResult, DynamicConfigStatus, DynamicConfigStatusStatusOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FailedToFetchExperiment, FailedToRunToss, FilterNotImplemented, FilterNotSupported, FilterOperandEmpty, GeneralError, GetAgentConfigRequest, GetAgentConfigResponse, GetAgentExperimentsRequest, GetAgentExperimentsResponse, GetHimalayaAuthorizationRequest, GetProjectRequest, GetProjectResponse, IdentificationData, IdentificationDataIdOneOf, InvalidLibraryConfiguration, IsEnabledFieldNotFound, IsEnabledFieldNotOfTypeBoolean, ListProjectsForCurrentUserRequest, ListProjectsForCurrentUserResponse, ListProjectsRequest, MessageEnvelope, MissingElementInContextForBiProfileError, MissingExperimentId, MissingFilterTarget, MissingPlugins, MissingSeed, MissingSeedKeyType, MissingSeedType, NoResultForConduction, NotImplemented, Platform, PlatformWithLiterals, PopulationError, ProjectPlanReady, ProjectResumeRequested, ProjectStartRequested, ProjectStatus, ProjectStatusWithLiterals, RefreshAgentSiteTokenRequest, RefreshAgentSiteTokenResponse, RegenerateProjectIconRequest, RegenerateProjectNameRequest, RestoreInfo, RestoreReleaseRequest, ResumeProjectRequest, SandboxStatus, SandboxStatusWithLiterals, SaveProjectDesignRequest, StartProjectRequest, StartProjectResponse, SuccessfulResult, UpdateProjectRequest, UpdateProjectResponse, V1AdditionalDataFilterMismatchType, V1AdditionalDataFilterMissingKey, V1AdditionalDataFilterMustHaveKey, V1AdditionalDataMissingValue, V1AdditionalFilterCantBeEmpty, V1ConductionException, V1DidNotFindEligibleFilter, V1FailedToFetchExperiment, V1FailedToRunToss, V1FilterNotImplemented, V1FilterNotSupported, V1FilterOperandEmpty, V1GeneralError, V1MissingElementInContextForBiProfileError, V1MissingExperimentId, V1MissingFilterTarget, V1MissingPlugins, V1MissingSeed, V1MissingSeedKeyType, V1MissingSeedType, V1NoResultForConduction, V1PopulationError, V1SuccessfulResult, Variant, VariantValue, VariantValueValueOneOf, VariantWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
2
+ import { Project, UpdateProject, ResumeProjectResponse, RegenerateProjectNameResponse, RegenerateProjectIconResponse, SaveProjectDesignOptions, SaveProjectDesignResponse, RestoreReleaseOptions, RestoreReleaseResponse, ListProjectsOptions, ListProjectsResponse, GetHimalayaAuthorizationResponse, PlatformWithLiterals, StartMobileBuildOptions, StartMobileBuildResponse, GetLatestMobileBuildsOptions, GetLatestMobileBuildsResponse } from './index.typings.mjs';
3
+ export { AccountInfo, ActionEvent, AdditionalDataFilterMismatchType, AdditionalDataFilterMissingKey, AdditionalDataFilterMustHaveKey, AdditionalDataMissingValue, AdditionalFilterCantBeEmpty, ConductByScopeResponse, ConductByScopesResponse, ConductResponse, ConductionException, ConductionResult, ConductionStatus, ConductionStatusStatusOneOf, CreateAgentSessionRequest, CreateAgentSessionResponse, CreateProjectRequest, CreateProjectResponse, CursorPaging, CursorPagingMetadata, Cursors, DeleteProjectRequest, DeleteProjectResponse, DidNotFindEligibleFilter, DomainEvent, DomainEventBodyOneOf, DynamicConfigConductionResult, DynamicConfigStatus, DynamicConfigStatusStatusOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FailedMobileBuildPlatform, FailedToFetchExperiment, FailedToRunToss, FailureKind, FailureKindWithLiterals, FilterNotImplemented, FilterNotSupported, FilterOperandEmpty, GeneralError, GetAgentConfigRequest, GetAgentConfigResponse, GetAgentExperimentsRequest, GetAgentExperimentsResponse, GetHimalayaAuthorizationRequest, GetLatestMobileBuildsRequest, GetProjectRequest, GetProjectResponse, IdentificationData, IdentificationDataIdOneOf, InvalidLibraryConfiguration, IsEnabledFieldNotFound, IsEnabledFieldNotOfTypeBoolean, ListProjectsForCurrentUserRequest, ListProjectsForCurrentUserResponse, ListProjectsRequest, MessageEnvelope, MissingElementInContextForBiProfileError, MissingExperimentId, MissingFilterTarget, MissingPlugins, MissingSeed, MissingSeedKeyType, MissingSeedType, MobileBuild, NoResultForConduction, NotImplemented, Platform, PlatformMobileBuilds, PopulationError, ProjectPlanReady, ProjectResumeRequested, ProjectStartRequested, ProjectStatus, ProjectStatusWithLiterals, RefreshAgentSiteTokenRequest, RefreshAgentSiteTokenResponse, RegenerateProjectIconRequest, RegenerateProjectNameRequest, RestoreInfo, RestoreReleaseRequest, ResumeProjectRequest, SandboxStatus, SandboxStatusWithLiterals, SaveProjectDesignRequest, StartMobileBuildRequest, StartProjectRequest, StartProjectResponse, Status, StatusWithLiterals, SuccessfulResult, UpdateProjectRequest, UpdateProjectResponse, V1AdditionalDataFilterMismatchType, V1AdditionalDataFilterMissingKey, V1AdditionalDataFilterMustHaveKey, V1AdditionalDataMissingValue, V1AdditionalFilterCantBeEmpty, V1ConductionException, V1DidNotFindEligibleFilter, V1FailedToFetchExperiment, V1FailedToRunToss, V1FilterNotImplemented, V1FilterNotSupported, V1FilterOperandEmpty, V1GeneralError, V1MissingElementInContextForBiProfileError, V1MissingExperimentId, V1MissingFilterTarget, V1MissingPlugins, V1MissingSeed, V1MissingSeedKeyType, V1MissingSeedType, V1NoResultForConduction, V1Platform, V1PlatformWithLiterals, V1PopulationError, V1SuccessfulResult, Variant, VariantValue, VariantValueValueOneOf, VariantWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
4
4
 
5
5
  /** @internal */
6
6
  declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
@@ -158,6 +158,38 @@ interface GetHimalayaAuthorizationSignature {
158
158
  */
159
159
  (projectId: string): Promise<NonNullablePaths<GetHimalayaAuthorizationResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp` | `workerLaunch` | `saveDesign`, 0>>;
160
160
  }
161
+ declare function startMobileBuild$1(httpClient: HttpClient): StartMobileBuildSignature;
162
+ interface StartMobileBuildSignature {
163
+ /**
164
+ * Starts building the installable app files of a project, one build for each platform.
165
+ *
166
+ * The builds run in the background and take several minutes. To follow them, call
167
+ * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
168
+ * with `himalayaControlToken`.
169
+ *
170
+ * For projects whose `platform` is `HIMALAYA_MOBILE`, call
171
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
172
+ * first, and specify the returned `canonicalApp`.
173
+ * @param - ID of the project to build.
174
+ * @param - Platforms to build. One build is started for each platform.
175
+ */
176
+ (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` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2>>;
177
+ }
178
+ declare function getLatestMobileBuilds$1(httpClient: HttpClient): GetLatestMobileBuildsSignature;
179
+ interface GetLatestMobileBuildsSignature {
180
+ /**
181
+ * Retrieves the latest app-file builds of a project: for each platform, the last build that was
182
+ * started and the last build that succeeded.
183
+ *
184
+ * The caller must be authorized to work on the project's app, as for
185
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
186
+ *
187
+ * When `himalayaControlToken` is specified, builds that are still in progress are refreshed
188
+ * before the response. Without it, the stored state is returned as is.
189
+ * @param - ID of the project.
190
+ */
191
+ (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` | `refreshFailed`, 3>>;
192
+ }
161
193
 
162
194
  /** @internal */
163
195
  declare const createProject: MaybeContext<BuildRESTFunction<typeof createProject$1> & typeof createProject$1>;
@@ -176,5 +208,7 @@ declare const restoreRelease: MaybeContext<BuildRESTFunction<typeof restoreRelea
176
208
  /** @internal */
177
209
  declare const listProjects: MaybeContext<BuildRESTFunction<typeof listProjects$1> & typeof listProjects$1>;
178
210
  declare const getHimalayaAuthorization: MaybeContext<BuildRESTFunction<typeof getHimalayaAuthorization$1> & typeof getHimalayaAuthorization$1>;
211
+ declare const startMobileBuild: MaybeContext<BuildRESTFunction<typeof startMobileBuild$1> & typeof startMobileBuild$1>;
212
+ declare const getLatestMobileBuilds: MaybeContext<BuildRESTFunction<typeof getLatestMobileBuilds$1> & typeof getLatestMobileBuilds$1>;
179
213
 
180
- export { GetHimalayaAuthorizationResponse, ListProjectsOptions, ListProjectsResponse, Project, RegenerateProjectIconResponse, RegenerateProjectNameResponse, RestoreReleaseOptions, RestoreReleaseResponse, ResumeProjectResponse, SaveProjectDesignOptions, SaveProjectDesignResponse, UpdateProject, createProject, deleteProject, getHimalayaAuthorization, getProject, listProjects, regenerateProjectIcon, regenerateProjectName, restoreRelease, resumeProject, saveProjectDesign, updateProject };
214
+ export { GetHimalayaAuthorizationResponse, GetLatestMobileBuildsOptions, GetLatestMobileBuildsResponse, ListProjectsOptions, ListProjectsResponse, PlatformWithLiterals, Project, RegenerateProjectIconResponse, RegenerateProjectNameResponse, RestoreReleaseOptions, RestoreReleaseResponse, ResumeProjectResponse, SaveProjectDesignOptions, SaveProjectDesignResponse, StartMobileBuildOptions, StartMobileBuildResponse, UpdateProject, createProject, deleteProject, getHimalayaAuthorization, getLatestMobileBuilds, getProject, listProjects, regenerateProjectIcon, regenerateProjectName, restoreRelease, resumeProject, saveProjectDesign, startMobileBuild, updateProject };
@@ -72,7 +72,7 @@ interface Project {
72
72
  * Platform that the project's app targets. Set when the project is created and can't be changed.
73
73
  * @immutable
74
74
  */
75
- platform?: PlatformWithLiterals;
75
+ platform?: V1PlatformWithLiterals;
76
76
  /**
77
77
  * URL of the app's icon.
78
78
  * @maxLength 2000
@@ -112,7 +112,7 @@ declare enum SandboxStatus {
112
112
  }
113
113
  /** @enumType */
114
114
  type SandboxStatusWithLiterals = SandboxStatus | 'NONE' | 'CREATING';
115
- declare enum Platform {
115
+ declare enum V1Platform {
116
116
  /** Native iOS app. Used by older projects. */
117
117
  IOS = "IOS",
118
118
  /** Native Android app. Used by older projects. */
@@ -124,7 +124,7 @@ declare enum Platform {
124
124
  HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
125
125
  }
126
126
  /** @enumType */
127
- type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
127
+ type V1PlatformWithLiterals = V1Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
128
128
  /** Details of a request to start a project's remote development environment. */
129
129
  interface ProjectStartRequested {
130
130
  /**
@@ -1236,6 +1236,192 @@ interface GetHimalayaAuthorizationResponse {
1236
1236
  /** Whether the current user can save the project's design. */
1237
1237
  saveDesign?: boolean;
1238
1238
  }
1239
+ interface StartMobileBuildRequest {
1240
+ /**
1241
+ * ID of the project to build.
1242
+ * @format GUID
1243
+ */
1244
+ projectId: string;
1245
+ /**
1246
+ * Platforms to build. One build is started for each platform.
1247
+ * @minSize 1
1248
+ * @maxSize 2
1249
+ */
1250
+ platforms: PlatformWithLiterals[];
1251
+ /**
1252
+ * ID of the app release to build. When not specified, the app's live release is built.
1253
+ * @maxLength 200
1254
+ */
1255
+ releaseId?: string;
1256
+ /**
1257
+ * Version label for the builds, for example `1.2.0`. It's stored with the builds and returned by
1258
+ * Get Latest Mobile Builds. It isn't written into the app.
1259
+ * @maxLength 50
1260
+ */
1261
+ appVersion?: string;
1262
+ /**
1263
+ * Short-lived control credential for the project's app.
1264
+ *
1265
+ * Used for this call only. It isn't stored or returned.
1266
+ * @maxLength 4096
1267
+ */
1268
+ himalayaControlToken: string;
1269
+ /**
1270
+ * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
1271
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
1272
+ *
1273
+ * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
1274
+ * @maxLength 200
1275
+ */
1276
+ canonicalApp?: string;
1277
+ }
1278
+ /** Platform that an app-file build targets. */
1279
+ declare enum Platform {
1280
+ /** iOS. The build makes an `.ipa` file and an install page. */
1281
+ IOS = "IOS",
1282
+ /** Android. The build makes an `.apk` file. */
1283
+ ANDROID = "ANDROID"
1284
+ }
1285
+ /** @enumType */
1286
+ type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID';
1287
+ interface StartMobileBuildResponse {
1288
+ /**
1289
+ * Started builds, one for each platform that was accepted.
1290
+ * @maxSize 2
1291
+ */
1292
+ builds?: MobileBuild[];
1293
+ /**
1294
+ * Platforms whose build couldn't be started. Empty when every platform was started.
1295
+ * @maxSize 2
1296
+ */
1297
+ failedPlatforms?: FailedMobileBuildPlatform[];
1298
+ }
1299
+ /** One build of a project's installable app files, for one platform. */
1300
+ interface MobileBuild {
1301
+ /**
1302
+ * Build ID.
1303
+ * @maxLength 200
1304
+ */
1305
+ jobId?: string;
1306
+ /** Platform that the build targets. */
1307
+ platform?: PlatformWithLiterals;
1308
+ /**
1309
+ * ID of the app release that was built.
1310
+ * @maxLength 200
1311
+ */
1312
+ releaseId?: string;
1313
+ /**
1314
+ * Version label that the owner gave the build when it was started. Can be empty.
1315
+ * @maxLength 50
1316
+ */
1317
+ appVersion?: string;
1318
+ /** Build status. */
1319
+ status?: StatusWithLiterals;
1320
+ /** Why the build failed. Returned only when `status` is `FAILED`. */
1321
+ failureKind?: FailureKindWithLiterals;
1322
+ /**
1323
+ * Status reported by the build system, for diagnostics only.
1324
+ * @maxLength 50
1325
+ */
1326
+ himalayaStatus?: string;
1327
+ /**
1328
+ * Error text reported by the build system, for diagnostics only. Don't parse it.
1329
+ * @maxLength 2000
1330
+ */
1331
+ errorMessage?: string;
1332
+ /**
1333
+ * URL of the built file: an `.ipa` file for iOS, or an `.apk` file for Android.
1334
+ * Returned only when `status` is `SUCCEEDED`. Can be empty for iOS.
1335
+ * @format WEB_URL
1336
+ */
1337
+ downloadUrl?: string;
1338
+ /**
1339
+ * iOS only. URL of the page that installs the app on an iPhone.
1340
+ * Returned only when `status` is `SUCCEEDED`. Can be empty.
1341
+ * @format WEB_URL
1342
+ */
1343
+ installPageUrl?: string;
1344
+ /** Date and time the download links expire, about 7 days after the build. */
1345
+ downloadExpiresDate?: Date | null;
1346
+ /** Whether the download links have expired. To get new links, start a new build. */
1347
+ downloadExpired?: boolean;
1348
+ /** Date and time the build was started. */
1349
+ _createdDate?: Date | null;
1350
+ /** Date and time the build was first seen as `SUCCEEDED`. */
1351
+ builtDate?: Date | null;
1352
+ /** Date and time the build last changed. */
1353
+ _updatedDate?: Date | null;
1354
+ }
1355
+ /** Status of an app-file build. */
1356
+ declare enum Status {
1357
+ /** The build is queued or running. */
1358
+ IN_PROGRESS = "IN_PROGRESS",
1359
+ /** The build finished and its files can be downloaded until `downloadExpiresDate`. */
1360
+ SUCCEEDED = "SUCCEEDED",
1361
+ /** The build failed. See `failureKind`. */
1362
+ FAILED = "FAILED",
1363
+ /** The build was canceled. */
1364
+ CANCELED = "CANCELED"
1365
+ }
1366
+ /** @enumType */
1367
+ type StatusWithLiterals = Status | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'CANCELED';
1368
+ /** Why an app-file build failed. */
1369
+ declare enum FailureKind {
1370
+ /** The app couldn't be signed. */
1371
+ SIGNING = "SIGNING",
1372
+ /** The build failed for another reason. */
1373
+ BUILD = "BUILD"
1374
+ }
1375
+ /** @enumType */
1376
+ type FailureKindWithLiterals = FailureKind | 'SIGNING' | 'BUILD';
1377
+ /** A platform whose build couldn't be started. */
1378
+ interface FailedMobileBuildPlatform {
1379
+ /** Platform. */
1380
+ platform?: PlatformWithLiterals;
1381
+ /**
1382
+ * Error code reported by the build system.
1383
+ * @maxLength 200
1384
+ */
1385
+ errorCode?: string;
1386
+ /**
1387
+ * Error text reported by the build system, for diagnostics only.
1388
+ * @maxLength 2000
1389
+ */
1390
+ errorMessage?: string;
1391
+ }
1392
+ interface GetLatestMobileBuildsRequest {
1393
+ /**
1394
+ * ID of the project.
1395
+ * @format GUID
1396
+ */
1397
+ projectId: string;
1398
+ /**
1399
+ * Short-lived control credential for the project's app.
1400
+ *
1401
+ * When specified, builds in progress are refreshed before the response. Used for this call only.
1402
+ * It isn't stored or returned.
1403
+ * @maxLength 4096
1404
+ */
1405
+ himalayaControlToken?: string;
1406
+ }
1407
+ interface GetLatestMobileBuildsResponse {
1408
+ /**
1409
+ * Latest builds for each platform: iOS first, then Android.
1410
+ * @maxSize 2
1411
+ */
1412
+ platforms?: PlatformMobileBuilds[];
1413
+ /** Whether refreshing builds in progress failed. When `true`, the stored state is returned. */
1414
+ refreshFailed?: boolean;
1415
+ }
1416
+ /** The latest app-file builds of a project for one platform. */
1417
+ interface PlatformMobileBuilds {
1418
+ /** Platform. */
1419
+ platform?: PlatformWithLiterals;
1420
+ /** The last build that was started, in any status. Not returned when no build was started. */
1421
+ lastAttempt?: MobileBuild;
1422
+ /** The last build that succeeded. Its links can be expired. Not returned when no build succeeded. */
1423
+ lastSuccessfulBuild?: MobileBuild;
1424
+ }
1239
1425
  /**
1240
1426
  * Creates a project from a template.
1241
1427
  *
@@ -1347,7 +1533,7 @@ interface UpdateProject {
1347
1533
  * Platform that the project's app targets. Set when the project is created and can't be changed.
1348
1534
  * @immutable
1349
1535
  */
1350
- platform?: PlatformWithLiterals;
1536
+ platform?: V1PlatformWithLiterals;
1351
1537
  /**
1352
1538
  * URL of the app's icon.
1353
1539
  * @maxLength 2000
@@ -1563,5 +1749,81 @@ interface ListProjectsOptions {
1563
1749
  * @fqn wix.containers.projects.v1.ContainersProjects.GetHimalayaAuthorization
1564
1750
  */
1565
1751
  declare function getHimalayaAuthorization(projectId: string): Promise<NonNullablePaths<GetHimalayaAuthorizationResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp` | `workerLaunch` | `saveDesign`, 0>>;
1752
+ /**
1753
+ * Starts building the installable app files of a project, one build for each platform.
1754
+ *
1755
+ * The builds run in the background and take several minutes. To follow them, call
1756
+ * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
1757
+ * with `himalayaControlToken`.
1758
+ *
1759
+ * For projects whose `platform` is `HIMALAYA_MOBILE`, call
1760
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
1761
+ * first, and specify the returned `canonicalApp`.
1762
+ * @param projectId - ID of the project to build.
1763
+ * @param platforms - Platforms to build. One build is started for each platform.
1764
+ * @public
1765
+ * @documentationMaturity preview
1766
+ * @requiredField options.himalayaControlToken
1767
+ * @requiredField platforms
1768
+ * @requiredField projectId
1769
+ * @permissionId containers:projects:v1:project:start_mobile_build
1770
+ * @fqn wix.containers.projects.v1.ContainersProjects.StartMobileBuild
1771
+ */
1772
+ 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` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2>>;
1773
+ interface StartMobileBuildOptions {
1774
+ /**
1775
+ * ID of the app release to build. When not specified, the app's live release is built.
1776
+ * @maxLength 200
1777
+ */
1778
+ releaseId?: string;
1779
+ /**
1780
+ * Version label for the builds, for example `1.2.0`. It's stored with the builds and returned by
1781
+ * Get Latest Mobile Builds. It isn't written into the app.
1782
+ * @maxLength 50
1783
+ */
1784
+ appVersion?: string;
1785
+ /**
1786
+ * Short-lived control credential for the project's app.
1787
+ *
1788
+ * Used for this call only. It isn't stored or returned.
1789
+ * @maxLength 4096
1790
+ */
1791
+ himalayaControlToken: string;
1792
+ /**
1793
+ * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
1794
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
1795
+ *
1796
+ * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
1797
+ * @maxLength 200
1798
+ */
1799
+ canonicalApp?: string;
1800
+ }
1801
+ /**
1802
+ * Retrieves the latest app-file builds of a project: for each platform, the last build that was
1803
+ * started and the last build that succeeded.
1804
+ *
1805
+ * The caller must be authorized to work on the project's app, as for
1806
+ * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
1807
+ *
1808
+ * When `himalayaControlToken` is specified, builds that are still in progress are refreshed
1809
+ * before the response. Without it, the stored state is returned as is.
1810
+ * @param projectId - ID of the project.
1811
+ * @public
1812
+ * @documentationMaturity preview
1813
+ * @requiredField projectId
1814
+ * @permissionId containers:projects:v1:project:get_latest_mobile_builds
1815
+ * @fqn wix.containers.projects.v1.ContainersProjects.GetLatestMobileBuilds
1816
+ */
1817
+ 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` | `refreshFailed`, 3>>;
1818
+ interface GetLatestMobileBuildsOptions {
1819
+ /**
1820
+ * Short-lived control credential for the project's app.
1821
+ *
1822
+ * When specified, builds in progress are refreshed before the response. Used for this call only.
1823
+ * It isn't stored or returned.
1824
+ * @maxLength 4096
1825
+ */
1826
+ himalayaControlToken?: string;
1827
+ }
1566
1828
 
1567
- 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 };
1829
+ 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 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 };