@northflank/js-client 0.7.1 → 0.7.2

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.
@@ -59,6 +59,7 @@ declare type PortForwardingInfo = {
59
59
  portName?: string;
60
60
  protocol?: 'HTTP' | 'TCP' | 'UDP';
61
61
  hostnames: string[];
62
+ ipOnly: boolean;
62
63
  };
63
64
  interface PortTunnel extends EventEmitter {
64
65
  readonly bindTo?: {
@@ -211,7 +212,7 @@ declare type ListServicesResult = {
211
212
  /** Details about the current deployment status. */
212
213
  'deployment'?: {
213
214
  /** The current status of the deployment. Example: "COMPLETED" */
214
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
215
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
215
216
  /** The reason the current deployment was started. Example: "DEPLOYING" */
216
217
  'reason': 'SCALING' | 'DEPLOYING';
217
218
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -747,6 +748,10 @@ declare type CreateAddonData = {
747
748
  }[];
748
749
  /** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
749
750
  'pitrEnabled'?: boolean;
751
+ 'typeSpecificSettings'?: {
752
+ /** Postgres only: enable high-availability mode. */
753
+ 'postgresHAEnabled'?: boolean;
754
+ };
750
755
  };
751
756
  /** Creates a new addon */
752
757
  declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
@@ -796,6 +801,10 @@ declare type PutAddonResult = {
796
801
  }[];
797
802
  /** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
798
803
  'pitrEnabled'?: boolean;
804
+ 'typeSpecificSettings'?: {
805
+ /** Postgres only: enable high-availability mode. */
806
+ 'postgresHAEnabled'?: boolean;
807
+ };
799
808
  /** Identifier for the addon. Example: "example-addon" */
800
809
  'id': string;
801
810
  /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
@@ -854,6 +863,10 @@ declare type PutAddonData = {
854
863
  }[];
855
864
  /** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
856
865
  'pitrEnabled'?: boolean;
866
+ 'typeSpecificSettings'?: {
867
+ /** Postgres only: enable high-availability mode. */
868
+ 'postgresHAEnabled'?: boolean;
869
+ };
857
870
  };
858
871
  /** Creates or updates an addon */
859
872
  declare class PutAddonEndpoint extends PutApiEndpoint<PutAddonRequest, PutAddonResult> {
@@ -974,6 +987,10 @@ declare type PatchAddonResult = {
974
987
  }[];
975
988
  /** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
976
989
  'pitrEnabled'?: boolean;
990
+ 'typeSpecificSettings'?: {
991
+ /** Postgres only: enable high-availability mode. */
992
+ 'postgresHAEnabled'?: boolean;
993
+ };
977
994
  /** Identifier for the addon. Example: "example-addon" */
978
995
  'id': string;
979
996
  /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
@@ -2488,9 +2505,9 @@ declare type CreateClusterData = {
2488
2505
  'description'?: string;
2489
2506
  /** Cloud provider to be used for the selected resource Example: "gcp" */
2490
2507
  'provider': 'gcp' | 'aws' | 'azure' | 'do';
2491
- /** Region of the cluster. */
2508
+ /** Region of the cluster. Example: "europe-west2" */
2492
2509
  'region': string;
2493
- /** Kubernetes version of the cluster. */
2510
+ /** Kubernetes version of the cluster. Example: "1.23.8" */
2494
2511
  'kubernetesVersion': string;
2495
2512
  /** Existing integration to use for this cluster. Example: "gcp-integration" */
2496
2513
  'integrationId'?: string;
@@ -2528,9 +2545,40 @@ declare type CreateClusterData = {
2528
2545
  /** Zones in which the node pool should be provisioned. */
2529
2546
  'availabilityZones'?: string[];
2530
2547
  }[];
2548
+ 'settings': {
2549
+ /** Determines if builds are run on Northflank infrastructure */
2550
+ 'useNorthflankBuilder'?: boolean;
2551
+ 'builds'?: {
2552
+ /** Plan to use for builds if they are run on the cluster Example: "nf-compute-200" */
2553
+ 'plan'?: string;
2554
+ };
2555
+ /** Request modifiers to use for different resources. */
2556
+ 'requestModifiers'?: {
2557
+ /** Request modifiers for services */
2558
+ 'services'?: {
2559
+ 'cpu': number;
2560
+ 'memory': number;
2561
+ };
2562
+ /** Request modifiers for jobs */
2563
+ 'jobs'?: {
2564
+ 'cpu': number;
2565
+ 'memory': number;
2566
+ };
2567
+ /** Request modifiers for builds */
2568
+ 'builds'?: {
2569
+ 'cpu': number;
2570
+ 'memory': number;
2571
+ };
2572
+ /** Request modifiers for addons */
2573
+ 'addons'?: {
2574
+ 'cpu': number;
2575
+ 'memory': number;
2576
+ };
2577
+ };
2578
+ };
2531
2579
  /** GCP specific data. Required when `provider` is `gcp`. */
2532
2580
  'gcp'?: {
2533
- /** ID of the GCP project the cluster will be provisioned in. */
2581
+ /** ID of the GCP project the cluster will be provisioned in. Example: "example-project-id" */
2534
2582
  'projectId': string;
2535
2583
  };
2536
2584
  };
@@ -2664,7 +2712,7 @@ declare type UpdateClusterParameters = {
2664
2712
  declare type UpdateClusterData = {
2665
2713
  /** The description of the cluster. Example: "This is an updated description." */
2666
2714
  'description'?: string;
2667
- 'nodePools': {
2715
+ 'nodePools'?: {
2668
2716
  /** Machine type to be used by the node pool. Example: "n2-standard-8" */
2669
2717
  'nodeType': string;
2670
2718
  /** Number of nodes to the node pool should be provisioned with. Example: 3 */
@@ -2688,6 +2736,37 @@ declare type UpdateClusterData = {
2688
2736
  /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
2689
2737
  'id'?: string;
2690
2738
  }[];
2739
+ 'settings'?: {
2740
+ /** Determines if builds are run on Northflank infrastructure */
2741
+ 'useNorthflankBuilder'?: boolean;
2742
+ 'builds'?: {
2743
+ /** Plan to use for builds if they are run on the cluster Example: "nf-compute-200" */
2744
+ 'plan'?: string;
2745
+ };
2746
+ /** Request modifiers to use for different resources. */
2747
+ 'requestModifiers'?: {
2748
+ /** Request modifiers for services */
2749
+ 'services'?: {
2750
+ 'cpu': number;
2751
+ 'memory': number;
2752
+ };
2753
+ /** Request modifiers for jobs */
2754
+ 'jobs'?: {
2755
+ 'cpu': number;
2756
+ 'memory': number;
2757
+ };
2758
+ /** Request modifiers for builds */
2759
+ 'builds'?: {
2760
+ 'cpu': number;
2761
+ 'memory': number;
2762
+ };
2763
+ /** Request modifiers for addons */
2764
+ 'addons'?: {
2765
+ 'cpu': number;
2766
+ 'memory': number;
2767
+ };
2768
+ };
2769
+ };
2691
2770
  };
2692
2771
  /** Update an existing cluster. */
2693
2772
  declare class UpdateClusterEndpoint extends PostApiEndpoint<UpdateClusterRequest, UpdateClusterResult> {
@@ -2795,6 +2874,12 @@ declare type GetJobResult = {
2795
2874
  'buildConfiguration'?: {
2796
2875
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
2797
2876
  'pathIgnoreRules'?: string[];
2877
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
2878
+ 'isAllowList'?: boolean;
2879
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
2880
+ 'ciIgnoreFlagsEnabled'?: boolean;
2881
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
2882
+ 'ciIgnoreFlags'?: string[];
2798
2883
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
2799
2884
  'dockerfileTarget'?: string;
2800
2885
  /** Include .git folder inside the build context */
@@ -2949,6 +3034,12 @@ declare type CreateJobManualResult = {
2949
3034
  'buildConfiguration'?: {
2950
3035
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
2951
3036
  'pathIgnoreRules'?: string[];
3037
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
3038
+ 'isAllowList'?: boolean;
3039
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
3040
+ 'ciIgnoreFlagsEnabled'?: boolean;
3041
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
3042
+ 'ciIgnoreFlags'?: string[];
2952
3043
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
2953
3044
  'dockerfileTarget'?: string;
2954
3045
  /** Include .git folder inside the build context */
@@ -3169,6 +3260,12 @@ declare type CreateJobManualData = {
3169
3260
  'buildConfiguration'?: {
3170
3261
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
3171
3262
  'pathIgnoreRules'?: string[];
3263
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
3264
+ 'isAllowList'?: boolean;
3265
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
3266
+ 'ciIgnoreFlagsEnabled'?: boolean;
3267
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
3268
+ 'ciIgnoreFlags'?: string[];
3172
3269
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
3173
3270
  'dockerfileTarget'?: string;
3174
3271
  /** Include .git folder inside the build context */
@@ -3180,12 +3277,12 @@ declare type CreateJobManualData = {
3180
3277
  'dockerfile': {
3181
3278
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
3182
3279
  'buildEngine'?: 'kaniko' | 'buildkit';
3183
- /** Should intermediate image layers be cached? */
3184
- 'useCache'?: boolean;
3185
3280
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
3186
3281
  'dockerFilePath': string;
3187
3282
  /** The working directory of the Dockerfile. Example: "/" */
3188
3283
  'dockerWorkDir': string;
3284
+ /** Should intermediate image layers be cached? */
3285
+ 'useCache'?: boolean;
3189
3286
  };
3190
3287
  } | {
3191
3288
  'buildpack': {
@@ -3314,6 +3411,12 @@ declare type PutJobManualResult = {
3314
3411
  'buildConfiguration'?: {
3315
3412
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
3316
3413
  'pathIgnoreRules'?: string[];
3414
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
3415
+ 'isAllowList'?: boolean;
3416
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
3417
+ 'ciIgnoreFlagsEnabled'?: boolean;
3418
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
3419
+ 'ciIgnoreFlags'?: string[];
3317
3420
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
3318
3421
  'dockerfileTarget'?: string;
3319
3422
  /** Include .git folder inside the build context */
@@ -3325,12 +3428,12 @@ declare type PutJobManualResult = {
3325
3428
  'dockerfile': {
3326
3429
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
3327
3430
  'buildEngine'?: 'kaniko' | 'buildkit';
3328
- /** Should intermediate image layers be cached? */
3329
- 'useCache'?: boolean;
3330
3431
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
3331
3432
  'dockerFilePath': string;
3332
3433
  /** The working directory of the Dockerfile. Example: "/" */
3333
3434
  'dockerWorkDir': string;
3435
+ /** Should intermediate image layers be cached? */
3436
+ 'useCache'?: boolean;
3334
3437
  };
3335
3438
  } | {
3336
3439
  'buildpack': {
@@ -3533,6 +3636,12 @@ declare type PutJobManualData = {
3533
3636
  'buildConfiguration'?: {
3534
3637
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
3535
3638
  'pathIgnoreRules'?: string[];
3639
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
3640
+ 'isAllowList'?: boolean;
3641
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
3642
+ 'ciIgnoreFlagsEnabled'?: boolean;
3643
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
3644
+ 'ciIgnoreFlags'?: string[];
3536
3645
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
3537
3646
  'dockerfileTarget'?: string;
3538
3647
  /** Include .git folder inside the build context */
@@ -3544,12 +3653,12 @@ declare type PutJobManualData = {
3544
3653
  'dockerfile': {
3545
3654
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
3546
3655
  'buildEngine'?: 'kaniko' | 'buildkit';
3547
- /** Should intermediate image layers be cached? */
3548
- 'useCache'?: boolean;
3549
3656
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
3550
3657
  'dockerFilePath': string;
3551
3658
  /** The working directory of the Dockerfile. Example: "/" */
3552
3659
  'dockerWorkDir': string;
3660
+ /** Should intermediate image layers be cached? */
3661
+ 'useCache'?: boolean;
3553
3662
  };
3554
3663
  } | {
3555
3664
  'buildpack': {
@@ -3678,6 +3787,12 @@ declare type PatchJobManualResult = {
3678
3787
  'buildConfiguration'?: {
3679
3788
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
3680
3789
  'pathIgnoreRules'?: string[];
3790
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
3791
+ 'isAllowList'?: boolean;
3792
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
3793
+ 'ciIgnoreFlagsEnabled'?: boolean;
3794
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
3795
+ 'ciIgnoreFlags'?: string[];
3681
3796
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
3682
3797
  'dockerfileTarget'?: string;
3683
3798
  /** Include .git folder inside the build context */
@@ -3689,12 +3804,12 @@ declare type PatchJobManualResult = {
3689
3804
  'dockerfile': {
3690
3805
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
3691
3806
  'buildEngine'?: 'kaniko' | 'buildkit';
3692
- /** Should intermediate image layers be cached? */
3693
- 'useCache'?: boolean;
3694
3807
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
3695
3808
  'dockerFilePath': string;
3696
3809
  /** The working directory of the Dockerfile. Example: "/" */
3697
3810
  'dockerWorkDir': string;
3811
+ /** Should intermediate image layers be cached? */
3812
+ 'useCache'?: boolean;
3698
3813
  };
3699
3814
  } | {
3700
3815
  'buildpack': {
@@ -3786,17 +3901,23 @@ declare type PatchJobManualData = {
3786
3901
  'buildConfiguration'?: {
3787
3902
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
3788
3903
  'pathIgnoreRules'?: string[];
3904
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
3905
+ 'isAllowList'?: boolean;
3906
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
3907
+ 'ciIgnoreFlagsEnabled'?: boolean;
3908
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
3909
+ 'ciIgnoreFlags'?: string[];
3789
3910
  };
3790
3911
  'buildSettings'?: {
3791
3912
  'dockerfile'?: {
3792
3913
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
3793
3914
  'buildEngine'?: 'kaniko' | 'buildkit';
3794
- /** Should intermediate image layers be cached? */
3795
- 'useCache'?: boolean;
3796
3915
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
3797
3916
  'dockerFilePath'?: string;
3798
3917
  /** The working directory of the Dockerfile. Example: "/" */
3799
3918
  'dockerWorkDir'?: string;
3919
+ /** Should intermediate image layers be cached? */
3920
+ 'useCache'?: boolean;
3800
3921
  };
3801
3922
  'buildpack'?: {
3802
3923
  /** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
@@ -3882,6 +4003,12 @@ declare type CreateJobCronResult = {
3882
4003
  'buildConfiguration'?: {
3883
4004
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
3884
4005
  'pathIgnoreRules'?: string[];
4006
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
4007
+ 'isAllowList'?: boolean;
4008
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
4009
+ 'ciIgnoreFlagsEnabled'?: boolean;
4010
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
4011
+ 'ciIgnoreFlags'?: string[];
3885
4012
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
3886
4013
  'dockerfileTarget'?: string;
3887
4014
  /** Include .git folder inside the build context */
@@ -4108,6 +4235,12 @@ declare type CreateJobCronData = {
4108
4235
  'buildConfiguration'?: {
4109
4236
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
4110
4237
  'pathIgnoreRules'?: string[];
4238
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
4239
+ 'isAllowList'?: boolean;
4240
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
4241
+ 'ciIgnoreFlagsEnabled'?: boolean;
4242
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
4243
+ 'ciIgnoreFlags'?: string[];
4111
4244
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
4112
4245
  'dockerfileTarget'?: string;
4113
4246
  /** Include .git folder inside the build context */
@@ -4119,12 +4252,12 @@ declare type CreateJobCronData = {
4119
4252
  'dockerfile': {
4120
4253
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4121
4254
  'buildEngine'?: 'kaniko' | 'buildkit';
4122
- /** Should intermediate image layers be cached? */
4123
- 'useCache'?: boolean;
4124
4255
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4125
4256
  'dockerFilePath': string;
4126
4257
  /** The working directory of the Dockerfile. Example: "/" */
4127
4258
  'dockerWorkDir': string;
4259
+ /** Should intermediate image layers be cached? */
4260
+ 'useCache'?: boolean;
4128
4261
  };
4129
4262
  } | {
4130
4263
  'buildpack': {
@@ -4257,6 +4390,12 @@ declare type PutJobCronResult = {
4257
4390
  'buildConfiguration'?: {
4258
4391
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
4259
4392
  'pathIgnoreRules'?: string[];
4393
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
4394
+ 'isAllowList'?: boolean;
4395
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
4396
+ 'ciIgnoreFlagsEnabled'?: boolean;
4397
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
4398
+ 'ciIgnoreFlags'?: string[];
4260
4399
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
4261
4400
  'dockerfileTarget'?: string;
4262
4401
  /** Include .git folder inside the build context */
@@ -4268,12 +4407,12 @@ declare type PutJobCronResult = {
4268
4407
  'dockerfile': {
4269
4408
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4270
4409
  'buildEngine'?: 'kaniko' | 'buildkit';
4271
- /** Should intermediate image layers be cached? */
4272
- 'useCache'?: boolean;
4273
4410
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4274
4411
  'dockerFilePath': string;
4275
4412
  /** The working directory of the Dockerfile. Example: "/" */
4276
4413
  'dockerWorkDir': string;
4414
+ /** Should intermediate image layers be cached? */
4415
+ 'useCache'?: boolean;
4277
4416
  };
4278
4417
  } | {
4279
4418
  'buildpack': {
@@ -4480,6 +4619,12 @@ declare type PutJobCronData = {
4480
4619
  'buildConfiguration'?: {
4481
4620
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
4482
4621
  'pathIgnoreRules'?: string[];
4622
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
4623
+ 'isAllowList'?: boolean;
4624
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
4625
+ 'ciIgnoreFlagsEnabled'?: boolean;
4626
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
4627
+ 'ciIgnoreFlags'?: string[];
4483
4628
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
4484
4629
  'dockerfileTarget'?: string;
4485
4630
  /** Include .git folder inside the build context */
@@ -4491,12 +4636,12 @@ declare type PutJobCronData = {
4491
4636
  'dockerfile': {
4492
4637
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4493
4638
  'buildEngine'?: 'kaniko' | 'buildkit';
4494
- /** Should intermediate image layers be cached? */
4495
- 'useCache'?: boolean;
4496
4639
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4497
4640
  'dockerFilePath': string;
4498
4641
  /** The working directory of the Dockerfile. Example: "/" */
4499
4642
  'dockerWorkDir': string;
4643
+ /** Should intermediate image layers be cached? */
4644
+ 'useCache'?: boolean;
4500
4645
  };
4501
4646
  } | {
4502
4647
  'buildpack': {
@@ -4629,6 +4774,12 @@ declare type PatchJobCronResult = {
4629
4774
  'buildConfiguration'?: {
4630
4775
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
4631
4776
  'pathIgnoreRules'?: string[];
4777
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
4778
+ 'isAllowList'?: boolean;
4779
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
4780
+ 'ciIgnoreFlagsEnabled'?: boolean;
4781
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
4782
+ 'ciIgnoreFlags'?: string[];
4632
4783
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
4633
4784
  'dockerfileTarget'?: string;
4634
4785
  /** Include .git folder inside the build context */
@@ -4640,12 +4791,12 @@ declare type PatchJobCronResult = {
4640
4791
  'dockerfile': {
4641
4792
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4642
4793
  'buildEngine'?: 'kaniko' | 'buildkit';
4643
- /** Should intermediate image layers be cached? */
4644
- 'useCache'?: boolean;
4645
4794
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4646
4795
  'dockerFilePath': string;
4647
4796
  /** The working directory of the Dockerfile. Example: "/" */
4648
4797
  'dockerWorkDir': string;
4798
+ /** Should intermediate image layers be cached? */
4799
+ 'useCache'?: boolean;
4649
4800
  };
4650
4801
  } | {
4651
4802
  'buildpack': {
@@ -4741,17 +4892,23 @@ declare type PatchJobCronData = {
4741
4892
  'buildConfiguration'?: {
4742
4893
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
4743
4894
  'pathIgnoreRules'?: string[];
4895
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
4896
+ 'isAllowList'?: boolean;
4897
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
4898
+ 'ciIgnoreFlagsEnabled'?: boolean;
4899
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
4900
+ 'ciIgnoreFlags'?: string[];
4744
4901
  };
4745
4902
  'buildSettings'?: {
4746
4903
  'dockerfile'?: {
4747
4904
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
4748
4905
  'buildEngine'?: 'kaniko' | 'buildkit';
4749
- /** Should intermediate image layers be cached? */
4750
- 'useCache'?: boolean;
4751
4906
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
4752
4907
  'dockerFilePath'?: string;
4753
4908
  /** The working directory of the Dockerfile. Example: "/" */
4754
4909
  'dockerWorkDir'?: string;
4910
+ /** Should intermediate image layers be cached? */
4911
+ 'useCache'?: boolean;
4755
4912
  };
4756
4913
  'buildpack'?: {
4757
4914
  /** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
@@ -5441,6 +5598,12 @@ declare type UpdateJobBuildoptionsData = {
5441
5598
  };
5442
5599
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
5443
5600
  'pathIgnoreRules'?: string[];
5601
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
5602
+ 'isAllowList'?: boolean;
5603
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
5604
+ 'ciIgnoreFlagsEnabled'?: boolean;
5605
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
5606
+ 'ciIgnoreFlags'?: string[];
5444
5607
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
5445
5608
  'dockerfileTarget'?: string;
5446
5609
  /** Include .git folder inside the build context */
@@ -5460,9 +5623,21 @@ declare type UpdateJobBuildoptionsData = {
5460
5623
  };
5461
5624
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
5462
5625
  'pathIgnoreRules'?: string[];
5626
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
5627
+ 'isAllowList'?: boolean;
5628
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
5629
+ 'ciIgnoreFlagsEnabled'?: boolean;
5630
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
5631
+ 'ciIgnoreFlags'?: string[];
5463
5632
  } | {
5464
5633
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
5465
5634
  'pathIgnoreRules'?: string[];
5635
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
5636
+ 'isAllowList'?: boolean;
5637
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
5638
+ 'ciIgnoreFlagsEnabled'?: boolean;
5639
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
5640
+ 'ciIgnoreFlags'?: string[];
5466
5641
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
5467
5642
  'dockerfileTarget'?: string;
5468
5643
  /** Include .git folder inside the build context */
@@ -7921,7 +8096,7 @@ declare type CreateServiceCombinedResult = {
7921
8096
  /** Details about the current deployment status. */
7922
8097
  'deployment'?: {
7923
8098
  /** The current status of the deployment. Example: "COMPLETED" */
7924
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
8099
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
7925
8100
  /** The reason the current deployment was started. Example: "DEPLOYING" */
7926
8101
  'reason': 'SCALING' | 'DEPLOYING';
7927
8102
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -7999,6 +8174,12 @@ declare type CreateServiceCombinedResult = {
7999
8174
  'buildConfiguration': {
8000
8175
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
8001
8176
  'pathIgnoreRules'?: string[];
8177
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
8178
+ 'isAllowList'?: boolean;
8179
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
8180
+ 'ciIgnoreFlagsEnabled'?: boolean;
8181
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
8182
+ 'ciIgnoreFlags'?: string[];
8002
8183
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
8003
8184
  'dockerfileTarget'?: string;
8004
8185
  /** Include .git folder inside the build context */
@@ -8080,6 +8261,10 @@ declare type CreateServiceCombinedData = {
8080
8261
  'storageSize'?: number;
8081
8262
  };
8082
8263
  };
8264
+ 'strategy'?: {
8265
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
8266
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
8267
+ };
8083
8268
  };
8084
8269
  'ports'?: {
8085
8270
  /** The name used to identify the port. Example: "port-1" */
@@ -8129,12 +8314,12 @@ declare type CreateServiceCombinedData = {
8129
8314
  'dockerfile': {
8130
8315
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
8131
8316
  'buildEngine'?: 'kaniko' | 'buildkit';
8132
- /** Should intermediate image layers be cached? */
8133
- 'useCache'?: boolean;
8134
8317
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
8135
8318
  'dockerFilePath': string;
8136
8319
  /** The working directory of the Dockerfile. Example: "/" */
8137
8320
  'dockerWorkDir': string;
8321
+ /** Should intermediate image layers be cached? */
8322
+ 'useCache'?: boolean;
8138
8323
  };
8139
8324
  } | {
8140
8325
  'buildpack': {
@@ -8151,6 +8336,12 @@ declare type CreateServiceCombinedData = {
8151
8336
  'buildConfiguration'?: {
8152
8337
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
8153
8338
  'pathIgnoreRules'?: string[];
8339
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
8340
+ 'isAllowList'?: boolean;
8341
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
8342
+ 'ciIgnoreFlagsEnabled'?: boolean;
8343
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
8344
+ 'ciIgnoreFlags'?: string[];
8154
8345
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
8155
8346
  'dockerfileTarget'?: string;
8156
8347
  /** Include .git folder inside the build context */
@@ -8237,6 +8428,10 @@ declare type PutServiceCombinedResult = {
8237
8428
  'storageSize'?: number;
8238
8429
  };
8239
8430
  };
8431
+ 'strategy'?: {
8432
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
8433
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
8434
+ };
8240
8435
  };
8241
8436
  'ports'?: {
8242
8437
  /** The name used to identify the port. Example: "port-1" */
@@ -8286,12 +8481,12 @@ declare type PutServiceCombinedResult = {
8286
8481
  'dockerfile': {
8287
8482
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
8288
8483
  'buildEngine'?: 'kaniko' | 'buildkit';
8289
- /** Should intermediate image layers be cached? */
8290
- 'useCache'?: boolean;
8291
8484
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
8292
8485
  'dockerFilePath': string;
8293
8486
  /** The working directory of the Dockerfile. Example: "/" */
8294
8487
  'dockerWorkDir': string;
8488
+ /** Should intermediate image layers be cached? */
8489
+ 'useCache'?: boolean;
8295
8490
  };
8296
8491
  } | {
8297
8492
  'buildpack': {
@@ -8308,6 +8503,12 @@ declare type PutServiceCombinedResult = {
8308
8503
  'buildConfiguration'?: {
8309
8504
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
8310
8505
  'pathIgnoreRules'?: string[];
8506
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
8507
+ 'isAllowList'?: boolean;
8508
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
8509
+ 'ciIgnoreFlagsEnabled'?: boolean;
8510
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
8511
+ 'ciIgnoreFlags'?: string[];
8311
8512
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
8312
8513
  'dockerfileTarget'?: string;
8313
8514
  /** Include .git folder inside the build context */
@@ -8371,7 +8572,7 @@ declare type PutServiceCombinedResult = {
8371
8572
  /** Details about the current deployment status. */
8372
8573
  'deployment'?: {
8373
8574
  /** The current status of the deployment. Example: "COMPLETED" */
8374
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
8575
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
8375
8576
  /** The reason the current deployment was started. Example: "DEPLOYING" */
8376
8577
  'reason': 'SCALING' | 'DEPLOYING';
8377
8578
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -8425,6 +8626,10 @@ declare type PutServiceCombinedData = {
8425
8626
  'storageSize'?: number;
8426
8627
  };
8427
8628
  };
8629
+ 'strategy'?: {
8630
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
8631
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
8632
+ };
8428
8633
  };
8429
8634
  'ports'?: {
8430
8635
  /** The name used to identify the port. Example: "port-1" */
@@ -8474,12 +8679,12 @@ declare type PutServiceCombinedData = {
8474
8679
  'dockerfile': {
8475
8680
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
8476
8681
  'buildEngine'?: 'kaniko' | 'buildkit';
8477
- /** Should intermediate image layers be cached? */
8478
- 'useCache'?: boolean;
8479
8682
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
8480
8683
  'dockerFilePath': string;
8481
8684
  /** The working directory of the Dockerfile. Example: "/" */
8482
8685
  'dockerWorkDir': string;
8686
+ /** Should intermediate image layers be cached? */
8687
+ 'useCache'?: boolean;
8483
8688
  };
8484
8689
  } | {
8485
8690
  'buildpack': {
@@ -8496,6 +8701,12 @@ declare type PutServiceCombinedData = {
8496
8701
  'buildConfiguration'?: {
8497
8702
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
8498
8703
  'pathIgnoreRules'?: string[];
8704
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
8705
+ 'isAllowList'?: boolean;
8706
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
8707
+ 'ciIgnoreFlagsEnabled'?: boolean;
8708
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
8709
+ 'ciIgnoreFlags'?: string[];
8499
8710
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
8500
8711
  'dockerfileTarget'?: string;
8501
8712
  /** Include .git folder inside the build context */
@@ -8582,6 +8793,10 @@ declare type PatchServiceCombinedResult = {
8582
8793
  'storageSize'?: number;
8583
8794
  };
8584
8795
  };
8796
+ 'strategy'?: {
8797
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
8798
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
8799
+ };
8585
8800
  };
8586
8801
  'ports'?: {
8587
8802
  /** The name used to identify the port. Example: "port-1" */
@@ -8631,12 +8846,12 @@ declare type PatchServiceCombinedResult = {
8631
8846
  'dockerfile': {
8632
8847
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
8633
8848
  'buildEngine'?: 'kaniko' | 'buildkit';
8634
- /** Should intermediate image layers be cached? */
8635
- 'useCache'?: boolean;
8636
8849
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
8637
8850
  'dockerFilePath': string;
8638
8851
  /** The working directory of the Dockerfile. Example: "/" */
8639
8852
  'dockerWorkDir': string;
8853
+ /** Should intermediate image layers be cached? */
8854
+ 'useCache'?: boolean;
8640
8855
  };
8641
8856
  } | {
8642
8857
  'buildpack': {
@@ -8653,6 +8868,12 @@ declare type PatchServiceCombinedResult = {
8653
8868
  'buildConfiguration'?: {
8654
8869
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
8655
8870
  'pathIgnoreRules'?: string[];
8871
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
8872
+ 'isAllowList'?: boolean;
8873
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
8874
+ 'ciIgnoreFlagsEnabled'?: boolean;
8875
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
8876
+ 'ciIgnoreFlags'?: string[];
8656
8877
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
8657
8878
  'dockerfileTarget'?: string;
8658
8879
  /** Include .git folder inside the build context */
@@ -8716,7 +8937,7 @@ declare type PatchServiceCombinedResult = {
8716
8937
  /** Details about the current deployment status. */
8717
8938
  'deployment'?: {
8718
8939
  /** The current status of the deployment. Example: "COMPLETED" */
8719
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
8940
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
8720
8941
  /** The reason the current deployment was started. Example: "DEPLOYING" */
8721
8942
  'reason': 'SCALING' | 'DEPLOYING';
8722
8943
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -8761,6 +8982,10 @@ declare type PatchServiceCombinedData = {
8761
8982
  'storageSize'?: number;
8762
8983
  };
8763
8984
  };
8985
+ 'strategy'?: {
8986
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
8987
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
8988
+ };
8764
8989
  };
8765
8990
  'ports'?: {
8766
8991
  /** The name used to identify the port. Example: "port-1" */
@@ -8810,12 +9035,12 @@ declare type PatchServiceCombinedData = {
8810
9035
  'dockerfile'?: {
8811
9036
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
8812
9037
  'buildEngine'?: 'kaniko' | 'buildkit';
8813
- /** Should intermediate image layers be cached? */
8814
- 'useCache'?: boolean;
8815
9038
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
8816
9039
  'dockerFilePath'?: string;
8817
9040
  /** The working directory of the Dockerfile. Example: "/" */
8818
9041
  'dockerWorkDir'?: string;
9042
+ /** Should intermediate image layers be cached? */
9043
+ 'useCache'?: boolean;
8819
9044
  };
8820
9045
  'buildpack'?: {
8821
9046
  /** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
@@ -8831,6 +9056,12 @@ declare type PatchServiceCombinedData = {
8831
9056
  'buildConfiguration'?: {
8832
9057
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
8833
9058
  'pathIgnoreRules'?: string[];
9059
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
9060
+ 'isAllowList'?: boolean;
9061
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
9062
+ 'ciIgnoreFlagsEnabled'?: boolean;
9063
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
9064
+ 'ciIgnoreFlags'?: string[];
8834
9065
  };
8835
9066
  /** An object containing the runtime environment to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
8836
9067
  'runtimeEnvironment'?: any;
@@ -8906,7 +9137,7 @@ declare type CreateServiceDeploymentResult = {
8906
9137
  /** Details about the current deployment status. */
8907
9138
  'deployment'?: {
8908
9139
  /** The current status of the deployment. Example: "COMPLETED" */
8909
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
9140
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
8910
9141
  /** The reason the current deployment was started. Example: "DEPLOYING" */
8911
9142
  'reason': 'SCALING' | 'DEPLOYING';
8912
9143
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -9022,6 +9253,10 @@ declare type CreateServiceDeploymentData = {
9022
9253
  'storageSize'?: number;
9023
9254
  };
9024
9255
  };
9256
+ 'strategy'?: {
9257
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9258
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9259
+ };
9025
9260
  'internal': {
9026
9261
  /** ID of the build service to deploy Example: "example-build-service" */
9027
9262
  'id'?: string;
@@ -9061,6 +9296,10 @@ declare type CreateServiceDeploymentData = {
9061
9296
  'storageSize'?: number;
9062
9297
  };
9063
9298
  };
9299
+ 'strategy'?: {
9300
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9301
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9302
+ };
9064
9303
  'external': {
9065
9304
  /** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
9066
9305
  'imagePath': string;
@@ -9096,6 +9335,10 @@ declare type CreateServiceDeploymentData = {
9096
9335
  'storageSize'?: number;
9097
9336
  };
9098
9337
  };
9338
+ 'strategy'?: {
9339
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9340
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9341
+ };
9099
9342
  };
9100
9343
  'ports'?: {
9101
9344
  /** The name used to identify the port. Example: "port-1" */
@@ -9204,6 +9447,10 @@ declare type PutServiceDeploymentResult = {
9204
9447
  'storageSize'?: number;
9205
9448
  };
9206
9449
  };
9450
+ 'strategy'?: {
9451
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9452
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9453
+ };
9207
9454
  'internal'?: {
9208
9455
  /** ID of the build service to deploy Example: "example-build-service" */
9209
9456
  'id'?: string;
@@ -9298,7 +9545,7 @@ declare type PutServiceDeploymentResult = {
9298
9545
  /** Details about the current deployment status. */
9299
9546
  'deployment'?: {
9300
9547
  /** The current status of the deployment. Example: "COMPLETED" */
9301
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
9548
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
9302
9549
  /** The reason the current deployment was started. Example: "DEPLOYING" */
9303
9550
  'reason': 'SCALING' | 'DEPLOYING';
9304
9551
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -9353,6 +9600,10 @@ declare type PutServiceDeploymentData = {
9353
9600
  'storageSize'?: number;
9354
9601
  };
9355
9602
  };
9603
+ 'strategy'?: {
9604
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9605
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9606
+ };
9356
9607
  'internal': {
9357
9608
  /** ID of the build service to deploy Example: "example-build-service" */
9358
9609
  'id'?: string;
@@ -9392,6 +9643,10 @@ declare type PutServiceDeploymentData = {
9392
9643
  'storageSize'?: number;
9393
9644
  };
9394
9645
  };
9646
+ 'strategy'?: {
9647
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9648
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9649
+ };
9395
9650
  'external': {
9396
9651
  /** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
9397
9652
  'imagePath': string;
@@ -9427,6 +9682,10 @@ declare type PutServiceDeploymentData = {
9427
9682
  'storageSize'?: number;
9428
9683
  };
9429
9684
  };
9685
+ 'strategy'?: {
9686
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9687
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9688
+ };
9430
9689
  };
9431
9690
  'ports'?: {
9432
9691
  /** The name used to identify the port. Example: "port-1" */
@@ -9535,6 +9794,10 @@ declare type PatchServiceDeploymentResult = {
9535
9794
  'storageSize'?: number;
9536
9795
  };
9537
9796
  };
9797
+ 'strategy'?: {
9798
+ /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
9799
+ 'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
9800
+ };
9538
9801
  'internal'?: {
9539
9802
  /** ID of the build service to deploy Example: "example-build-service" */
9540
9803
  'id'?: string;
@@ -9629,7 +9892,7 @@ declare type PatchServiceDeploymentResult = {
9629
9892
  /** Details about the current deployment status. */
9630
9893
  'deployment'?: {
9631
9894
  /** The current status of the deployment. Example: "COMPLETED" */
9632
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
9895
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
9633
9896
  /** The reason the current deployment was started. Example: "DEPLOYING" */
9634
9897
  'reason': 'SCALING' | 'DEPLOYING';
9635
9898
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -9756,7 +10019,7 @@ declare type CreateServiceBuildResult = {
9756
10019
  /** Details about the current deployment status. */
9757
10020
  'deployment'?: {
9758
10021
  /** The current status of the deployment. Example: "COMPLETED" */
9759
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
10022
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
9760
10023
  /** The reason the current deployment was started. Example: "DEPLOYING" */
9761
10024
  'reason': 'SCALING' | 'DEPLOYING';
9762
10025
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -9843,12 +10106,12 @@ declare type CreateServiceBuildData = {
9843
10106
  'dockerfile': {
9844
10107
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
9845
10108
  'buildEngine'?: 'kaniko' | 'buildkit';
9846
- /** Should intermediate image layers be cached? */
9847
- 'useCache'?: boolean;
9848
10109
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
9849
10110
  'dockerFilePath': string;
9850
10111
  /** The working directory of the Dockerfile. Example: "/" */
9851
10112
  'dockerWorkDir': string;
10113
+ /** Should intermediate image layers be cached? */
10114
+ 'useCache'?: boolean;
9852
10115
  };
9853
10116
  } | {
9854
10117
  'buildpack': {
@@ -9869,6 +10132,12 @@ declare type CreateServiceBuildData = {
9869
10132
  'branchRestrictions'?: string[];
9870
10133
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
9871
10134
  'pathIgnoreRules'?: string[];
10135
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
10136
+ 'isAllowList'?: boolean;
10137
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
10138
+ 'ciIgnoreFlagsEnabled'?: boolean;
10139
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
10140
+ 'ciIgnoreFlags'?: string[];
9872
10141
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
9873
10142
  'dockerfileTarget'?: string;
9874
10143
  /** Include .git folder inside the build context */
@@ -9913,12 +10182,12 @@ declare type PutServiceBuildResult = {
9913
10182
  'dockerfile': {
9914
10183
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
9915
10184
  'buildEngine'?: 'kaniko' | 'buildkit';
9916
- /** Should intermediate image layers be cached? */
9917
- 'useCache'?: boolean;
9918
10185
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
9919
10186
  'dockerFilePath': string;
9920
10187
  /** The working directory of the Dockerfile. Example: "/" */
9921
10188
  'dockerWorkDir': string;
10189
+ /** Should intermediate image layers be cached? */
10190
+ 'useCache'?: boolean;
9922
10191
  };
9923
10192
  } | {
9924
10193
  'buildpack': {
@@ -9939,6 +10208,12 @@ declare type PutServiceBuildResult = {
9939
10208
  'branchRestrictions'?: string[];
9940
10209
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
9941
10210
  'pathIgnoreRules'?: string[];
10211
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
10212
+ 'isAllowList'?: boolean;
10213
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
10214
+ 'ciIgnoreFlagsEnabled'?: boolean;
10215
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
10216
+ 'ciIgnoreFlags'?: string[];
9942
10217
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
9943
10218
  'dockerfileTarget'?: string;
9944
10219
  /** Include .git folder inside the build context */
@@ -10002,12 +10277,12 @@ declare type PutServiceBuildData = {
10002
10277
  'dockerfile': {
10003
10278
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
10004
10279
  'buildEngine'?: 'kaniko' | 'buildkit';
10005
- /** Should intermediate image layers be cached? */
10006
- 'useCache'?: boolean;
10007
10280
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
10008
10281
  'dockerFilePath': string;
10009
10282
  /** The working directory of the Dockerfile. Example: "/" */
10010
10283
  'dockerWorkDir': string;
10284
+ /** Should intermediate image layers be cached? */
10285
+ 'useCache'?: boolean;
10011
10286
  };
10012
10287
  } | {
10013
10288
  'buildpack': {
@@ -10028,6 +10303,12 @@ declare type PutServiceBuildData = {
10028
10303
  'branchRestrictions'?: string[];
10029
10304
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
10030
10305
  'pathIgnoreRules'?: string[];
10306
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
10307
+ 'isAllowList'?: boolean;
10308
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
10309
+ 'ciIgnoreFlagsEnabled'?: boolean;
10310
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
10311
+ 'ciIgnoreFlags'?: string[];
10031
10312
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
10032
10313
  'dockerfileTarget'?: string;
10033
10314
  /** Include .git folder inside the build context */
@@ -10072,12 +10353,12 @@ declare type PatchServiceBuildResult = {
10072
10353
  'dockerfile': {
10073
10354
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
10074
10355
  'buildEngine'?: 'kaniko' | 'buildkit';
10075
- /** Should intermediate image layers be cached? */
10076
- 'useCache'?: boolean;
10077
10356
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
10078
10357
  'dockerFilePath': string;
10079
10358
  /** The working directory of the Dockerfile. Example: "/" */
10080
10359
  'dockerWorkDir': string;
10360
+ /** Should intermediate image layers be cached? */
10361
+ 'useCache'?: boolean;
10081
10362
  };
10082
10363
  } | {
10083
10364
  'buildpack': {
@@ -10098,6 +10379,12 @@ declare type PatchServiceBuildResult = {
10098
10379
  'branchRestrictions'?: string[];
10099
10380
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
10100
10381
  'pathIgnoreRules'?: string[];
10382
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
10383
+ 'isAllowList'?: boolean;
10384
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
10385
+ 'ciIgnoreFlagsEnabled'?: boolean;
10386
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
10387
+ 'ciIgnoreFlags'?: string[];
10101
10388
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
10102
10389
  'dockerfileTarget'?: string;
10103
10390
  /** Include .git folder inside the build context */
@@ -10161,12 +10448,12 @@ declare type PatchServiceBuildData = {
10161
10448
  'dockerfile'?: {
10162
10449
  /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
10163
10450
  'buildEngine'?: 'kaniko' | 'buildkit';
10164
- /** Should intermediate image layers be cached? */
10165
- 'useCache'?: boolean;
10166
10451
  /** The file path of the Dockerfile. Example: "/Dockerfile" */
10167
10452
  'dockerFilePath'?: string;
10168
10453
  /** The working directory of the Dockerfile. Example: "/" */
10169
10454
  'dockerWorkDir'?: string;
10455
+ /** Should intermediate image layers be cached? */
10456
+ 'useCache'?: boolean;
10170
10457
  };
10171
10458
  'buildpack'?: {
10172
10459
  /** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
@@ -10186,6 +10473,12 @@ declare type PatchServiceBuildData = {
10186
10473
  'branchRestrictions'?: string[];
10187
10474
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
10188
10475
  'pathIgnoreRules'?: string[];
10476
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
10477
+ 'isAllowList'?: boolean;
10478
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
10479
+ 'ciIgnoreFlagsEnabled'?: boolean;
10480
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
10481
+ 'ciIgnoreFlags'?: string[];
10189
10482
  };
10190
10483
  /** An object containing the build arguments to set for the service Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
10191
10484
  'buildArguments'?: any;
@@ -10236,7 +10529,7 @@ declare type GetServiceResult = {
10236
10529
  /** Details about the current deployment status. */
10237
10530
  'deployment'?: {
10238
10531
  /** The current status of the deployment. Example: "COMPLETED" */
10239
- 'status': 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
10532
+ 'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
10240
10533
  /** The reason the current deployment was started. Example: "DEPLOYING" */
10241
10534
  'reason': 'SCALING' | 'DEPLOYING';
10242
10535
  /** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
@@ -10887,6 +11180,12 @@ declare type UpdateServiceBuildoptionsData = {
10887
11180
  'branchRestrictions'?: string[];
10888
11181
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
10889
11182
  'pathIgnoreRules'?: string[];
11183
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
11184
+ 'isAllowList'?: boolean;
11185
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
11186
+ 'ciIgnoreFlagsEnabled'?: boolean;
11187
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
11188
+ 'ciIgnoreFlags'?: string[];
10890
11189
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
10891
11190
  'dockerfileTarget'?: string;
10892
11191
  /** Include .git folder inside the build context */
@@ -10906,6 +11205,12 @@ declare type UpdateServiceBuildoptionsData = {
10906
11205
  };
10907
11206
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
10908
11207
  'pathIgnoreRules'?: string[];
11208
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
11209
+ 'isAllowList'?: boolean;
11210
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
11211
+ 'ciIgnoreFlagsEnabled'?: boolean;
11212
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
11213
+ 'ciIgnoreFlags'?: string[];
10909
11214
  } | {
10910
11215
  /** An array of pull request build rules. Only supported for build services. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
10911
11216
  'prRestrictions'?: string[];
@@ -10913,6 +11218,12 @@ declare type UpdateServiceBuildoptionsData = {
10913
11218
  'branchRestrictions'?: string[];
10914
11219
  /** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
10915
11220
  'pathIgnoreRules'?: string[];
11221
+ /** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
11222
+ 'isAllowList'?: boolean;
11223
+ /** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
11224
+ 'ciIgnoreFlagsEnabled'?: boolean;
11225
+ /** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
11226
+ 'ciIgnoreFlags'?: string[];
10916
11227
  /** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
10917
11228
  'dockerfileTarget'?: string;
10918
11229
  /** Include .git folder inside the build context */
@@ -11362,23 +11673,18 @@ declare class GetServicePullrequestsEndpoint extends GetApiEndpoint<GetServicePu
11362
11673
  declare type ListTemplatesResult = {
11363
11674
  /** An array of template objects. */
11364
11675
  'templates': {
11365
- /** ID of the template. Example: "example-template" */
11676
+ /** Name of the template. Example: "Example Template" */
11677
+ 'name': string;
11678
+ /** Description of the template. Example: "This is a sample template." */
11679
+ 'description'?: string;
11680
+ /** The version of the Northflank API to run the template against. Example: "v1" */
11681
+ 'apiVersion': 'v1';
11682
+ /** Identifier for the template Example: "example-template" */
11366
11683
  'id': string;
11367
- /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
11368
- 'createdAt': string;
11369
- /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
11370
- 'updatedAt': string;
11371
- /** If true, this template runs automatically after any changes are applied. */
11372
- 'autorun': boolean;
11373
- /** Details about the template. */
11374
- 'content': {
11375
- /** Name of the template. Example: "Example Template" */
11376
- 'name': string;
11377
- /** Description of the template. Example: "This is a sample template." */
11378
- 'description'?: string;
11379
- /** The version of the Northflank API to run the template against. Example: "v1" */
11380
- 'apiVersion': 'v1';
11381
- };
11684
+ /** time of creation */
11685
+ 'createdAt'?: string;
11686
+ /** time of update */
11687
+ 'updatedAt'?: string;
11382
11688
  }[];
11383
11689
  };
11384
11690
  declare type ListTemplatesCall = (opts: ListTemplatesRequest) => Promise<ApiCallResponse<ListTemplatesResult>>;
@@ -11405,123 +11711,113 @@ declare class ListTemplatesEndpoint extends GetApiEndpoint<ListTemplatesRequest,
11405
11711
  declare type CreateTemplateResult = {
11406
11712
  /** Details about the newly created template. */
11407
11713
  'template': {
11408
- /** ID of the template. Example: "example-template" */
11714
+ /** Name of the template. Example: "Example Template" */
11715
+ 'name': string;
11716
+ /** Description of the template. Example: "This is a sample template." */
11717
+ 'description'?: string;
11718
+ /** The version of the Northflank API to run the template against. Example: "v1" */
11719
+ 'apiVersion': 'v1';
11720
+ /** Details of the project the template will run in. */
11721
+ 'project': {
11722
+ /** The ID of the project to use. */
11723
+ 'id': string;
11724
+ } | {
11725
+ 'spec': {
11726
+ /** The name of the project. Example: "New Project" */
11727
+ 'name': string;
11728
+ /** The description of the project. Example: "This is a new project." */
11729
+ 'description'?: string;
11730
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
11731
+ 'color'?: string;
11732
+ /** The region the project will be hosted in. Example: "europe-west" */
11733
+ 'region': string;
11734
+ } | {
11735
+ /** The name of the project. Example: "New Project" */
11736
+ 'name': string;
11737
+ /** The description of the project. Example: "This is a new project." */
11738
+ 'description'?: string;
11739
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
11740
+ 'color'?: string;
11741
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
11742
+ 'clusterId'?: string;
11743
+ };
11744
+ };
11745
+ /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11746
+ 'arguments'?: any;
11747
+ 'spec': any;
11748
+ /** Identifier for the template Example: "example-template" */
11409
11749
  'id': string;
11410
- /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
11411
- 'createdAt': string;
11412
- /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
11413
- 'updatedAt': string;
11414
- /** If true, this template runs automatically after any changes are applied. */
11415
- 'autorun': boolean;
11416
- /** Details about the GitOps settings for the template. */
11417
- 'vcsData'?: {
11418
- /** URL of the Git repo the template is being synced with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11419
- 'repoUrl': string;
11420
- /** The VCS provider for the template. Example: "github" */
11750
+ 'gitops'?: {
11751
+ /** The VCS provider to use. Example: "github" */
11421
11752
  'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11422
- /** If projectType is self-hosted, the ID of the self-hosted vcs being used. */
11753
+ /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
11423
11754
  'selfHostedVcsId'?: string;
11424
- /** The name of the branch. Example: "main" */
11755
+ /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
11756
+ 'accountLogin'?: string;
11757
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11758
+ 'repoUrl': string;
11759
+ /** The name of the branch to use. Example: "main" */
11425
11760
  'branch': string;
11426
- /** The file path to the template in the repository. Example: "northflank.json" */
11761
+ /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
11427
11762
  'filePath': string;
11428
11763
  /** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
11429
11764
  'templateSha': string;
11430
11765
  };
11431
- /** The content of the template. */
11432
- 'content'?: {
11433
- /** Name of the template. Example: "Example Template" */
11434
- 'name': string;
11435
- /** Description of the template. Example: "This is a sample template." */
11436
- 'description'?: string;
11437
- /** The version of the Northflank API to run the template against. Example: "v1" */
11438
- 'apiVersion': 'v1';
11439
- /** Details of the project the template will run in. */
11440
- 'project': {
11441
- /** The ID of the project to use. */
11442
- 'id': string;
11443
- } | {
11444
- 'spec': {
11445
- /** The name of the project. Example: "New Project" */
11446
- 'name': string;
11447
- /** The description of the project. Example: "This is a new project." */
11448
- 'description'?: string;
11449
- /** The color of the project in the Northflank App. Example: "#EF233C" */
11450
- 'color'?: string;
11451
- /** The region the project will be hosted in. Example: "europe-west" */
11452
- 'region': string;
11453
- } | {
11454
- /** The name of the project. Example: "New Project" */
11455
- 'name': string;
11456
- /** The description of the project. Example: "This is a new project." */
11457
- 'description'?: string;
11458
- /** The color of the project in the Northflank App. Example: "#EF233C" */
11459
- 'color'?: string;
11460
- /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
11461
- 'clusterId'?: string;
11462
- };
11463
- };
11464
- /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11465
- 'arguments'?: any;
11466
- 'refs'?: any;
11467
- 'spec': any;
11766
+ 'options': {
11767
+ /** Whether autorun is enabled */
11768
+ 'autorun': boolean;
11468
11769
  };
11770
+ /** time of creation */
11771
+ 'createdAt'?: string;
11772
+ /** time of update */
11773
+ 'updatedAt'?: string;
11469
11774
  };
11470
- /** Details about the newly created template run. */
11471
11775
  'templateRun'?: {
11472
- /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
11473
- 'id': string;
11474
- /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
11475
- 'createdAt': string;
11476
- /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
11477
- 'updatedAt': string;
11478
- /** Details about the template being run. */
11479
- 'template': {
11480
- /** ID of the template Example: "example-template" */
11776
+ /** Name of the template. Example: "Example Template" */
11777
+ 'name': string;
11778
+ /** Description of the template. Example: "This is a sample template." */
11779
+ 'description'?: string;
11780
+ /** The version of the Northflank API to run the template against. Example: "v1" */
11781
+ 'apiVersion': 'v1';
11782
+ /** Details of the project the template will run in. */
11783
+ 'project': {
11784
+ /** The ID of the project to use. */
11481
11785
  'id': string;
11482
- /** The name of the template Example: "Example Template" */
11483
- 'name': string;
11484
- };
11485
- /** Status of the template run. Example: "success" */
11486
- 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
11487
- /** Details about the template run. */
11488
- 'content': {
11489
- /** Name of the template. Example: "Example Template" */
11490
- 'name': string;
11491
- /** Description of the template. Example: "This is a sample template." */
11492
- 'description'?: string;
11493
- /** The version of the Northflank API to run the template against. Example: "v1" */
11494
- 'apiVersion': 'v1';
11495
- /** Details of the project the template will run in. */
11496
- 'project': {
11497
- /** The ID of the project to use. */
11498
- 'id': string;
11786
+ } | {
11787
+ 'spec': {
11788
+ /** The name of the project. Example: "New Project" */
11789
+ 'name': string;
11790
+ /** The description of the project. Example: "This is a new project." */
11791
+ 'description'?: string;
11792
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
11793
+ 'color'?: string;
11794
+ /** The region the project will be hosted in. Example: "europe-west" */
11795
+ 'region': string;
11499
11796
  } | {
11500
- 'spec': {
11501
- /** The name of the project. Example: "New Project" */
11502
- 'name': string;
11503
- /** The description of the project. Example: "This is a new project." */
11504
- 'description'?: string;
11505
- /** The color of the project in the Northflank App. Example: "#EF233C" */
11506
- 'color'?: string;
11507
- /** The region the project will be hosted in. Example: "europe-west" */
11508
- 'region': string;
11509
- } | {
11510
- /** The name of the project. Example: "New Project" */
11511
- 'name': string;
11512
- /** The description of the project. Example: "This is a new project." */
11513
- 'description'?: string;
11514
- /** The color of the project in the Northflank App. Example: "#EF233C" */
11515
- 'color'?: string;
11516
- /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
11517
- 'clusterId'?: string;
11518
- };
11797
+ /** The name of the project. Example: "New Project" */
11798
+ 'name': string;
11799
+ /** The description of the project. Example: "This is a new project." */
11800
+ 'description'?: string;
11801
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
11802
+ 'color'?: string;
11803
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
11804
+ 'clusterId'?: string;
11519
11805
  };
11520
- /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11521
- 'arguments'?: any;
11522
- 'refs'?: any;
11523
- 'spec': any;
11524
11806
  };
11807
+ /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11808
+ 'arguments'?: any;
11809
+ 'spec': any;
11810
+ 'refs'?: any;
11811
+ /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
11812
+ 'id': string;
11813
+ /** Identifier for the template Example: "example-template" */
11814
+ 'templateId': string;
11815
+ /** Status of the template run Example: "pending" */
11816
+ 'status': 'pending' | 'running' | 'success' | 'failure';
11817
+ /** time of creation */
11818
+ 'createdAt'?: string;
11819
+ /** time of update */
11820
+ 'updatedAt'?: string;
11525
11821
  };
11526
11822
  };
11527
11823
  declare type CreateTemplateCall = (opts: CreateTemplateRequest) => Promise<ApiCallResponse<CreateTemplateResult>>;
@@ -11562,7 +11858,6 @@ declare type CreateTemplateData = {
11562
11858
  };
11563
11859
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11564
11860
  'arguments'?: any;
11565
- 'refs'?: any;
11566
11861
  'spec': any;
11567
11862
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
11568
11863
  'argumentOverrides'?: any;
@@ -11609,7 +11904,6 @@ declare type CreateTemplateData = {
11609
11904
  };
11610
11905
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11611
11906
  'arguments'?: any;
11612
- 'refs'?: any;
11613
11907
  'spec': any;
11614
11908
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
11615
11909
  'argumentOverrides'?: any;
@@ -11624,14 +11918,14 @@ declare type CreateTemplateData = {
11624
11918
  };
11625
11919
  /** GitOps data for syncing this template with a file in version control. */
11626
11920
  'gitops': {
11627
- /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11628
- 'repoUrl': string;
11629
11921
  /** The VCS provider to use. Example: "github" */
11630
11922
  'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11631
11923
  /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
11632
11924
  'selfHostedVcsId'?: string;
11633
11925
  /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
11634
11926
  'accountLogin'?: string;
11927
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11928
+ 'repoUrl': string;
11635
11929
  /** The name of the branch to use. Example: "main" */
11636
11930
  'branch': string;
11637
11931
  /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
@@ -11642,9 +11936,6 @@ declare type CreateTemplateData = {
11642
11936
  'name': string;
11643
11937
  /** Description of the template. Example: "This is a sample template." */
11644
11938
  'description'?: string;
11645
- /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11646
- 'arguments'?: any;
11647
- 'refs'?: any;
11648
11939
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
11649
11940
  'argumentOverrides'?: any;
11650
11941
  /** Additional options for the template creation. */
@@ -11658,14 +11949,14 @@ declare type CreateTemplateData = {
11658
11949
  };
11659
11950
  /** GitOps data for syncing this template with a file in version control. */
11660
11951
  'gitops': {
11661
- /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11662
- 'repoUrl': string;
11663
11952
  /** The VCS provider to use. Example: "github" */
11664
11953
  'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11665
11954
  /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
11666
11955
  'selfHostedVcsId'?: string;
11667
11956
  /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
11668
11957
  'accountLogin'?: string;
11958
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11959
+ 'repoUrl': string;
11669
11960
  /** The name of the branch to use. Example: "main" */
11670
11961
  'branch': string;
11671
11962
  /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
@@ -11682,31 +11973,95 @@ declare class CreateTemplateEndpoint extends PostApiEndpoint<CreateTemplateReque
11682
11973
  }
11683
11974
 
11684
11975
  declare type GetTemplateResult = {
11685
- /** ID of the template. Example: "example-template" */
11686
- 'id': string;
11687
- /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
11688
- 'createdAt': string;
11689
- /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
11690
- 'updatedAt': string;
11691
- /** If true, this template runs automatically after any changes are applied. */
11692
- 'autorun': boolean;
11693
- /** Details about the GitOps settings for the template. */
11694
- 'vcsData'?: {
11695
- /** URL of the Git repo the template is being synced with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11696
- 'repoUrl': string;
11697
- /** The VCS provider for the template. Example: "github" */
11698
- 'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11699
- /** If projectType is self-hosted, the ID of the self-hosted vcs being used. */
11700
- 'selfHostedVcsId'?: string;
11701
- /** The name of the branch. Example: "main" */
11702
- 'branch': string;
11703
- /** The file path to the template in the repository. Example: "northflank.json" */
11704
- 'filePath': string;
11705
- /** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
11706
- 'templateSha': string;
11976
+ /** Name of the template. Example: "Example Template" */
11977
+ 'name': string;
11978
+ /** Description of the template. Example: "This is a sample template." */
11979
+ 'description'?: string;
11980
+ /** The version of the Northflank API to run the template against. Example: "v1" */
11981
+ 'apiVersion': 'v1';
11982
+ /** Details of the project the template will run in. */
11983
+ 'project': {
11984
+ /** The ID of the project to use. */
11985
+ 'id': string;
11986
+ } | {
11987
+ 'spec': {
11988
+ /** The name of the project. Example: "New Project" */
11989
+ 'name': string;
11990
+ /** The description of the project. Example: "This is a new project." */
11991
+ 'description'?: string;
11992
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
11993
+ 'color'?: string;
11994
+ /** The region the project will be hosted in. Example: "europe-west" */
11995
+ 'region': string;
11996
+ } | {
11997
+ /** The name of the project. Example: "New Project" */
11998
+ 'name': string;
11999
+ /** The description of the project. Example: "This is a new project." */
12000
+ 'description'?: string;
12001
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
12002
+ 'color'?: string;
12003
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
12004
+ 'clusterId'?: string;
12005
+ };
11707
12006
  };
11708
- /** The content of the template. */
11709
- 'content'?: {
12007
+ /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
12008
+ 'arguments'?: any;
12009
+ 'spec': any;
12010
+ /** Identifier for the template Example: "example-template" */
12011
+ 'id': string;
12012
+ 'gitops'?: {
12013
+ /** The VCS provider to use. Example: "github" */
12014
+ 'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
12015
+ /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
12016
+ 'selfHostedVcsId'?: string;
12017
+ /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
12018
+ 'accountLogin'?: string;
12019
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
12020
+ 'repoUrl': string;
12021
+ /** The name of the branch to use. Example: "main" */
12022
+ 'branch': string;
12023
+ /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
12024
+ 'filePath': string;
12025
+ /** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
12026
+ 'templateSha': string;
12027
+ };
12028
+ 'options': {
12029
+ /** Whether autorun is enabled */
12030
+ 'autorun': boolean;
12031
+ };
12032
+ /** time of creation */
12033
+ 'createdAt'?: string;
12034
+ /** time of update */
12035
+ 'updatedAt'?: string;
12036
+ };
12037
+ declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
12038
+ declare type GetTemplateRequest = {
12039
+ parameters: GetTemplateParameters;
12040
+ options?: GetTemplateOptions;
12041
+ };
12042
+ declare type GetTemplateParameters = {
12043
+ /** ID of the template */ 'templateId': string;
12044
+ };
12045
+ declare type GetTemplateOptions = {
12046
+ /** The number of results to display per request. Maximum of 100 results per page. */
12047
+ 'per_page'?: number;
12048
+ /** The page number to access. */
12049
+ 'page'?: number;
12050
+ /** The cursor returned from the previous page of results, used to request the next page. */
12051
+ 'cursor'?: string;
12052
+ };
12053
+ /** Get information about the given template. */
12054
+ declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
12055
+ description: string;
12056
+ withAuth: boolean;
12057
+ requiredPermissions: string;
12058
+ endpointUrl: (opts: GetTemplateRequest) => string;
12059
+ body: () => undefined;
12060
+ }
12061
+
12062
+ declare type UpdateTemplateResult = {
12063
+ /** Details about the updated template. */
12064
+ 'template': {
11710
12065
  /** Name of the template. Example: "Example Template" */
11711
12066
  'name': string;
11712
12067
  /** Description of the template. Example: "This is a sample template." */
@@ -11740,61 +12095,35 @@ declare type GetTemplateResult = {
11740
12095
  };
11741
12096
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11742
12097
  'arguments'?: any;
11743
- 'refs'?: any;
11744
12098
  'spec': any;
12099
+ /** Identifier for the template Example: "example-template" */
12100
+ 'id': string;
12101
+ 'gitops'?: {
12102
+ /** The VCS provider to use. Example: "github" */
12103
+ 'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
12104
+ /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
12105
+ 'selfHostedVcsId'?: string;
12106
+ /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
12107
+ 'accountLogin'?: string;
12108
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
12109
+ 'repoUrl': string;
12110
+ /** The name of the branch to use. Example: "main" */
12111
+ 'branch': string;
12112
+ /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
12113
+ 'filePath': string;
12114
+ /** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
12115
+ 'templateSha': string;
12116
+ };
12117
+ 'options': {
12118
+ /** Whether autorun is enabled */
12119
+ 'autorun': boolean;
12120
+ };
12121
+ /** time of creation */
12122
+ 'createdAt'?: string;
12123
+ /** time of update */
12124
+ 'updatedAt'?: string;
11745
12125
  };
11746
- };
11747
- declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
11748
- declare type GetTemplateRequest = {
11749
- parameters: GetTemplateParameters;
11750
- options?: GetTemplateOptions;
11751
- };
11752
- declare type GetTemplateParameters = {
11753
- /** ID of the template */ 'templateId': string;
11754
- };
11755
- declare type GetTemplateOptions = {
11756
- /** The number of results to display per request. Maximum of 100 results per page. */
11757
- 'per_page'?: number;
11758
- /** The page number to access. */
11759
- 'page'?: number;
11760
- /** The cursor returned from the previous page of results, used to request the next page. */
11761
- 'cursor'?: string;
11762
- };
11763
- /** Get information about the given template. */
11764
- declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
11765
- description: string;
11766
- withAuth: boolean;
11767
- requiredPermissions: string;
11768
- endpointUrl: (opts: GetTemplateRequest) => string;
11769
- body: () => undefined;
11770
- }
11771
-
11772
- declare type UpdateTemplateResult = {
11773
- /** ID of the template. Example: "example-template" */
11774
- 'id': string;
11775
- /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
11776
- 'createdAt': string;
11777
- /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
11778
- 'updatedAt': string;
11779
- /** If true, this template runs automatically after any changes are applied. */
11780
- 'autorun': boolean;
11781
- /** Details about the GitOps settings for the template. */
11782
- 'vcsData'?: {
11783
- /** URL of the Git repo the template is being synced with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11784
- 'repoUrl': string;
11785
- /** The VCS provider for the template. Example: "github" */
11786
- 'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11787
- /** If projectType is self-hosted, the ID of the self-hosted vcs being used. */
11788
- 'selfHostedVcsId'?: string;
11789
- /** The name of the branch. Example: "main" */
11790
- 'branch': string;
11791
- /** The file path to the template in the repository. Example: "northflank.json" */
11792
- 'filePath': string;
11793
- /** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
11794
- 'templateSha': string;
11795
- };
11796
- /** The content of the template. */
11797
- 'content'?: {
12126
+ 'templateRun'?: {
11798
12127
  /** Name of the template. Example: "Example Template" */
11799
12128
  'name': string;
11800
12129
  /** Description of the template. Example: "This is a sample template." */
@@ -11828,8 +12157,18 @@ declare type UpdateTemplateResult = {
11828
12157
  };
11829
12158
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11830
12159
  'arguments'?: any;
11831
- 'refs'?: any;
11832
12160
  'spec': any;
12161
+ 'refs'?: any;
12162
+ /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
12163
+ 'id': string;
12164
+ /** Identifier for the template Example: "example-template" */
12165
+ 'templateId': string;
12166
+ /** Status of the template run Example: "pending" */
12167
+ 'status': 'pending' | 'running' | 'success' | 'failure';
12168
+ /** time of creation */
12169
+ 'createdAt'?: string;
12170
+ /** time of update */
12171
+ 'updatedAt'?: string;
11833
12172
  };
11834
12173
  };
11835
12174
  declare type UpdateTemplateCall = (opts: UpdateTemplateRequest) => Promise<ApiCallResponse<UpdateTemplateResult>>;
@@ -11874,7 +12213,6 @@ declare type UpdateTemplateData = {
11874
12213
  };
11875
12214
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11876
12215
  'arguments'?: any;
11877
- 'refs'?: any;
11878
12216
  'spec': any;
11879
12217
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
11880
12218
  'argumentOverrides'?: any;
@@ -11917,7 +12255,6 @@ declare type UpdateTemplateData = {
11917
12255
  };
11918
12256
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11919
12257
  'arguments'?: any;
11920
- 'refs'?: any;
11921
12258
  'spec': any;
11922
12259
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
11923
12260
  'argumentOverrides'?: any;
@@ -11928,14 +12265,14 @@ declare type UpdateTemplateData = {
11928
12265
  };
11929
12266
  /** GitOps data for syncing this template with a file in version control. If set to `null`, removes GitOps handling from this template. */
11930
12267
  'gitops': {
11931
- /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11932
- 'repoUrl': string;
11933
12268
  /** The VCS provider to use. Example: "github" */
11934
12269
  'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11935
12270
  /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
11936
12271
  'selfHostedVcsId'?: string;
11937
12272
  /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
11938
12273
  'accountLogin'?: string;
12274
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
12275
+ 'repoUrl': string;
11939
12276
  /** The name of the branch to use. Example: "main" */
11940
12277
  'branch': string;
11941
12278
  /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
@@ -11946,9 +12283,6 @@ declare type UpdateTemplateData = {
11946
12283
  'name': string;
11947
12284
  /** Description of the template. Example: "This is a sample template." */
11948
12285
  'description'?: string;
11949
- /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11950
- 'arguments'?: any;
11951
- 'refs'?: any;
11952
12286
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
11953
12287
  'argumentOverrides'?: any;
11954
12288
  /** Additional options for the template creation. */
@@ -11958,14 +12292,14 @@ declare type UpdateTemplateData = {
11958
12292
  };
11959
12293
  /** GitOps data for syncing this template with a file in version control. If set to `null`, removes GitOps handling from this template. */
11960
12294
  'gitops': {
11961
- /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
11962
- 'repoUrl': string;
11963
12295
  /** The VCS provider to use. Example: "github" */
11964
12296
  'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
11965
12297
  /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
11966
12298
  'selfHostedVcsId'?: string;
11967
12299
  /** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
11968
12300
  'accountLogin'?: string;
12301
+ /** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
12302
+ 'repoUrl': string;
11969
12303
  /** The name of the branch to use. Example: "main" */
11970
12304
  'branch': string;
11971
12305
  /** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
@@ -11999,59 +12333,51 @@ declare class DeleteTemplateEndpoint extends DeleteApiEndpoint<DeleteTemplateReq
11999
12333
  }
12000
12334
 
12001
12335
  declare type RunTemplateResult = {
12002
- /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
12003
- 'id': string;
12004
- /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
12005
- 'createdAt': string;
12006
- /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
12007
- 'updatedAt': string;
12008
- /** Details about the template being run. */
12009
- 'template': {
12010
- /** ID of the template Example: "example-template" */
12336
+ /** Name of the template. Example: "Example Template" */
12337
+ 'name': string;
12338
+ /** Description of the template. Example: "This is a sample template." */
12339
+ 'description'?: string;
12340
+ /** The version of the Northflank API to run the template against. Example: "v1" */
12341
+ 'apiVersion': 'v1';
12342
+ /** Details of the project the template will run in. */
12343
+ 'project': {
12344
+ /** The ID of the project to use. */
12011
12345
  'id': string;
12012
- /** The name of the template Example: "Example Template" */
12013
- 'name': string;
12014
- };
12015
- /** Status of the template run. Example: "success" */
12016
- 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
12017
- /** Details about the template run. */
12018
- 'content': {
12019
- /** Name of the template. Example: "Example Template" */
12020
- 'name': string;
12021
- /** Description of the template. Example: "This is a sample template." */
12022
- 'description'?: string;
12023
- /** The version of the Northflank API to run the template against. Example: "v1" */
12024
- 'apiVersion': 'v1';
12025
- /** Details of the project the template will run in. */
12026
- 'project': {
12027
- /** The ID of the project to use. */
12028
- 'id': string;
12346
+ } | {
12347
+ 'spec': {
12348
+ /** The name of the project. Example: "New Project" */
12349
+ 'name': string;
12350
+ /** The description of the project. Example: "This is a new project." */
12351
+ 'description'?: string;
12352
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
12353
+ 'color'?: string;
12354
+ /** The region the project will be hosted in. Example: "europe-west" */
12355
+ 'region': string;
12029
12356
  } | {
12030
- 'spec': {
12031
- /** The name of the project. Example: "New Project" */
12032
- 'name': string;
12033
- /** The description of the project. Example: "This is a new project." */
12034
- 'description'?: string;
12035
- /** The color of the project in the Northflank App. Example: "#EF233C" */
12036
- 'color'?: string;
12037
- /** The region the project will be hosted in. Example: "europe-west" */
12038
- 'region': string;
12039
- } | {
12040
- /** The name of the project. Example: "New Project" */
12041
- 'name': string;
12042
- /** The description of the project. Example: "This is a new project." */
12043
- 'description'?: string;
12044
- /** The color of the project in the Northflank App. Example: "#EF233C" */
12045
- 'color'?: string;
12046
- /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
12047
- 'clusterId'?: string;
12048
- };
12357
+ /** The name of the project. Example: "New Project" */
12358
+ 'name': string;
12359
+ /** The description of the project. Example: "This is a new project." */
12360
+ 'description'?: string;
12361
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
12362
+ 'color'?: string;
12363
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
12364
+ 'clusterId'?: string;
12049
12365
  };
12050
- /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
12051
- 'arguments'?: any;
12052
- 'refs'?: any;
12053
- 'spec': any;
12054
12366
  };
12367
+ /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
12368
+ 'arguments'?: any;
12369
+ 'spec': any;
12370
+ 'refs'?: any;
12371
+ /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
12372
+ 'id': string;
12373
+ /** Identifier for the template Example: "example-template" */
12374
+ 'templateId': string;
12375
+ /** Status of the template run Example: "pending" */
12376
+ 'status': 'pending' | 'running' | 'success' | 'failure';
12377
+ /** time of creation */
12378
+ 'createdAt'?: string;
12379
+ /** time of update */
12380
+ 'updatedAt'?: string;
12055
12381
  };
12056
12382
  declare type RunTemplateCall = (opts: RunTemplateRequest) => Promise<ApiCallResponse<RunTemplateResult>>;
12057
12383
  declare type RunTemplateRequest = {
@@ -12077,30 +12403,22 @@ declare class RunTemplateEndpoint extends PostApiEndpoint<RunTemplateRequest, Ru
12077
12403
  declare type ListTemplaterunsResult = {
12078
12404
  /** An array of template run objects. */
12079
12405
  'templateRuns': {
12080
- /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
12406
+ /** Name of the template. Example: "Example Template" */
12407
+ 'name': string;
12408
+ /** Description of the template. Example: "This is a sample template." */
12409
+ 'description'?: string;
12410
+ /** The version of the Northflank API to run the template against. Example: "v1" */
12411
+ 'apiVersion': 'v1';
12412
+ /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
12081
12413
  'id': string;
12082
- /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
12083
- 'createdAt': string;
12084
- /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
12085
- 'updatedAt': string;
12086
- /** Details about the template being run. */
12087
- 'template': {
12088
- /** ID of the template Example: "example-template" */
12089
- 'id': string;
12090
- /** The name of the template Example: "Example Template" */
12091
- 'name': string;
12092
- };
12093
- /** Details about the template run. */
12094
- 'content': {
12095
- /** Name of the template. Example: "Example Template" */
12096
- 'name': string;
12097
- /** Description of the template. Example: "This is a sample template." */
12098
- 'description'?: string;
12099
- /** The version of the Northflank API to run the template against. Example: "v1" */
12100
- 'apiVersion': 'v1';
12101
- };
12102
- /** Status of the template run. Example: "success" */
12103
- 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
12414
+ /** Identifier for the template Example: "example-template" */
12415
+ 'templateId': string;
12416
+ /** Status of the template run Example: "pending" */
12417
+ 'status': 'pending' | 'running' | 'success' | 'failure';
12418
+ /** time of creation */
12419
+ 'createdAt'?: string;
12420
+ /** time of update */
12421
+ 'updatedAt'?: string;
12104
12422
  }[];
12105
12423
  };
12106
12424
  declare type ListTemplaterunsCall = (opts: ListTemplaterunsRequest) => Promise<ApiCallResponse<ListTemplaterunsResult>>;
@@ -12129,59 +12447,51 @@ declare class ListTemplaterunsEndpoint extends GetApiEndpoint<ListTemplaterunsRe
12129
12447
  }
12130
12448
 
12131
12449
  declare type GetTemplaterunResult = {
12132
- /** ID of the template run. Example: "501c1e03-a021-4659-9048-85f8f6ee2bc7" */
12133
- 'id': string;
12134
- /** Timestamp of when the run was initiated. Example: "2022-06-14 15:10:42.842Z" */
12135
- 'createdAt': string;
12136
- /** Timestamp of when the run was last updated. Example: "2022-06-14 15:10:42.842Z" */
12137
- 'updatedAt': string;
12138
- /** Details about the template being run. */
12139
- 'template': {
12140
- /** ID of the template Example: "example-template" */
12450
+ /** Name of the template. Example: "Example Template" */
12451
+ 'name': string;
12452
+ /** Description of the template. Example: "This is a sample template." */
12453
+ 'description'?: string;
12454
+ /** The version of the Northflank API to run the template against. Example: "v1" */
12455
+ 'apiVersion': 'v1';
12456
+ /** Details of the project the template will run in. */
12457
+ 'project': {
12458
+ /** The ID of the project to use. */
12141
12459
  'id': string;
12142
- /** The name of the template Example: "Example Template" */
12143
- 'name': string;
12144
- };
12145
- /** Status of the template run. Example: "success" */
12146
- 'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
12147
- /** Details about the template run. */
12148
- 'content': {
12149
- /** Name of the template. Example: "Example Template" */
12150
- 'name': string;
12151
- /** Description of the template. Example: "This is a sample template." */
12152
- 'description'?: string;
12153
- /** The version of the Northflank API to run the template against. Example: "v1" */
12154
- 'apiVersion': 'v1';
12155
- /** Details of the project the template will run in. */
12156
- 'project': {
12157
- /** The ID of the project to use. */
12158
- 'id': string;
12460
+ } | {
12461
+ 'spec': {
12462
+ /** The name of the project. Example: "New Project" */
12463
+ 'name': string;
12464
+ /** The description of the project. Example: "This is a new project." */
12465
+ 'description'?: string;
12466
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
12467
+ 'color'?: string;
12468
+ /** The region the project will be hosted in. Example: "europe-west" */
12469
+ 'region': string;
12159
12470
  } | {
12160
- 'spec': {
12161
- /** The name of the project. Example: "New Project" */
12162
- 'name': string;
12163
- /** The description of the project. Example: "This is a new project." */
12164
- 'description'?: string;
12165
- /** The color of the project in the Northflank App. Example: "#EF233C" */
12166
- 'color'?: string;
12167
- /** The region the project will be hosted in. Example: "europe-west" */
12168
- 'region': string;
12169
- } | {
12170
- /** The name of the project. Example: "New Project" */
12171
- 'name': string;
12172
- /** The description of the project. Example: "This is a new project." */
12173
- 'description'?: string;
12174
- /** The color of the project in the Northflank App. Example: "#EF233C" */
12175
- 'color'?: string;
12176
- /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
12177
- 'clusterId'?: string;
12178
- };
12471
+ /** The name of the project. Example: "New Project" */
12472
+ 'name': string;
12473
+ /** The description of the project. Example: "This is a new project." */
12474
+ 'description'?: string;
12475
+ /** The color of the project in the Northflank App. Example: "#EF233C" */
12476
+ 'color'?: string;
12477
+ /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
12478
+ 'clusterId'?: string;
12179
12479
  };
12180
- /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
12181
- 'arguments'?: any;
12182
- 'refs'?: any;
12183
- 'spec': any;
12184
12480
  };
12481
+ /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
12482
+ 'arguments'?: any;
12483
+ 'spec': any;
12484
+ 'refs'?: any;
12485
+ /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
12486
+ 'id': string;
12487
+ /** Identifier for the template Example: "example-template" */
12488
+ 'templateId': string;
12489
+ /** Status of the template run Example: "pending" */
12490
+ 'status': 'pending' | 'running' | 'success' | 'failure';
12491
+ /** time of creation */
12492
+ 'createdAt'?: string;
12493
+ /** time of update */
12494
+ 'updatedAt'?: string;
12185
12495
  };
12186
12496
  declare type GetTemplaterunCall = (opts: GetTemplaterunRequest) => Promise<ApiCallResponse<GetTemplaterunResult>>;
12187
12497
  declare type GetTemplaterunRequest = {