@pulumi/esc-sdk 0.1.0-beta

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.
@@ -0,0 +1,1058 @@
1
+ /**
2
+ * ESC (Environments, Secrets, Config) API
3
+ * Pulumi ESC allows you to compose and manage hierarchical collections of configuration and secrets and consume them in various ways.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface Access
20
+ */
21
+ export interface Access {
22
+ /**
23
+ *
24
+ * @type {Range}
25
+ * @memberof Access
26
+ */
27
+ 'receiver'?: Range;
28
+ /**
29
+ *
30
+ * @type {Array<Accessor>}
31
+ * @memberof Access
32
+ */
33
+ 'accessors'?: Array<Accessor>;
34
+ }
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface Accessor
39
+ */
40
+ export interface Accessor {
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof Accessor
45
+ */
46
+ 'index'?: number;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof Accessor
51
+ */
52
+ 'key': string;
53
+ /**
54
+ *
55
+ * @type {Range}
56
+ * @memberof Accessor
57
+ */
58
+ 'range': Range;
59
+ }
60
+ /**
61
+ *
62
+ * @export
63
+ * @interface CheckEnvironment
64
+ */
65
+ export interface CheckEnvironment {
66
+ /**
67
+ *
68
+ * @type {{ [key: string]: Expr; }}
69
+ * @memberof CheckEnvironment
70
+ */
71
+ 'exprs'?: {
72
+ [key: string]: Expr;
73
+ };
74
+ /**
75
+ *
76
+ * @type {{ [key: string]: Value; }}
77
+ * @memberof CheckEnvironment
78
+ */
79
+ 'properties'?: {
80
+ [key: string]: Value;
81
+ };
82
+ /**
83
+ *
84
+ * @type {any}
85
+ * @memberof CheckEnvironment
86
+ */
87
+ 'schema'?: any;
88
+ /**
89
+ *
90
+ * @type {EvaluatedExecutionContext}
91
+ * @memberof CheckEnvironment
92
+ */
93
+ 'executionContext'?: EvaluatedExecutionContext;
94
+ /**
95
+ *
96
+ * @type {Array<EnvironmentDiagnostic>}
97
+ * @memberof CheckEnvironment
98
+ */
99
+ 'diagnostics'?: Array<EnvironmentDiagnostic>;
100
+ }
101
+ /**
102
+ *
103
+ * @export
104
+ * @interface Environment
105
+ */
106
+ export interface Environment {
107
+ /**
108
+ *
109
+ * @type {{ [key: string]: Expr; }}
110
+ * @memberof Environment
111
+ */
112
+ 'exprs'?: {
113
+ [key: string]: Expr;
114
+ };
115
+ /**
116
+ *
117
+ * @type {{ [key: string]: Value; }}
118
+ * @memberof Environment
119
+ */
120
+ 'properties'?: {
121
+ [key: string]: Value;
122
+ };
123
+ /**
124
+ *
125
+ * @type {any}
126
+ * @memberof Environment
127
+ */
128
+ 'schema'?: any;
129
+ /**
130
+ *
131
+ * @type {EvaluatedExecutionContext}
132
+ * @memberof Environment
133
+ */
134
+ 'executionContext'?: EvaluatedExecutionContext;
135
+ }
136
+ /**
137
+ *
138
+ * @export
139
+ * @interface EnvironmentDefinition
140
+ */
141
+ export interface EnvironmentDefinition {
142
+ /**
143
+ *
144
+ * @type {Array<string>}
145
+ * @memberof EnvironmentDefinition
146
+ */
147
+ 'imports'?: Array<string>;
148
+ /**
149
+ *
150
+ * @type {EnvironmentDefinitionValues}
151
+ * @memberof EnvironmentDefinition
152
+ */
153
+ 'values'?: EnvironmentDefinitionValues;
154
+ }
155
+ /**
156
+ *
157
+ * @export
158
+ * @interface EnvironmentDefinitionValues
159
+ */
160
+ export interface EnvironmentDefinitionValues {
161
+ [key: string]: object | any;
162
+ /**
163
+ *
164
+ * @type {{ [key: string]: any; }}
165
+ * @memberof EnvironmentDefinitionValues
166
+ */
167
+ 'pulumiConfig'?: {
168
+ [key: string]: any;
169
+ };
170
+ /**
171
+ *
172
+ * @type {{ [key: string]: string; }}
173
+ * @memberof EnvironmentDefinitionValues
174
+ */
175
+ 'environmentVariables'?: {
176
+ [key: string]: string;
177
+ };
178
+ /**
179
+ *
180
+ * @type {{ [key: string]: string; }}
181
+ * @memberof EnvironmentDefinitionValues
182
+ */
183
+ 'files'?: {
184
+ [key: string]: string;
185
+ };
186
+ }
187
+ /**
188
+ *
189
+ * @export
190
+ * @interface EnvironmentDiagnostic
191
+ */
192
+ export interface EnvironmentDiagnostic {
193
+ [key: string]: object | any;
194
+ /**
195
+ *
196
+ * @type {string}
197
+ * @memberof EnvironmentDiagnostic
198
+ */
199
+ 'summary': string;
200
+ /**
201
+ *
202
+ * @type {string}
203
+ * @memberof EnvironmentDiagnostic
204
+ */
205
+ 'path'?: string;
206
+ /**
207
+ *
208
+ * @type {Range}
209
+ * @memberof EnvironmentDiagnostic
210
+ */
211
+ 'range'?: Range;
212
+ }
213
+ /**
214
+ *
215
+ * @export
216
+ * @interface EnvironmentDiagnostics
217
+ */
218
+ export interface EnvironmentDiagnostics {
219
+ /**
220
+ *
221
+ * @type {Array<EnvironmentDiagnostic>}
222
+ * @memberof EnvironmentDiagnostics
223
+ */
224
+ 'diagnostics'?: Array<EnvironmentDiagnostic>;
225
+ }
226
+ /**
227
+ *
228
+ * @export
229
+ * @interface EvaluatedExecutionContext
230
+ */
231
+ export interface EvaluatedExecutionContext {
232
+ /**
233
+ *
234
+ * @type {{ [key: string]: Value; }}
235
+ * @memberof EvaluatedExecutionContext
236
+ */
237
+ 'properties'?: {
238
+ [key: string]: Value;
239
+ };
240
+ /**
241
+ *
242
+ * @type {any}
243
+ * @memberof EvaluatedExecutionContext
244
+ */
245
+ 'schema'?: any;
246
+ }
247
+ /**
248
+ *
249
+ * @export
250
+ * @interface Expr
251
+ */
252
+ export interface Expr {
253
+ /**
254
+ *
255
+ * @type {Range}
256
+ * @memberof Expr
257
+ */
258
+ 'range'?: Range;
259
+ /**
260
+ *
261
+ * @type {Expr}
262
+ * @memberof Expr
263
+ */
264
+ 'base'?: Expr;
265
+ /**
266
+ *
267
+ * @type {any}
268
+ * @memberof Expr
269
+ */
270
+ 'schema'?: any;
271
+ /**
272
+ *
273
+ * @type {{ [key: string]: Range; }}
274
+ * @memberof Expr
275
+ */
276
+ 'keyRanges'?: {
277
+ [key: string]: Range;
278
+ };
279
+ /**
280
+ *
281
+ * @type {any}
282
+ * @memberof Expr
283
+ */
284
+ 'literal'?: any;
285
+ /**
286
+ *
287
+ * @type {Array<Interpolation>}
288
+ * @memberof Expr
289
+ */
290
+ 'interpolate'?: Array<Interpolation>;
291
+ /**
292
+ *
293
+ * @type {Array<PropertyAccessor>}
294
+ * @memberof Expr
295
+ */
296
+ 'symbol'?: Array<PropertyAccessor>;
297
+ /**
298
+ *
299
+ * @type {Array<Access>}
300
+ * @memberof Expr
301
+ */
302
+ 'access'?: Array<Access>;
303
+ /**
304
+ *
305
+ * @type {Array<Expr>}
306
+ * @memberof Expr
307
+ */
308
+ 'list'?: Array<Expr>;
309
+ /**
310
+ *
311
+ * @type {{ [key: string]: Expr; }}
312
+ * @memberof Expr
313
+ */
314
+ 'object'?: {
315
+ [key: string]: Expr;
316
+ };
317
+ /**
318
+ *
319
+ * @type {ExprBuiltin}
320
+ * @memberof Expr
321
+ */
322
+ 'builtin'?: ExprBuiltin;
323
+ }
324
+ /**
325
+ *
326
+ * @export
327
+ * @interface ExprBuiltin
328
+ */
329
+ export interface ExprBuiltin {
330
+ /**
331
+ *
332
+ * @type {string}
333
+ * @memberof ExprBuiltin
334
+ */
335
+ 'name': string;
336
+ /**
337
+ *
338
+ * @type {Range}
339
+ * @memberof ExprBuiltin
340
+ */
341
+ 'nameRange'?: Range;
342
+ /**
343
+ *
344
+ * @type {any}
345
+ * @memberof ExprBuiltin
346
+ */
347
+ 'argSchema'?: any;
348
+ /**
349
+ *
350
+ * @type {Expr}
351
+ * @memberof ExprBuiltin
352
+ */
353
+ 'arg'?: Expr;
354
+ }
355
+ /**
356
+ *
357
+ * @export
358
+ * @interface Interpolation
359
+ */
360
+ export interface Interpolation {
361
+ /**
362
+ *
363
+ * @type {string}
364
+ * @memberof Interpolation
365
+ */
366
+ 'text': string;
367
+ /**
368
+ *
369
+ * @type {Array<PropertyAccessor>}
370
+ * @memberof Interpolation
371
+ */
372
+ 'value'?: Array<PropertyAccessor>;
373
+ }
374
+ /**
375
+ *
376
+ * @export
377
+ * @interface ModelError
378
+ */
379
+ export interface ModelError {
380
+ /**
381
+ *
382
+ * @type {string}
383
+ * @memberof ModelError
384
+ */
385
+ 'message': string;
386
+ /**
387
+ *
388
+ * @type {number}
389
+ * @memberof ModelError
390
+ */
391
+ 'code': number;
392
+ }
393
+ /**
394
+ *
395
+ * @export
396
+ * @interface OpenEnvironment
397
+ */
398
+ export interface OpenEnvironment {
399
+ /**
400
+ * Open environment session identifier
401
+ * @type {string}
402
+ * @memberof OpenEnvironment
403
+ */
404
+ 'id': string;
405
+ /**
406
+ *
407
+ * @type {EnvironmentDiagnostics}
408
+ * @memberof OpenEnvironment
409
+ */
410
+ 'diagnostics'?: EnvironmentDiagnostics;
411
+ }
412
+ /**
413
+ *
414
+ * @export
415
+ * @interface OrgEnvironment
416
+ */
417
+ export interface OrgEnvironment {
418
+ /**
419
+ *
420
+ * @type {string}
421
+ * @memberof OrgEnvironment
422
+ */
423
+ 'organization'?: string;
424
+ /**
425
+ *
426
+ * @type {string}
427
+ * @memberof OrgEnvironment
428
+ */
429
+ 'name': string;
430
+ /**
431
+ *
432
+ * @type {string}
433
+ * @memberof OrgEnvironment
434
+ */
435
+ 'created': string;
436
+ /**
437
+ *
438
+ * @type {string}
439
+ * @memberof OrgEnvironment
440
+ */
441
+ 'modified': string;
442
+ }
443
+ /**
444
+ *
445
+ * @export
446
+ * @interface OrgEnvironments
447
+ */
448
+ export interface OrgEnvironments {
449
+ /**
450
+ *
451
+ * @type {Array<OrgEnvironment>}
452
+ * @memberof OrgEnvironments
453
+ */
454
+ 'environments'?: Array<OrgEnvironment>;
455
+ /**
456
+ *
457
+ * @type {string}
458
+ * @memberof OrgEnvironments
459
+ */
460
+ 'nextToken'?: string;
461
+ }
462
+ /**
463
+ *
464
+ * @export
465
+ * @interface Pos
466
+ */
467
+ export interface Pos {
468
+ /**
469
+ * Line is the source code line where this position points. Lines are counted starting at 1 and incremented for each newline character encountered.
470
+ * @type {number}
471
+ * @memberof Pos
472
+ */
473
+ 'line': number;
474
+ /**
475
+ * Column is the source code column where this position points. Columns are counted in visual cells starting at 1, and are incremented roughly per grapheme cluster encountered.
476
+ * @type {number}
477
+ * @memberof Pos
478
+ */
479
+ 'column': number;
480
+ /**
481
+ * Byte is the byte offset into the file where the indicated position begins.
482
+ * @type {number}
483
+ * @memberof Pos
484
+ */
485
+ 'byte': number;
486
+ }
487
+ /**
488
+ *
489
+ * @export
490
+ * @interface PropertyAccessor
491
+ */
492
+ export interface PropertyAccessor {
493
+ /**
494
+ *
495
+ * @type {number}
496
+ * @memberof PropertyAccessor
497
+ */
498
+ 'index'?: number;
499
+ /**
500
+ *
501
+ * @type {string}
502
+ * @memberof PropertyAccessor
503
+ */
504
+ 'key': string;
505
+ /**
506
+ *
507
+ * @type {Range}
508
+ * @memberof PropertyAccessor
509
+ */
510
+ 'range': Range;
511
+ /**
512
+ *
513
+ * @type {Range}
514
+ * @memberof PropertyAccessor
515
+ */
516
+ 'value'?: Range;
517
+ }
518
+ /**
519
+ *
520
+ * @export
521
+ * @interface Range
522
+ */
523
+ export interface Range {
524
+ /**
525
+ *
526
+ * @type {string}
527
+ * @memberof Range
528
+ */
529
+ 'environment': string;
530
+ /**
531
+ *
532
+ * @type {Pos}
533
+ * @memberof Range
534
+ */
535
+ 'begin': Pos;
536
+ /**
537
+ *
538
+ * @type {Pos}
539
+ * @memberof Range
540
+ */
541
+ 'end': Pos;
542
+ }
543
+ /**
544
+ *
545
+ * @export
546
+ * @interface Reference
547
+ */
548
+ export interface Reference {
549
+ /**
550
+ *
551
+ * @type {string}
552
+ * @memberof Reference
553
+ */
554
+ '$ref': string;
555
+ }
556
+ /**
557
+ *
558
+ * @export
559
+ * @interface Trace
560
+ */
561
+ export interface Trace {
562
+ /**
563
+ *
564
+ * @type {Range}
565
+ * @memberof Trace
566
+ */
567
+ 'def'?: Range;
568
+ /**
569
+ *
570
+ * @type {Value}
571
+ * @memberof Trace
572
+ */
573
+ 'base'?: Value;
574
+ }
575
+ /**
576
+ *
577
+ * @export
578
+ * @interface Value
579
+ */
580
+ export interface Value {
581
+ /**
582
+ *
583
+ * @type {any}
584
+ * @memberof Value
585
+ */
586
+ 'value': any;
587
+ /**
588
+ *
589
+ * @type {boolean}
590
+ * @memberof Value
591
+ */
592
+ 'secret'?: boolean;
593
+ /**
594
+ *
595
+ * @type {boolean}
596
+ * @memberof Value
597
+ */
598
+ 'unknown'?: boolean;
599
+ /**
600
+ *
601
+ * @type {Trace}
602
+ * @memberof Value
603
+ */
604
+ 'trace': Trace;
605
+ }
606
+ /**
607
+ * EscApi - axios parameter creator
608
+ * @export
609
+ */
610
+ export declare const EscApiAxiosParamCreator: (configuration?: Configuration) => {
611
+ /**
612
+ * Checks an environment definition for errors
613
+ * @summary Checks an environment definition for errors
614
+ * @param {string} orgName Organization name
615
+ * @param {string} body Environment Yaml content
616
+ * @param {*} [options] Override http request option.
617
+ * @throws {RequiredError}
618
+ */
619
+ checkEnvironmentYaml: (orgName: string, body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
620
+ /**
621
+ * Creates an environment in the given org with the given name.
622
+ * @summary Create a new environment
623
+ * @param {string} orgName Organization name
624
+ * @param {string} envName Environment name
625
+ * @param {*} [options] Override http request option.
626
+ * @throws {RequiredError}
627
+ */
628
+ createEnvironment: (orgName: string, envName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
629
+ /**
630
+ * Reads the definition for the given environment with static secrets in plaintext
631
+ * @summary Reads the definition for the given environment with static secrets in plaintext
632
+ * @param {string} orgName Organization name
633
+ * @param {string} envName Environment name
634
+ * @param {*} [options] Override http request option.
635
+ * @throws {RequiredError}
636
+ */
637
+ decryptEnvironment: (orgName: string, envName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
638
+ /**
639
+ * Delete an environment
640
+ * @summary Delete an environment
641
+ * @param {string} orgName Organization name
642
+ * @param {string} envName Environment name
643
+ * @param {*} [options] Override http request option.
644
+ * @throws {RequiredError}
645
+ */
646
+ deleteEnvironment: (orgName: string, envName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
647
+ /**
648
+ * Read an environment
649
+ * @summary Read an environment
650
+ * @param {string} orgName Organization name
651
+ * @param {string} envName Environment name
652
+ * @param {*} [options] Override http request option.
653
+ * @throws {RequiredError}
654
+ */
655
+ getEnvironment: (orgName: string, envName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
656
+ /**
657
+ * Returns the ETag for the given environment if it exists.
658
+ * @summary Return an Environment ETag
659
+ * @param {string} orgName Organization name
660
+ * @param {string} envName Environment name
661
+ * @param {*} [options] Override http request option.
662
+ * @throws {RequiredError}
663
+ */
664
+ getEnvironmentETag: (orgName: string, envName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
665
+ /**
666
+ * List environments in the organization available to the current user
667
+ * @summary List environments in the organization
668
+ * @param {string} orgName Organization name
669
+ * @param {string} [continuationToken] continuation Token from previous query to fetch next page of results
670
+ * @param {*} [options] Override http request option.
671
+ * @throws {RequiredError}
672
+ */
673
+ listEnvironments: (orgName: string, continuationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
674
+ /**
675
+ * Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.
676
+ * @summary Open an environment session
677
+ * @param {string} orgName Organization name
678
+ * @param {string} envName Environment name
679
+ * @param {string} [duration] open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.
680
+ * @param {*} [options] Override http request option.
681
+ * @throws {RequiredError}
682
+ */
683
+ openEnvironment: (orgName: string, envName: string, duration?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
684
+ /**
685
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
686
+ * @summary Read an open environment
687
+ * @param {string} orgName Organization name
688
+ * @param {string} envName Environment name
689
+ * @param {string} openSessionID Open session ID returned from environment open
690
+ * @param {*} [options] Override http request option.
691
+ * @throws {RequiredError}
692
+ */
693
+ readOpenEnvironment: (orgName: string, envName: string, openSessionID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
694
+ /**
695
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
696
+ * @summary Read an open environment
697
+ * @param {string} orgName Organization name
698
+ * @param {string} envName Environment name
699
+ * @param {string} openSessionID Open session ID returned from environment open
700
+ * @param {string} property Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
701
+ * @param {*} [options] Override http request option.
702
+ * @throws {RequiredError}
703
+ */
704
+ readOpenEnvironmentProperty: (orgName: string, envName: string, openSessionID: string, property: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
705
+ /**
706
+ * Validates and updates the given environment\'s definition.
707
+ * @summary Update an existing environment with Yaml file
708
+ * @param {string} orgName Organization name
709
+ * @param {string} envName Environment name
710
+ * @param {string} body Environment Yaml content
711
+ * @param {*} [options] Override http request option.
712
+ * @throws {RequiredError}
713
+ */
714
+ updateEnvironmentYaml: (orgName: string, envName: string, body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
715
+ };
716
+ /**
717
+ * EscApi - functional programming interface
718
+ * @export
719
+ */
720
+ export declare const EscApiFp: (configuration?: Configuration) => {
721
+ /**
722
+ * Checks an environment definition for errors
723
+ * @summary Checks an environment definition for errors
724
+ * @param {string} orgName Organization name
725
+ * @param {string} body Environment Yaml content
726
+ * @param {*} [options] Override http request option.
727
+ * @throws {RequiredError}
728
+ */
729
+ checkEnvironmentYaml(orgName: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckEnvironment>>;
730
+ /**
731
+ * Creates an environment in the given org with the given name.
732
+ * @summary Create a new environment
733
+ * @param {string} orgName Organization name
734
+ * @param {string} envName Environment name
735
+ * @param {*} [options] Override http request option.
736
+ * @throws {RequiredError}
737
+ */
738
+ createEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>>;
739
+ /**
740
+ * Reads the definition for the given environment with static secrets in plaintext
741
+ * @summary Reads the definition for the given environment with static secrets in plaintext
742
+ * @param {string} orgName Organization name
743
+ * @param {string} envName Environment name
744
+ * @param {*} [options] Override http request option.
745
+ * @throws {RequiredError}
746
+ */
747
+ decryptEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnvironmentDefinition>>;
748
+ /**
749
+ * Delete an environment
750
+ * @summary Delete an environment
751
+ * @param {string} orgName Organization name
752
+ * @param {string} envName Environment name
753
+ * @param {*} [options] Override http request option.
754
+ * @throws {RequiredError}
755
+ */
756
+ deleteEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>>;
757
+ /**
758
+ * Read an environment
759
+ * @summary Read an environment
760
+ * @param {string} orgName Organization name
761
+ * @param {string} envName Environment name
762
+ * @param {*} [options] Override http request option.
763
+ * @throws {RequiredError}
764
+ */
765
+ getEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnvironmentDefinition>>;
766
+ /**
767
+ * Returns the ETag for the given environment if it exists.
768
+ * @summary Return an Environment ETag
769
+ * @param {string} orgName Organization name
770
+ * @param {string} envName Environment name
771
+ * @param {*} [options] Override http request option.
772
+ * @throws {RequiredError}
773
+ */
774
+ getEnvironmentETag(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
775
+ /**
776
+ * List environments in the organization available to the current user
777
+ * @summary List environments in the organization
778
+ * @param {string} orgName Organization name
779
+ * @param {string} [continuationToken] continuation Token from previous query to fetch next page of results
780
+ * @param {*} [options] Override http request option.
781
+ * @throws {RequiredError}
782
+ */
783
+ listEnvironments(orgName: string, continuationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgEnvironments>>;
784
+ /**
785
+ * Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.
786
+ * @summary Open an environment session
787
+ * @param {string} orgName Organization name
788
+ * @param {string} envName Environment name
789
+ * @param {string} [duration] open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.
790
+ * @param {*} [options] Override http request option.
791
+ * @throws {RequiredError}
792
+ */
793
+ openEnvironment(orgName: string, envName: string, duration?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpenEnvironment>>;
794
+ /**
795
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
796
+ * @summary Read an open environment
797
+ * @param {string} orgName Organization name
798
+ * @param {string} envName Environment name
799
+ * @param {string} openSessionID Open session ID returned from environment open
800
+ * @param {*} [options] Override http request option.
801
+ * @throws {RequiredError}
802
+ */
803
+ readOpenEnvironment(orgName: string, envName: string, openSessionID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Environment>>;
804
+ /**
805
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
806
+ * @summary Read an open environment
807
+ * @param {string} orgName Organization name
808
+ * @param {string} envName Environment name
809
+ * @param {string} openSessionID Open session ID returned from environment open
810
+ * @param {string} property Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
811
+ * @param {*} [options] Override http request option.
812
+ * @throws {RequiredError}
813
+ */
814
+ readOpenEnvironmentProperty(orgName: string, envName: string, openSessionID: string, property: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Value>>;
815
+ /**
816
+ * Validates and updates the given environment\'s definition.
817
+ * @summary Update an existing environment with Yaml file
818
+ * @param {string} orgName Organization name
819
+ * @param {string} envName Environment name
820
+ * @param {string} body Environment Yaml content
821
+ * @param {*} [options] Override http request option.
822
+ * @throws {RequiredError}
823
+ */
824
+ updateEnvironmentYaml(orgName: string, envName: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnvironmentDiagnostics>>;
825
+ };
826
+ /**
827
+ * EscApi - factory interface
828
+ * @export
829
+ */
830
+ export declare const EscApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
831
+ /**
832
+ * Checks an environment definition for errors
833
+ * @summary Checks an environment definition for errors
834
+ * @param {string} orgName Organization name
835
+ * @param {string} body Environment Yaml content
836
+ * @param {*} [options] Override http request option.
837
+ * @throws {RequiredError}
838
+ */
839
+ checkEnvironmentYaml(orgName: string, body: string, options?: any): AxiosPromise<CheckEnvironment>;
840
+ /**
841
+ * Creates an environment in the given org with the given name.
842
+ * @summary Create a new environment
843
+ * @param {string} orgName Organization name
844
+ * @param {string} envName Environment name
845
+ * @param {*} [options] Override http request option.
846
+ * @throws {RequiredError}
847
+ */
848
+ createEnvironment(orgName: string, envName: string, options?: any): AxiosPromise<Error>;
849
+ /**
850
+ * Reads the definition for the given environment with static secrets in plaintext
851
+ * @summary Reads the definition for the given environment with static secrets in plaintext
852
+ * @param {string} orgName Organization name
853
+ * @param {string} envName Environment name
854
+ * @param {*} [options] Override http request option.
855
+ * @throws {RequiredError}
856
+ */
857
+ decryptEnvironment(orgName: string, envName: string, options?: any): AxiosPromise<EnvironmentDefinition>;
858
+ /**
859
+ * Delete an environment
860
+ * @summary Delete an environment
861
+ * @param {string} orgName Organization name
862
+ * @param {string} envName Environment name
863
+ * @param {*} [options] Override http request option.
864
+ * @throws {RequiredError}
865
+ */
866
+ deleteEnvironment(orgName: string, envName: string, options?: any): AxiosPromise<Error>;
867
+ /**
868
+ * Read an environment
869
+ * @summary Read an environment
870
+ * @param {string} orgName Organization name
871
+ * @param {string} envName Environment name
872
+ * @param {*} [options] Override http request option.
873
+ * @throws {RequiredError}
874
+ */
875
+ getEnvironment(orgName: string, envName: string, options?: any): AxiosPromise<EnvironmentDefinition>;
876
+ /**
877
+ * Returns the ETag for the given environment if it exists.
878
+ * @summary Return an Environment ETag
879
+ * @param {string} orgName Organization name
880
+ * @param {string} envName Environment name
881
+ * @param {*} [options] Override http request option.
882
+ * @throws {RequiredError}
883
+ */
884
+ getEnvironmentETag(orgName: string, envName: string, options?: any): AxiosPromise<void>;
885
+ /**
886
+ * List environments in the organization available to the current user
887
+ * @summary List environments in the organization
888
+ * @param {string} orgName Organization name
889
+ * @param {string} [continuationToken] continuation Token from previous query to fetch next page of results
890
+ * @param {*} [options] Override http request option.
891
+ * @throws {RequiredError}
892
+ */
893
+ listEnvironments(orgName: string, continuationToken?: string, options?: any): AxiosPromise<OrgEnvironments>;
894
+ /**
895
+ * Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.
896
+ * @summary Open an environment session
897
+ * @param {string} orgName Organization name
898
+ * @param {string} envName Environment name
899
+ * @param {string} [duration] open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.
900
+ * @param {*} [options] Override http request option.
901
+ * @throws {RequiredError}
902
+ */
903
+ openEnvironment(orgName: string, envName: string, duration?: string, options?: any): AxiosPromise<OpenEnvironment>;
904
+ /**
905
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
906
+ * @summary Read an open environment
907
+ * @param {string} orgName Organization name
908
+ * @param {string} envName Environment name
909
+ * @param {string} openSessionID Open session ID returned from environment open
910
+ * @param {*} [options] Override http request option.
911
+ * @throws {RequiredError}
912
+ */
913
+ readOpenEnvironment(orgName: string, envName: string, openSessionID: string, options?: any): AxiosPromise<Environment>;
914
+ /**
915
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
916
+ * @summary Read an open environment
917
+ * @param {string} orgName Organization name
918
+ * @param {string} envName Environment name
919
+ * @param {string} openSessionID Open session ID returned from environment open
920
+ * @param {string} property Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
921
+ * @param {*} [options] Override http request option.
922
+ * @throws {RequiredError}
923
+ */
924
+ readOpenEnvironmentProperty(orgName: string, envName: string, openSessionID: string, property: string, options?: any): AxiosPromise<Value>;
925
+ /**
926
+ * Validates and updates the given environment\'s definition.
927
+ * @summary Update an existing environment with Yaml file
928
+ * @param {string} orgName Organization name
929
+ * @param {string} envName Environment name
930
+ * @param {string} body Environment Yaml content
931
+ * @param {*} [options] Override http request option.
932
+ * @throws {RequiredError}
933
+ */
934
+ updateEnvironmentYaml(orgName: string, envName: string, body: string, options?: any): AxiosPromise<EnvironmentDiagnostics>;
935
+ };
936
+ /**
937
+ * EscApi - object-oriented interface
938
+ * @export
939
+ * @class EscApi
940
+ * @extends {BaseAPI}
941
+ */
942
+ export declare class EscApi extends BaseAPI {
943
+ /**
944
+ * Checks an environment definition for errors
945
+ * @summary Checks an environment definition for errors
946
+ * @param {string} orgName Organization name
947
+ * @param {string} body Environment Yaml content
948
+ * @param {*} [options] Override http request option.
949
+ * @throws {RequiredError}
950
+ * @memberof EscApi
951
+ */
952
+ checkEnvironmentYaml(orgName: string, body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckEnvironment, any>>;
953
+ /**
954
+ * Creates an environment in the given org with the given name.
955
+ * @summary Create a new environment
956
+ * @param {string} orgName Organization name
957
+ * @param {string} envName Environment name
958
+ * @param {*} [options] Override http request option.
959
+ * @throws {RequiredError}
960
+ * @memberof EscApi
961
+ */
962
+ createEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Error, any>>;
963
+ /**
964
+ * Reads the definition for the given environment with static secrets in plaintext
965
+ * @summary Reads the definition for the given environment with static secrets in plaintext
966
+ * @param {string} orgName Organization name
967
+ * @param {string} envName Environment name
968
+ * @param {*} [options] Override http request option.
969
+ * @throws {RequiredError}
970
+ * @memberof EscApi
971
+ */
972
+ decryptEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EnvironmentDefinition, any>>;
973
+ /**
974
+ * Delete an environment
975
+ * @summary Delete an environment
976
+ * @param {string} orgName Organization name
977
+ * @param {string} envName Environment name
978
+ * @param {*} [options] Override http request option.
979
+ * @throws {RequiredError}
980
+ * @memberof EscApi
981
+ */
982
+ deleteEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Error, any>>;
983
+ /**
984
+ * Read an environment
985
+ * @summary Read an environment
986
+ * @param {string} orgName Organization name
987
+ * @param {string} envName Environment name
988
+ * @param {*} [options] Override http request option.
989
+ * @throws {RequiredError}
990
+ * @memberof EscApi
991
+ */
992
+ getEnvironment(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EnvironmentDefinition, any>>;
993
+ /**
994
+ * Returns the ETag for the given environment if it exists.
995
+ * @summary Return an Environment ETag
996
+ * @param {string} orgName Organization name
997
+ * @param {string} envName Environment name
998
+ * @param {*} [options] Override http request option.
999
+ * @throws {RequiredError}
1000
+ * @memberof EscApi
1001
+ */
1002
+ getEnvironmentETag(orgName: string, envName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1003
+ /**
1004
+ * List environments in the organization available to the current user
1005
+ * @summary List environments in the organization
1006
+ * @param {string} orgName Organization name
1007
+ * @param {string} [continuationToken] continuation Token from previous query to fetch next page of results
1008
+ * @param {*} [options] Override http request option.
1009
+ * @throws {RequiredError}
1010
+ * @memberof EscApi
1011
+ */
1012
+ listEnvironments(orgName: string, continuationToken?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgEnvironments, any>>;
1013
+ /**
1014
+ * Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.
1015
+ * @summary Open an environment session
1016
+ * @param {string} orgName Organization name
1017
+ * @param {string} envName Environment name
1018
+ * @param {string} [duration] open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.
1019
+ * @param {*} [options] Override http request option.
1020
+ * @throws {RequiredError}
1021
+ * @memberof EscApi
1022
+ */
1023
+ openEnvironment(orgName: string, envName: string, duration?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OpenEnvironment, any>>;
1024
+ /**
1025
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
1026
+ * @summary Read an open environment
1027
+ * @param {string} orgName Organization name
1028
+ * @param {string} envName Environment name
1029
+ * @param {string} openSessionID Open session ID returned from environment open
1030
+ * @param {*} [options] Override http request option.
1031
+ * @throws {RequiredError}
1032
+ * @memberof EscApi
1033
+ */
1034
+ readOpenEnvironment(orgName: string, envName: string, openSessionID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Environment, any>>;
1035
+ /**
1036
+ * Reads and decrypts secrets including retrieving dynamic secrets from providers.
1037
+ * @summary Read an open environment
1038
+ * @param {string} orgName Organization name
1039
+ * @param {string} envName Environment name
1040
+ * @param {string} openSessionID Open session ID returned from environment open
1041
+ * @param {string} property Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
1042
+ * @param {*} [options] Override http request option.
1043
+ * @throws {RequiredError}
1044
+ * @memberof EscApi
1045
+ */
1046
+ readOpenEnvironmentProperty(orgName: string, envName: string, openSessionID: string, property: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Value, any>>;
1047
+ /**
1048
+ * Validates and updates the given environment\'s definition.
1049
+ * @summary Update an existing environment with Yaml file
1050
+ * @param {string} orgName Organization name
1051
+ * @param {string} envName Environment name
1052
+ * @param {string} body Environment Yaml content
1053
+ * @param {*} [options] Override http request option.
1054
+ * @throws {RequiredError}
1055
+ * @memberof EscApi
1056
+ */
1057
+ updateEnvironmentYaml(orgName: string, envName: string, body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EnvironmentDiagnostics, any>>;
1058
+ }