@pulumi/esc-sdk 0.9.2 → 0.10.1
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.
- package/esc/index.d.ts +94 -20
- package/esc/index.js +173 -41
- package/esc/index.js.map +1 -1
- package/esc/raw/api.d.ts +551 -80
- package/esc/raw/api.js +738 -161
- package/esc/raw/api.js.map +1 -1
- package/esc/raw/base.js +1 -1
- package/esc/raw/base.js.map +1 -1
- package/package.json +1 -1
- package/test/client.spec.js +45 -27
- package/test/client.spec.js.map +1 -1
package/esc/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Environment, EnvironmentDefinitionValues, OpenEnvironment, OrgEnvironments, OrgEnvironment, EnvironmentDefinition, EscApi as EscRawApi, Configuration, Value, EnvironmentDiagnostics, CheckEnvironment, Pos, Range, Trace, EnvironmentRevision, EnvironmentRevisionTag, EnvironmentRevisionTags } from "./raw/index";
|
|
1
|
+
import { Environment, EnvironmentDefinitionValues, OpenEnvironment, OrgEnvironments, OrgEnvironment, EnvironmentDefinition, EscApi as EscRawApi, Configuration, Value, EnvironmentDiagnostics, CheckEnvironment, Pos, Range, Trace, EnvironmentRevision, EnvironmentRevisionTag, EnvironmentRevisionTags, EnvironmentTag, ListEnvironmentTags } from "./raw/index";
|
|
2
2
|
export { Configuration, Environment, EnvironmentDefinitionValues, OpenEnvironment, OrgEnvironments, OrgEnvironment, EnvironmentDefinition, EscRawApi, Value, EnvironmentDiagnostics, CheckEnvironment, Pos, Range, Trace, EnvironmentRevision, EnvironmentRevisionTag, EnvironmentRevisionTags, };
|
|
3
3
|
export interface EnvironmentDefinitionResponse {
|
|
4
4
|
definition: EnvironmentDefinition;
|
|
@@ -35,110 +35,122 @@ export declare class EscApi {
|
|
|
35
35
|
* getEnvironment gets the definition of an environment.
|
|
36
36
|
* @summary Get environment
|
|
37
37
|
* @param {string} orgName Organization name
|
|
38
|
+
* @param {string} projectName Project name
|
|
38
39
|
* @param {string} envName Environment name
|
|
39
40
|
* @returns {Promise<EnvironmentDefinitionResponse | undefined>} The environment definition and the YAML representation
|
|
40
41
|
*/
|
|
41
|
-
getEnvironment(orgName: string, envName: string): Promise<EnvironmentDefinitionResponse | undefined>;
|
|
42
|
+
getEnvironment(orgName: string, projectName: string, envName: string): Promise<EnvironmentDefinitionResponse | undefined>;
|
|
42
43
|
/**
|
|
43
44
|
* getEnvironmentAtVersion gets the definition of an environment at a specific version.
|
|
44
45
|
* @summary Get environment at version
|
|
45
46
|
* @param {string} orgName Organization name
|
|
47
|
+
* @param {string} projectName Project name
|
|
46
48
|
* @param {string} envName Environment name
|
|
47
49
|
* @param {string} version Version of the environment
|
|
48
50
|
* @returns {Promise<EnvironmentDefinitionResponse | undefined>} The environment definition and the YAML representation
|
|
49
51
|
*/
|
|
50
|
-
getEnvironmentAtVersion(orgName: string, envName: string, version: string): Promise<EnvironmentDefinitionResponse | undefined>;
|
|
52
|
+
getEnvironmentAtVersion(orgName: string, projectName: string, envName: string, version: string): Promise<EnvironmentDefinitionResponse | undefined>;
|
|
51
53
|
/**
|
|
52
54
|
* openEnvironment opens an environment session
|
|
53
55
|
* @summary Open environment
|
|
54
56
|
* @param {string} orgName Organization name
|
|
57
|
+
* @param {string} projectName Project name
|
|
55
58
|
* @param {string} envName Environment name
|
|
56
59
|
* @returns {Promise<OpenEnvironment | undefined>} The open environment session information
|
|
57
60
|
*/
|
|
58
|
-
openEnvironment(orgName: string, envName: string): Promise<OpenEnvironment | undefined>;
|
|
61
|
+
openEnvironment(orgName: string, projectName: string, envName: string): Promise<OpenEnvironment | undefined>;
|
|
59
62
|
/**
|
|
60
63
|
* openEnvironmentAtVersion opens an environment session at a specific version
|
|
61
64
|
* @summary Open environment at version
|
|
62
65
|
* @param {string} orgName Organization name
|
|
66
|
+
* @param {string} projectName Project name
|
|
63
67
|
* @param {string} envName Environment name
|
|
64
68
|
* @param {string} version Version of the environment
|
|
65
69
|
* @returns {Promise<OpenEnvironment | undefined>} The open environment session information
|
|
66
70
|
*/
|
|
67
|
-
openEnvironmentAtVersion(orgName: string, envName: string, version: string): Promise<OpenEnvironment | undefined>;
|
|
71
|
+
openEnvironmentAtVersion(orgName: string, projectName: string, envName: string, version: string): Promise<OpenEnvironment | undefined>;
|
|
68
72
|
/**
|
|
69
73
|
* readOpenEnvironment reads the environment properties in an open session,
|
|
70
74
|
* resolving configuration variables and secrets.
|
|
71
75
|
* @summary Read environment
|
|
72
76
|
* @param {string} orgName Organization name
|
|
77
|
+
* @param {string} projectName Project name
|
|
73
78
|
* @param {string} envName Environment name
|
|
74
79
|
* @param {string} openSessionID Open session ID
|
|
75
80
|
* @returns {Promise<EnvironmentResponse | undefined>} The environment and its values
|
|
76
81
|
*/
|
|
77
|
-
readOpenEnvironment(orgName: string, envName: string, openSessionID: string): Promise<EnvironmentResponse | undefined>;
|
|
82
|
+
readOpenEnvironment(orgName: string, projectName: string, envName: string, openSessionID: string): Promise<EnvironmentResponse | undefined>;
|
|
78
83
|
/**
|
|
79
84
|
* openAndReadEnvironment opens an environment session and reads the environment properties,
|
|
80
85
|
* resolving configuration variables and secrets.
|
|
81
86
|
* @summary Open and read environment
|
|
82
87
|
* @param {string} orgName Organization name
|
|
88
|
+
* @param {string} projectName Project name
|
|
83
89
|
* @param {string} envName Environment name
|
|
84
90
|
* @returns {Promise<EnvironmentResponse | undefined>} The environment and its values
|
|
85
91
|
*/
|
|
86
|
-
openAndReadEnvironment(orgName: string, envName: string): Promise<EnvironmentResponse | undefined>;
|
|
92
|
+
openAndReadEnvironment(orgName: string, projectName: string, envName: string): Promise<EnvironmentResponse | undefined>;
|
|
87
93
|
/**
|
|
88
94
|
* openAndReadEnvironmentAtVersion opens an environment session at a specific version and reads the environment properties,
|
|
89
95
|
* resolving configuration variables and secrets.
|
|
90
96
|
* @summary Open and read environment at version
|
|
91
97
|
* @param {string} orgName Organization name
|
|
98
|
+
* @param {string} projectName Project name
|
|
92
99
|
* @param {string} envName Environment name
|
|
93
100
|
* @param {string} version Version of the environment
|
|
94
101
|
* @returns {Promise<EnvironmentResponse | undefined>} The environment and its values
|
|
95
102
|
*/
|
|
96
|
-
openAndReadEnvironmentAtVersion(orgName: string, envName: string, version: string): Promise<EnvironmentResponse | undefined>;
|
|
103
|
+
openAndReadEnvironmentAtVersion(orgName: string, projectName: string, envName: string, version: string): Promise<EnvironmentResponse | undefined>;
|
|
97
104
|
/**
|
|
98
105
|
* readOpenEnvironmentProperty reads a specific environment property in an open session,
|
|
99
106
|
* resolving configuration variables and secrets.
|
|
100
107
|
* @summary Read environment property
|
|
101
108
|
* @param {string} orgName Organization name
|
|
109
|
+
* @param {string} projectName Project name
|
|
102
110
|
* @param {string} envName Environment name
|
|
103
111
|
* @param {string} openSessionID Open session ID
|
|
104
112
|
* @param {string} property Property name
|
|
105
113
|
* @returns {Promise<EnvironmentPropertyResponse | undefined>} The environment property and its value
|
|
106
114
|
*/
|
|
107
|
-
readOpenEnvironmentProperty(orgName: string, envName: string, openSessionID: string, property: string): Promise<EnvironmentPropertyResponse | undefined>;
|
|
115
|
+
readOpenEnvironmentProperty(orgName: string, projectName: string, envName: string, openSessionID: string, property: string): Promise<EnvironmentPropertyResponse | undefined>;
|
|
108
116
|
/**
|
|
109
117
|
* createEnvironment creates a new environment.
|
|
110
118
|
* @summary Create environment
|
|
111
119
|
* @param {string} orgName Organization name
|
|
120
|
+
* @param {string} projectName Project name
|
|
112
121
|
* @param {string} envName Environment name
|
|
113
122
|
* @returns {Promise<void>} A promise that resolves when the environment is created
|
|
114
123
|
*/
|
|
115
|
-
createEnvironment(orgName: string, envName: string): Promise<void>;
|
|
124
|
+
createEnvironment(orgName: string, projectName: string, envName: string): Promise<void>;
|
|
116
125
|
/**
|
|
117
126
|
* updateEnvironmentYaml updates the environment definition from a YAML string.
|
|
118
127
|
* @summary Update environment YAML
|
|
119
128
|
* @param {string} orgName Organization name
|
|
129
|
+
* @param {string} projectName Project name
|
|
120
130
|
* @param {string} envName Environment name
|
|
121
131
|
* @param {string} yaml YAML representation of the environment
|
|
122
132
|
* @returns {Promise<EnvironmentDiagnostics | undefined>} The environment diagnostics
|
|
123
133
|
*/
|
|
124
|
-
updateEnvironmentYaml(orgName: string, envName: string, yaml: string): Promise<EnvironmentDiagnostics | undefined>;
|
|
134
|
+
updateEnvironmentYaml(orgName: string, projectName: string, envName: string, yaml: string): Promise<EnvironmentDiagnostics | undefined>;
|
|
125
135
|
/**
|
|
126
136
|
* updateEnvironment updates the environment definition.
|
|
127
137
|
* @summary Update environment
|
|
128
138
|
* @param {string} orgName Organization name
|
|
139
|
+
* @param {string} projectName Project name
|
|
129
140
|
* @param {string} envName Environment name
|
|
130
141
|
* @param {EnvironmentDefinition} values The environment definition
|
|
131
142
|
* @returns {Promise<EnvironmentDiagnostics | undefined>} The environment diagnostics
|
|
132
143
|
*/
|
|
133
|
-
updateEnvironment(orgName: string, envName: string, values: EnvironmentDefinition): Promise<EnvironmentDiagnostics | undefined>;
|
|
144
|
+
updateEnvironment(orgName: string, projectName: string, envName: string, values: EnvironmentDefinition): Promise<EnvironmentDiagnostics | undefined>;
|
|
134
145
|
/**
|
|
135
146
|
* deleteEnvironment deletes an environment.
|
|
136
147
|
* @summary Delete environment
|
|
137
148
|
* @param {string} orgName Organization name
|
|
149
|
+
* @param {string} projectName Project name
|
|
138
150
|
* @param {string} envName Environment name
|
|
139
151
|
* @returns {Promise<void>} A promise that resolves when the environment is deleted
|
|
140
152
|
*/
|
|
141
|
-
deleteEnvironment(orgName: string, envName: string): Promise<void>;
|
|
153
|
+
deleteEnvironment(orgName: string, projectName: string, envName: string): Promise<void>;
|
|
142
154
|
/**
|
|
143
155
|
* checkEnvironmentYaml checks the environment definition from a YAML string.
|
|
144
156
|
* @summary Check environment YAML
|
|
@@ -159,66 +171,128 @@ export declare class EscApi {
|
|
|
159
171
|
* decryptEnvironment decrypts the environment definition.
|
|
160
172
|
* @summary Decrypt environment
|
|
161
173
|
* @param {string} orgName Organization name
|
|
174
|
+
* @param {string} projectName Project name
|
|
162
175
|
* @param {string} envName Environment name
|
|
163
176
|
* @returns {Promise<EnvironmentDefinitionResponse | undefined>} The decrypted environment definition and the YAML representation
|
|
164
177
|
*/
|
|
165
|
-
decryptEnvironment(orgName: string, envName: string): Promise<EnvironmentDefinitionResponse | undefined>;
|
|
178
|
+
decryptEnvironment(orgName: string, projectName: string, envName: string): Promise<EnvironmentDefinitionResponse | undefined>;
|
|
166
179
|
/**
|
|
167
180
|
* listEnvironmentRevisions lists the environment revisions, from oldest to newest.
|
|
168
181
|
* @summary List environment revisions
|
|
169
182
|
* @param {string} orgName Organization name
|
|
183
|
+
* @param {string} projectName Project name
|
|
170
184
|
* @param {string} envName Environment name
|
|
171
185
|
* @param {number} before The revision number to start listing from
|
|
172
186
|
* @param {number} count The number of revisions to list
|
|
173
187
|
* @returns {Promise<Array<EnvironmentRevision> | undefined>} A list of environment revisions
|
|
174
188
|
*/
|
|
175
|
-
listEnvironmentRevisions(orgName: string, envName: string, before?: number, count?: number): Promise<Array<EnvironmentRevision> | undefined>;
|
|
189
|
+
listEnvironmentRevisions(orgName: string, projectName: string, envName: string, before?: number, count?: number): Promise<Array<EnvironmentRevision> | undefined>;
|
|
176
190
|
/**
|
|
177
191
|
* listEnvironmentRevisionTags lists the environment revision tags.
|
|
178
192
|
* @summary List environment revision tags
|
|
179
193
|
* @param {string} orgName Organization name
|
|
194
|
+
* @param {string} projectName Project name
|
|
180
195
|
* @param {string} envName Environment name
|
|
181
196
|
* @param {string} after The tag to start listing from
|
|
182
197
|
* @param {number} count The number of tags to list
|
|
183
198
|
* @returns {Promise<EnvironmentRevisionTags | undefined>} A list of environment revision tags
|
|
184
199
|
*/
|
|
185
|
-
listEnvironmentRevisionTags(orgName: string, envName: string, after?: string, count?: number): Promise<EnvironmentRevisionTags | undefined>;
|
|
200
|
+
listEnvironmentRevisionTags(orgName: string, projectName: string, envName: string, after?: string, count?: number): Promise<EnvironmentRevisionTags | undefined>;
|
|
186
201
|
/**
|
|
187
202
|
* getEnvironmentRevisionTag gets the environment revision tag.
|
|
188
203
|
* @summary Get environment revision tag
|
|
189
204
|
* @param {string} orgName Organization name
|
|
205
|
+
* @param {string} projectName Project name
|
|
190
206
|
* @param {string} envName Environment name
|
|
191
207
|
* @param {string} tag The tag name
|
|
192
208
|
* @returns {Promise<EnvironmentRevisionTag | undefined>} The environment revision tag
|
|
193
209
|
*/
|
|
194
|
-
getEnvironmentRevisionTag(orgName: string, envName: string, tag: string): Promise<EnvironmentRevisionTag | undefined>;
|
|
210
|
+
getEnvironmentRevisionTag(orgName: string, projectName: string, envName: string, tag: string): Promise<EnvironmentRevisionTag | undefined>;
|
|
195
211
|
/**
|
|
196
212
|
* createEnvironmentRevisionTag creates a new environment revision tag.
|
|
197
213
|
* @summary Create environment revision tag
|
|
198
214
|
* @param {string} orgName Organization name
|
|
215
|
+
* @param {string} projectName Project name
|
|
199
216
|
* @param {string} envName Environment name
|
|
200
217
|
* @param {string} tag The tag name
|
|
201
218
|
* @param {number} revision The revision number
|
|
202
219
|
* @returns {Promise<void>} A promise that resolves when the tag is created
|
|
203
220
|
*/
|
|
204
|
-
createEnvironmentRevisionTag(orgName: string, envName: string, tag: string, revision: number): Promise<void>;
|
|
221
|
+
createEnvironmentRevisionTag(orgName: string, projectName: string, envName: string, tag: string, revision: number): Promise<void>;
|
|
205
222
|
/**
|
|
206
223
|
* updateEnvironmentRevisionTag updates the environment revision tag.
|
|
207
224
|
* @summary Update environment revision tag
|
|
208
225
|
* @param {string} orgName Organization name
|
|
226
|
+
* @param {string} projectName Project name
|
|
209
227
|
* @param {string} envName Environment name
|
|
210
228
|
* @param {string} tag The tag name
|
|
211
229
|
* @param {number} revision The revision number
|
|
212
230
|
* @returns {Promise<void>} A promise that resolves when the tag is updated
|
|
213
231
|
*/
|
|
214
|
-
updateEnvironmentRevisionTag(orgName: string, envName: string, tag: string, revision: number): Promise<void>;
|
|
232
|
+
updateEnvironmentRevisionTag(orgName: string, projectName: string, envName: string, tag: string, revision: number): Promise<void>;
|
|
215
233
|
/**
|
|
216
234
|
* deleteEnvironmentRevisionTag deletes the environment revision tag.
|
|
217
235
|
* @summary Delete environment revision tag
|
|
218
236
|
* @param {string} orgName Organization name
|
|
237
|
+
* @param {string} projectName Project name
|
|
219
238
|
* @param {string} envName Environment name
|
|
220
239
|
* @param {string} tag The tag name
|
|
221
240
|
* @returns {Promise<void>} A promise that resolves when the tag is deleted
|
|
222
241
|
*/
|
|
223
|
-
deleteEnvironmentRevisionTag(orgName: string, envName: string, tag: string): Promise<void>;
|
|
242
|
+
deleteEnvironmentRevisionTag(orgName: string, projectName: string, envName: string, tag: string): Promise<void>;
|
|
243
|
+
/**
|
|
244
|
+
* listEnvironmentTags lists the environment tags.
|
|
245
|
+
* @summary List environment tags
|
|
246
|
+
* @param {string} orgName Organization name
|
|
247
|
+
* @param {string} projectName Project name
|
|
248
|
+
* @param {string} envName Environment name
|
|
249
|
+
* @param {string} after The tag to start listing from
|
|
250
|
+
* @param {number} count The number of tags to list
|
|
251
|
+
* @returns {Promise<ListEnvironmentTags | undefined>} A list of environment tags
|
|
252
|
+
*/
|
|
253
|
+
listEnvironmentTags(orgName: string, projectName: string, envName: string, after?: string, count?: number): Promise<ListEnvironmentTags | undefined>;
|
|
254
|
+
/**
|
|
255
|
+
* getEnvironmentTag gets the environment tag.
|
|
256
|
+
* @summary Get environment tag
|
|
257
|
+
* @param {string} orgName Organization name
|
|
258
|
+
* @param {string} projectName Project name
|
|
259
|
+
* @param {string} envName Environment name
|
|
260
|
+
* @param {string} tag The tag name
|
|
261
|
+
* @returns {Promise<EnvironmentTag | undefined>} The environment tag
|
|
262
|
+
*/
|
|
263
|
+
getEnvironmentTag(orgName: string, projectName: string, envName: string, tag: string): Promise<EnvironmentTag | undefined>;
|
|
264
|
+
/**
|
|
265
|
+
* createEnvironmentTag creates a new environment tag.
|
|
266
|
+
* @summary Create environment tag
|
|
267
|
+
* @param {string} orgName Organization name
|
|
268
|
+
* @param {string} projectName Project name
|
|
269
|
+
* @param {string} envName Environment name
|
|
270
|
+
* @param {string} tag The tag name
|
|
271
|
+
* @param {string} value The tag value
|
|
272
|
+
* @returns {Promise<EnvironmentTag>} A promise that resolves when the tag is created
|
|
273
|
+
*/
|
|
274
|
+
createEnvironmentTag(orgName: string, projectName: string, envName: string, tag: string, value: string): Promise<void>;
|
|
275
|
+
/**
|
|
276
|
+
* updateEnvironmentTag updates the environment tag.
|
|
277
|
+
* @summary Update environment tag
|
|
278
|
+
* @param {string} orgName Organization name
|
|
279
|
+
* @param {string} projectName Project name
|
|
280
|
+
* @param {string} envName Environment name
|
|
281
|
+
* @param {string} tag The tag name
|
|
282
|
+
* @param {string} current_value The tag value
|
|
283
|
+
* @param {string} new_tag The new tag name
|
|
284
|
+
* @param {string} new_value The new tag value
|
|
285
|
+
* @returns {Promise<EnvironmentTag>} A promise that resolves when the tag is updated
|
|
286
|
+
*/
|
|
287
|
+
updateEnvironmentTag(orgName: string, projectName: string, envName: string, tag: string, current_value: string, new_tag: string, new_value: string): Promise<void>;
|
|
288
|
+
/**
|
|
289
|
+
* deleteEnvironmentTag deletes the environment tag.
|
|
290
|
+
* @summary Delete environment tag
|
|
291
|
+
* @param {string} orgName Organization name
|
|
292
|
+
* @param {string} projectName Project name
|
|
293
|
+
* @param {string} envName Environment name
|
|
294
|
+
* @param {string} tag The tag name
|
|
295
|
+
* @returns {Promise<void>} A promise that resolves when the tag is deleted
|
|
296
|
+
*/
|
|
297
|
+
deleteEnvironmentTag(orgName: string, projectName: string, envName: string, tag: string): Promise<void>;
|
|
224
298
|
}
|