@faable/deploy-sdk 2.9.0 → 2.10.0

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.
@@ -287,6 +287,106 @@ export interface paths {
287
287
  patch?: never;
288
288
  trace?: never;
289
289
  };
290
+ "/app/{id}/repo/branches": {
291
+ parameters: {
292
+ query?: never;
293
+ header?: never;
294
+ path?: never;
295
+ cookie?: never;
296
+ };
297
+ /**
298
+ * List repository branches
299
+ * @description Branch names of the linked repository.
300
+ */
301
+ get: operations["app/repo_branches"];
302
+ put?: never;
303
+ post?: never;
304
+ delete?: never;
305
+ options?: never;
306
+ head?: never;
307
+ patch?: never;
308
+ trace?: never;
309
+ };
310
+ "/app/{id}/repo/workflows": {
311
+ parameters: {
312
+ query?: never;
313
+ header?: never;
314
+ path?: never;
315
+ cookie?: never;
316
+ };
317
+ /**
318
+ * List repository workflow files
319
+ * @description GitHub Actions workflow files present on the linked repository (deploy branch).
320
+ */
321
+ get: operations["app/repo_workflows"];
322
+ put?: never;
323
+ post?: never;
324
+ delete?: never;
325
+ options?: never;
326
+ head?: never;
327
+ patch?: never;
328
+ trace?: never;
329
+ };
330
+ "/app/{id}/repo/config": {
331
+ parameters: {
332
+ query?: never;
333
+ header?: never;
334
+ path?: never;
335
+ cookie?: never;
336
+ };
337
+ /**
338
+ * Get effective repository build config
339
+ * @description Effective build configuration read from the repository: the monorepo Root Directory and its source (platform override or the repo's faable.json).
340
+ */
341
+ get: operations["app/repo_config"];
342
+ put?: never;
343
+ post?: never;
344
+ delete?: never;
345
+ options?: never;
346
+ head?: never;
347
+ patch?: never;
348
+ trace?: never;
349
+ };
350
+ "/app/{id}/deploy-mode": {
351
+ parameters: {
352
+ query?: never;
353
+ header?: never;
354
+ path?: never;
355
+ cookie?: never;
356
+ };
357
+ get?: never;
358
+ put?: never;
359
+ /**
360
+ * Set the deploy mode
361
+ * @description Choose how pushes deploy: 'push' = every push deploys directly; 'ci' = deploy once the commit's CI checks pass. Both are platform-managed (webhook) triggers.
362
+ */
363
+ post: operations["app/set_deploy_mode"];
364
+ delete?: never;
365
+ options?: never;
366
+ head?: never;
367
+ patch?: never;
368
+ trace?: never;
369
+ };
370
+ "/app/{id}/deploy": {
371
+ parameters: {
372
+ query?: never;
373
+ header?: never;
374
+ path?: never;
375
+ cookie?: never;
376
+ };
377
+ get?: never;
378
+ put?: never;
379
+ /**
380
+ * Deploy the latest commit now
381
+ * @description Build and deploy the current head of the deploy branch, without waiting for a push. Same path as a push webhook, including the same-commit dedupe.
382
+ */
383
+ post: operations["app/deploy_now"];
384
+ delete?: never;
385
+ options?: never;
386
+ head?: never;
387
+ patch?: never;
388
+ trace?: never;
389
+ };
290
390
  "/deployment": {
291
391
  parameters: {
292
392
  query?: never;
@@ -548,6 +648,46 @@ export interface paths {
548
648
  patch?: never;
549
649
  trace?: never;
550
650
  };
651
+ "/deploy-quota": {
652
+ parameters: {
653
+ query?: never;
654
+ header?: never;
655
+ path?: never;
656
+ cookie?: never;
657
+ };
658
+ /**
659
+ * Get the team's daily deploy quota status
660
+ * @description Daily deploy allowance of the current team: how much was used today, when it resets, and how many builds are held waiting for it.
661
+ */
662
+ get: operations["deploy_quota/get"];
663
+ put?: never;
664
+ post?: never;
665
+ delete?: never;
666
+ options?: never;
667
+ head?: never;
668
+ patch?: never;
669
+ trace?: never;
670
+ };
671
+ "/deploy-quota/release": {
672
+ parameters: {
673
+ query?: never;
674
+ header?: never;
675
+ path?: never;
676
+ cookie?: never;
677
+ };
678
+ get?: never;
679
+ put?: never;
680
+ /**
681
+ * Roll out the builds held by the daily deploy quota
682
+ * @description Releases the team's held deployments if its current plan allows it (per app, only the newest held build rolls out; older ones are canceled). Safe to call at any time — it does nothing while the quota is still spent.
683
+ */
684
+ post: operations["deploy_quota/release"];
685
+ delete?: never;
686
+ options?: never;
687
+ head?: never;
688
+ patch?: never;
689
+ trace?: never;
690
+ };
551
691
  }
552
692
  export type webhooks = Record<string, never>;
553
693
  export interface components {
@@ -764,13 +904,33 @@ export interface components {
764
904
  github_branch: string;
765
905
  workflow_synced: boolean;
766
906
  };
907
+ RepoBranches: {
908
+ branches: string[];
909
+ };
910
+ RepoWorkflows: {
911
+ workflows: {
912
+ name: string;
913
+ path: string;
914
+ }[];
915
+ deploy_workflow: string | null;
916
+ };
917
+ RepoConfig: {
918
+ root_dir: string | null;
919
+ root_dir_source: "platform" | "faable.json" | null;
920
+ };
921
+ DeployNowResult: {
922
+ /** @enum {string} */
923
+ status: "created";
924
+ commit: string;
925
+ branch: string;
926
+ };
767
927
  DeploymentStatus: {
768
928
  /**
769
929
  * @description High-level summary of where the Deployment is in its lifecycle
770
930
  * @default QUEUED
771
931
  * @enum {unknown}
772
932
  */
773
- phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING" | "SUPERSEDED";
933
+ phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING" | "SUPERSEDED" | "QUOTA_HOLD";
774
934
  /**
775
935
  * Format: date-time
776
936
  * @description When a controller took control of this deployment
@@ -834,6 +994,8 @@ export interface components {
834
994
  /** Format: date-time */
835
995
  artifact_ready_at?: string;
836
996
  redeploy_of?: string;
997
+ /** Format: date-time */
998
+ quota_released_at?: string;
837
999
  trigger?: string | null;
838
1000
  status: components["schemas"]["DeploymentStatus"];
839
1001
  /** @default {} */
@@ -1319,6 +1481,19 @@ export interface components {
1319
1481
  ApiKeyUpdate: {
1320
1482
  description?: string;
1321
1483
  };
1484
+ DeployQuota: {
1485
+ limited: boolean;
1486
+ over: boolean;
1487
+ used: number;
1488
+ limit: number | null;
1489
+ /** Format: date-time */
1490
+ resets_at: string;
1491
+ held: number;
1492
+ };
1493
+ DeployQuotaRelease: {
1494
+ released: string[];
1495
+ canceled: string[];
1496
+ };
1322
1497
  AppChecknameResponse: {
1323
1498
  name: string;
1324
1499
  slug: string;
@@ -2185,6 +2360,138 @@ export interface operations {
2185
2360
  };
2186
2361
  };
2187
2362
  };
2363
+ "app/repo_branches": {
2364
+ parameters: {
2365
+ query?: never;
2366
+ header?: never;
2367
+ path: {
2368
+ id: string;
2369
+ };
2370
+ cookie?: never;
2371
+ };
2372
+ requestBody?: never;
2373
+ responses: {
2374
+ /** @description Default Response */
2375
+ 200: {
2376
+ headers: {
2377
+ [name: string]: unknown;
2378
+ };
2379
+ content: {
2380
+ "application/json": {
2381
+ branches: string[];
2382
+ };
2383
+ };
2384
+ };
2385
+ };
2386
+ };
2387
+ "app/repo_workflows": {
2388
+ parameters: {
2389
+ query?: never;
2390
+ header?: never;
2391
+ path: {
2392
+ id: string;
2393
+ };
2394
+ cookie?: never;
2395
+ };
2396
+ requestBody?: never;
2397
+ responses: {
2398
+ /** @description Default Response */
2399
+ 200: {
2400
+ headers: {
2401
+ [name: string]: unknown;
2402
+ };
2403
+ content: {
2404
+ "application/json": {
2405
+ workflows: {
2406
+ name: string;
2407
+ path: string;
2408
+ }[];
2409
+ deploy_workflow: string | null;
2410
+ };
2411
+ };
2412
+ };
2413
+ };
2414
+ };
2415
+ "app/repo_config": {
2416
+ parameters: {
2417
+ query?: never;
2418
+ header?: never;
2419
+ path: {
2420
+ id: string;
2421
+ };
2422
+ cookie?: never;
2423
+ };
2424
+ requestBody?: never;
2425
+ responses: {
2426
+ /** @description Default Response */
2427
+ 200: {
2428
+ headers: {
2429
+ [name: string]: unknown;
2430
+ };
2431
+ content: {
2432
+ "application/json": {
2433
+ root_dir: string | null;
2434
+ root_dir_source: "platform" | "faable.json" | null;
2435
+ };
2436
+ };
2437
+ };
2438
+ };
2439
+ };
2440
+ "app/set_deploy_mode": {
2441
+ parameters: {
2442
+ query?: never;
2443
+ header?: never;
2444
+ path: {
2445
+ id: string;
2446
+ };
2447
+ cookie?: never;
2448
+ };
2449
+ requestBody: {
2450
+ content: {
2451
+ "application/json": {
2452
+ mode: "push" | "ci" | "workflow";
2453
+ };
2454
+ };
2455
+ };
2456
+ responses: {
2457
+ /** @description App */
2458
+ 200: {
2459
+ headers: {
2460
+ [name: string]: unknown;
2461
+ };
2462
+ content: {
2463
+ "application/json": components["schemas"]["App"];
2464
+ };
2465
+ };
2466
+ };
2467
+ };
2468
+ "app/deploy_now": {
2469
+ parameters: {
2470
+ query?: never;
2471
+ header?: never;
2472
+ path: {
2473
+ id: string;
2474
+ };
2475
+ cookie?: never;
2476
+ };
2477
+ requestBody?: never;
2478
+ responses: {
2479
+ /** @description Default Response */
2480
+ 200: {
2481
+ headers: {
2482
+ [name: string]: unknown;
2483
+ };
2484
+ content: {
2485
+ "application/json": {
2486
+ /** @enum {string} */
2487
+ status: "created";
2488
+ commit: string;
2489
+ branch: string;
2490
+ };
2491
+ };
2492
+ };
2493
+ };
2494
+ };
2188
2495
  "deployment/list": {
2189
2496
  parameters: {
2190
2497
  query?: {
@@ -2261,6 +2568,8 @@ export interface operations {
2261
2568
  /** Format: date-time */
2262
2569
  artifact_ready_at?: string;
2263
2570
  redeploy_of?: string;
2571
+ /** Format: date-time */
2572
+ quota_released_at?: string;
2264
2573
  trigger?: string | null;
2265
2574
  status: components["schemas"]["DeploymentStatus"];
2266
2575
  /** @default {} */
@@ -2308,6 +2617,8 @@ export interface operations {
2308
2617
  /** Format: date-time */
2309
2618
  artifact_ready_at?: string;
2310
2619
  redeploy_of?: string;
2620
+ /** Format: date-time */
2621
+ quota_released_at?: string;
2311
2622
  trigger?: string | null;
2312
2623
  status: components["schemas"]["DeploymentStatus"];
2313
2624
  /** @default {} */
@@ -2363,6 +2674,8 @@ export interface operations {
2363
2674
  /** Format: date-time */
2364
2675
  artifact_ready_at?: string;
2365
2676
  redeploy_of?: string;
2677
+ /** Format: date-time */
2678
+ quota_released_at?: string;
2366
2679
  trigger?: string | null;
2367
2680
  status: components["schemas"]["DeploymentStatus"];
2368
2681
  /** @default {} */
@@ -2410,6 +2723,8 @@ export interface operations {
2410
2723
  /** Format: date-time */
2411
2724
  artifact_ready_at?: string;
2412
2725
  redeploy_of?: string;
2726
+ /** Format: date-time */
2727
+ quota_released_at?: string;
2413
2728
  trigger?: string | null;
2414
2729
  status: components["schemas"]["DeploymentStatus"];
2415
2730
  /** @default {} */
@@ -2918,5 +3233,56 @@ export interface operations {
2918
3233
  };
2919
3234
  };
2920
3235
  };
3236
+ "deploy_quota/get": {
3237
+ parameters: {
3238
+ query?: never;
3239
+ header?: never;
3240
+ path?: never;
3241
+ cookie?: never;
3242
+ };
3243
+ requestBody?: never;
3244
+ responses: {
3245
+ /** @description Default Response */
3246
+ 200: {
3247
+ headers: {
3248
+ [name: string]: unknown;
3249
+ };
3250
+ content: {
3251
+ "application/json": {
3252
+ limited: boolean;
3253
+ over: boolean;
3254
+ used: number;
3255
+ limit: number | null;
3256
+ /** Format: date-time */
3257
+ resets_at: string;
3258
+ held: number;
3259
+ };
3260
+ };
3261
+ };
3262
+ };
3263
+ };
3264
+ "deploy_quota/release": {
3265
+ parameters: {
3266
+ query?: never;
3267
+ header?: never;
3268
+ path?: never;
3269
+ cookie?: never;
3270
+ };
3271
+ requestBody?: never;
3272
+ responses: {
3273
+ /** @description Default Response */
3274
+ 200: {
3275
+ headers: {
3276
+ [name: string]: unknown;
3277
+ };
3278
+ content: {
3279
+ "application/json": {
3280
+ released: string[];
3281
+ canceled: string[];
3282
+ };
3283
+ };
3284
+ };
3285
+ };
3286
+ };
2921
3287
  }
2922
3288
  //# sourceMappingURL=types.d.ts.map