@quantcdn/quant-client 3.0.4 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/README.md +148 -18
  2. package/api.ts +24933 -0
  3. package/base.ts +89 -0
  4. package/common.ts +150 -0
  5. package/configuration.ts +115 -0
  6. package/dist/api.d.ts +17980 -2
  7. package/dist/api.js +13594 -16
  8. package/dist/base.d.ts +66 -0
  9. package/dist/base.js +68 -0
  10. package/dist/common.d.ts +65 -0
  11. package/dist/common.js +161 -0
  12. package/dist/configuration.d.ts +91 -0
  13. package/dist/configuration.js +44 -0
  14. package/dist/esm/api.d.ts +17980 -0
  15. package/dist/esm/api.js +13455 -0
  16. package/dist/esm/base.d.ts +66 -0
  17. package/dist/esm/base.js +63 -0
  18. package/dist/esm/common.d.ts +65 -0
  19. package/dist/esm/common.js +149 -0
  20. package/dist/esm/configuration.d.ts +91 -0
  21. package/dist/esm/configuration.js +40 -0
  22. package/dist/esm/examples/basic-usage.d.ts +4 -0
  23. package/dist/esm/examples/basic-usage.js +93 -0
  24. package/dist/esm/index.d.ts +13 -0
  25. package/dist/esm/index.js +15 -0
  26. package/dist/examples/basic-usage.d.ts +4 -0
  27. package/dist/examples/basic-usage.js +95 -0
  28. package/dist/index.d.ts +13 -0
  29. package/dist/index.js +31 -0
  30. package/index.ts +18 -0
  31. package/package.json +44 -22
  32. package/tsconfig.json +18 -0
  33. package/dist/api/apis.d.ts +0 -32
  34. package/dist/api/apis.js +0 -50
  35. package/dist/api/applicationsApi.d.ts +0 -104
  36. package/dist/api/applicationsApi.js +0 -431
  37. package/dist/api/backupManagementApi.d.ts +0 -112
  38. package/dist/api/backupManagementApi.js +0 -464
  39. package/dist/api/commandsApi.d.ts +0 -80
  40. package/dist/api/commandsApi.js +0 -316
  41. package/dist/api/composeApi.d.ts +0 -67
  42. package/dist/api/composeApi.js +0 -240
  43. package/dist/api/containersApi.d.ts +0 -67
  44. package/dist/api/containersApi.js +0 -236
  45. package/dist/api/cronApi.d.ts +0 -151
  46. package/dist/api/cronApi.js +0 -681
  47. package/dist/api/environmentsApi.d.ts +0 -194
  48. package/dist/api/environmentsApi.js +0 -869
  49. package/dist/api/sSHAccessApi.d.ts +0 -50
  50. package/dist/api/sSHAccessApi.js +0 -162
  51. package/dist/api/scalingPolicyApi.d.ts +0 -82
  52. package/dist/api/scalingPolicyApi.js +0 -307
  53. package/dist/api/variablesApi.d.ts +0 -83
  54. package/dist/api/variablesApi.js +0 -313
  55. package/dist/api/volumesApi.d.ts +0 -97
  56. package/dist/api/volumesApi.js +0 -405
  57. package/dist/model/application.d.ts +0 -38
  58. package/dist/model/application.js +0 -93
  59. package/dist/model/command.d.ts +0 -34
  60. package/dist/model/command.js +0 -73
  61. package/dist/model/compose.d.ts +0 -32
  62. package/dist/model/compose.js +0 -58
  63. package/dist/model/configuration.d.ts +0 -26
  64. package/dist/model/configuration.js +0 -30
  65. package/dist/model/container.d.ts +0 -75
  66. package/dist/model/container.js +0 -121
  67. package/dist/model/containerDependsOnInner.d.ts +0 -40
  68. package/dist/model/containerDependsOnInner.js +0 -42
  69. package/dist/model/containerEnvironmentInner.d.ts +0 -32
  70. package/dist/model/containerEnvironmentInner.js +0 -33
  71. package/dist/model/containerHealthCheck.d.ts +0 -47
  72. package/dist/model/containerHealthCheck.js +0 -65
  73. package/dist/model/containerImageReference.d.ts +0 -38
  74. package/dist/model/containerImageReference.js +0 -40
  75. package/dist/model/containerMountPointsInner.d.ts +0 -33
  76. package/dist/model/containerMountPointsInner.js +0 -41
  77. package/dist/model/containerSecretsInner.d.ts +0 -32
  78. package/dist/model/containerSecretsInner.js +0 -33
  79. package/dist/model/createApplicationRequest.d.ts +0 -28
  80. package/dist/model/createApplicationRequest.js +0 -43
  81. package/dist/model/createBackup202Response.d.ts +0 -27
  82. package/dist/model/createBackup202Response.js +0 -38
  83. package/dist/model/createBackupRequest.d.ts +0 -32
  84. package/dist/model/createBackupRequest.js +0 -33
  85. package/dist/model/createCommandRequest.d.ts +0 -25
  86. package/dist/model/createCommandRequest.js +0 -28
  87. package/dist/model/createCronJob422Response.d.ts +0 -26
  88. package/dist/model/createCronJob422Response.js +0 -33
  89. package/dist/model/createCronJobRequest.d.ts +0 -30
  90. package/dist/model/createCronJobRequest.js +0 -56
  91. package/dist/model/createEnvironmentRequest.d.ts +0 -34
  92. package/dist/model/createEnvironmentRequest.js +0 -53
  93. package/dist/model/cron.d.ts +0 -27
  94. package/dist/model/cron.js +0 -38
  95. package/dist/model/cronRun.d.ts +0 -48
  96. package/dist/model/cronRun.js +0 -89
  97. package/dist/model/deleteBackup200Response.d.ts +0 -26
  98. package/dist/model/deleteBackup200Response.js +0 -33
  99. package/dist/model/downloadBackup200Response.d.ts +0 -36
  100. package/dist/model/downloadBackup200Response.js +0 -38
  101. package/dist/model/environment.d.ts +0 -45
  102. package/dist/model/environment.js +0 -103
  103. package/dist/model/getEcrLoginCredentials200Response.d.ts +0 -28
  104. package/dist/model/getEcrLoginCredentials200Response.js +0 -43
  105. package/dist/model/getScalingPolicies200Response.d.ts +0 -26
  106. package/dist/model/getScalingPolicies200Response.js +0 -28
  107. package/dist/model/getSshAccessCredentials200Response.d.ts +0 -34
  108. package/dist/model/getSshAccessCredentials200Response.js +0 -68
  109. package/dist/model/getSshAccessCredentials200ResponseCredentials.d.ts +0 -28
  110. package/dist/model/getSshAccessCredentials200ResponseCredentials.js +0 -43
  111. package/dist/model/listBackups200Response.d.ts +0 -32
  112. package/dist/model/listBackups200Response.js +0 -43
  113. package/dist/model/listBackups200ResponseBackupsInner.d.ts +0 -37
  114. package/dist/model/listBackups200ResponseBackupsInner.js +0 -88
  115. package/dist/model/listBackups422Response.d.ts +0 -25
  116. package/dist/model/listBackups422Response.js +0 -28
  117. package/dist/model/models.d.ts +0 -89
  118. package/dist/model/models.js +0 -387
  119. package/dist/model/scalingPolicy.d.ts +0 -35
  120. package/dist/model/scalingPolicy.js +0 -51
  121. package/dist/model/syncOperation.d.ts +0 -31
  122. package/dist/model/syncOperation.js +0 -58
  123. package/dist/model/syncToEnvironmentRequest.d.ts +0 -25
  124. package/dist/model/syncToEnvironmentRequest.js +0 -28
  125. package/dist/model/updateComposeRequest.d.ts +0 -26
  126. package/dist/model/updateComposeRequest.js +0 -28
  127. package/dist/model/updateCronJobRequest.d.ts +0 -29
  128. package/dist/model/updateCronJobRequest.js +0 -48
  129. package/dist/model/updateEnvironmentComposeRequest.d.ts +0 -26
  130. package/dist/model/updateEnvironmentComposeRequest.js +0 -28
  131. package/dist/model/updateEnvironmentRequest.d.ts +0 -34
  132. package/dist/model/updateEnvironmentRequest.js +0 -38
  133. package/dist/model/updateEnvironmentStateRequest.d.ts +0 -26
  134. package/dist/model/updateEnvironmentStateRequest.js +0 -33
  135. package/dist/model/updateEnvironmentVariableRequest.d.ts +0 -25
  136. package/dist/model/updateEnvironmentVariableRequest.js +0 -28
  137. package/dist/model/validateCompose200Response.d.ts +0 -33
  138. package/dist/model/validateCompose200Response.js +0 -38
  139. package/dist/model/validateCompose422Response.d.ts +0 -25
  140. package/dist/model/validateCompose422Response.js +0 -28
  141. package/dist/model/validateComposeRequest.d.ts +0 -36
  142. package/dist/model/validateComposeRequest.js +0 -38
  143. package/dist/model/variable.d.ts +0 -26
  144. package/dist/model/variable.js +0 -33
  145. package/dist/model/volume.d.ts +0 -32
  146. package/dist/model/volume.js +0 -63
@@ -1,316 +0,0 @@
1
- "use strict";
2
- /**
3
- * QuantCloud API
4
- * QuantCloud API
5
- *
6
- * The version of the OpenAPI document: 1.0.0
7
- *
8
- *
9
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10
- * https://openapi-generator.tech
11
- * Do not edit the class manually.
12
- */
13
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
- return new (P || (P = Promise))(function (resolve, reject) {
16
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
- step((generator = generator.apply(thisArg, _arguments || [])).next());
20
- });
21
- };
22
- var __importDefault = (this && this.__importDefault) || function (mod) {
23
- return (mod && mod.__esModule) ? mod : { "default": mod };
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.CommandsApi = exports.CommandsApiApiKeys = void 0;
27
- const request_1 = __importDefault(require("request"));
28
- const models_1 = require("../model/models");
29
- const apis_1 = require("./apis");
30
- let defaultBasePath = 'http://localhost';
31
- // ===============================================
32
- // This file is autogenerated - Please do not edit
33
- // ===============================================
34
- var CommandsApiApiKeys;
35
- (function (CommandsApiApiKeys) {
36
- })(CommandsApiApiKeys = exports.CommandsApiApiKeys || (exports.CommandsApiApiKeys = {}));
37
- class CommandsApi {
38
- constructor(basePathOrUsername, password, basePath) {
39
- this._basePath = defaultBasePath;
40
- this._defaultHeaders = {};
41
- this._useQuerystring = false;
42
- this.authentications = {
43
- 'default': new models_1.VoidAuth(),
44
- };
45
- this.interceptors = [];
46
- if (password) {
47
- if (basePath) {
48
- this.basePath = basePath;
49
- }
50
- }
51
- else {
52
- if (basePathOrUsername) {
53
- this.basePath = basePathOrUsername;
54
- }
55
- }
56
- }
57
- set useQuerystring(value) {
58
- this._useQuerystring = value;
59
- }
60
- set basePath(basePath) {
61
- this._basePath = basePath;
62
- }
63
- set defaultHeaders(defaultHeaders) {
64
- this._defaultHeaders = defaultHeaders;
65
- }
66
- get defaultHeaders() {
67
- return this._defaultHeaders;
68
- }
69
- get basePath() {
70
- return this._basePath;
71
- }
72
- setDefaultAuthentication(auth) {
73
- this.authentications.default = auth;
74
- }
75
- setApiKey(key, value) {
76
- this.authentications[CommandsApiApiKeys[key]].apiKey = value;
77
- }
78
- addInterceptor(interceptor) {
79
- this.interceptors.push(interceptor);
80
- }
81
- /**
82
- *
83
- * @summary Create a command for an environment
84
- * @param organisation The organisation ID
85
- * @param environment The environment ID
86
- * @param createCommandRequest
87
- */
88
- createCommand(organisation, environment, createCommandRequest, options = { headers: {} }) {
89
- return __awaiter(this, void 0, void 0, function* () {
90
- const localVarPath = this.basePath + '/organisations/{organisation}/environments/{environment}/commands'
91
- .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
92
- .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)));
93
- let localVarQueryParameters = {};
94
- let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
95
- const produces = ['application/json'];
96
- // give precedence to 'application/json'
97
- if (produces.indexOf('application/json') >= 0) {
98
- localVarHeaderParams.Accept = 'application/json';
99
- }
100
- else {
101
- localVarHeaderParams.Accept = produces.join(',');
102
- }
103
- let localVarFormParams = {};
104
- // verify required parameter 'organisation' is not null or undefined
105
- if (organisation === null || organisation === undefined) {
106
- throw new Error('Required parameter organisation was null or undefined when calling createCommand.');
107
- }
108
- // verify required parameter 'environment' is not null or undefined
109
- if (environment === null || environment === undefined) {
110
- throw new Error('Required parameter environment was null or undefined when calling createCommand.');
111
- }
112
- // verify required parameter 'createCommandRequest' is not null or undefined
113
- if (createCommandRequest === null || createCommandRequest === undefined) {
114
- throw new Error('Required parameter createCommandRequest was null or undefined when calling createCommand.');
115
- }
116
- Object.assign(localVarHeaderParams, options.headers);
117
- let localVarUseFormData = false;
118
- let localVarRequestOptions = {
119
- method: 'POST',
120
- qs: localVarQueryParameters,
121
- headers: localVarHeaderParams,
122
- uri: localVarPath,
123
- useQuerystring: this._useQuerystring,
124
- json: true,
125
- body: models_1.ObjectSerializer.serialize(createCommandRequest, "CreateCommandRequest")
126
- };
127
- let authenticationPromise = Promise.resolve();
128
- authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
129
- let interceptorPromise = authenticationPromise;
130
- for (const interceptor of this.interceptors) {
131
- interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
132
- }
133
- return interceptorPromise.then(() => {
134
- if (Object.keys(localVarFormParams).length) {
135
- if (localVarUseFormData) {
136
- localVarRequestOptions.formData = localVarFormParams;
137
- }
138
- else {
139
- localVarRequestOptions.form = localVarFormParams;
140
- }
141
- }
142
- return new Promise((resolve, reject) => {
143
- (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
144
- if (error) {
145
- reject(error);
146
- }
147
- else {
148
- if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
149
- body = models_1.ObjectSerializer.deserialize(body, "Command");
150
- resolve({ response: response, body: body });
151
- }
152
- else {
153
- reject(new apis_1.HttpError(response, body, response.statusCode));
154
- }
155
- }
156
- });
157
- });
158
- });
159
- });
160
- }
161
- /**
162
- *
163
- * @summary Get a command
164
- * @param organisation The organisation ID
165
- * @param environment The environment ID
166
- * @param command The command ID
167
- */
168
- getCommand(organisation, environment, command, options = { headers: {} }) {
169
- return __awaiter(this, void 0, void 0, function* () {
170
- const localVarPath = this.basePath + '/organisations/{organisation}/environments/{environment}/commands/{command}'
171
- .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
172
- .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)))
173
- .replace('{' + 'command' + '}', encodeURIComponent(String(command)));
174
- let localVarQueryParameters = {};
175
- let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
176
- const produces = ['application/json'];
177
- // give precedence to 'application/json'
178
- if (produces.indexOf('application/json') >= 0) {
179
- localVarHeaderParams.Accept = 'application/json';
180
- }
181
- else {
182
- localVarHeaderParams.Accept = produces.join(',');
183
- }
184
- let localVarFormParams = {};
185
- // verify required parameter 'organisation' is not null or undefined
186
- if (organisation === null || organisation === undefined) {
187
- throw new Error('Required parameter organisation was null or undefined when calling getCommand.');
188
- }
189
- // verify required parameter 'environment' is not null or undefined
190
- if (environment === null || environment === undefined) {
191
- throw new Error('Required parameter environment was null or undefined when calling getCommand.');
192
- }
193
- // verify required parameter 'command' is not null or undefined
194
- if (command === null || command === undefined) {
195
- throw new Error('Required parameter command was null or undefined when calling getCommand.');
196
- }
197
- Object.assign(localVarHeaderParams, options.headers);
198
- let localVarUseFormData = false;
199
- let localVarRequestOptions = {
200
- method: 'GET',
201
- qs: localVarQueryParameters,
202
- headers: localVarHeaderParams,
203
- uri: localVarPath,
204
- useQuerystring: this._useQuerystring,
205
- json: true,
206
- };
207
- let authenticationPromise = Promise.resolve();
208
- authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
209
- let interceptorPromise = authenticationPromise;
210
- for (const interceptor of this.interceptors) {
211
- interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
212
- }
213
- return interceptorPromise.then(() => {
214
- if (Object.keys(localVarFormParams).length) {
215
- if (localVarUseFormData) {
216
- localVarRequestOptions.formData = localVarFormParams;
217
- }
218
- else {
219
- localVarRequestOptions.form = localVarFormParams;
220
- }
221
- }
222
- return new Promise((resolve, reject) => {
223
- (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
224
- if (error) {
225
- reject(error);
226
- }
227
- else {
228
- if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
229
- body = models_1.ObjectSerializer.deserialize(body, "Command");
230
- resolve({ response: response, body: body });
231
- }
232
- else {
233
- reject(new apis_1.HttpError(response, body, response.statusCode));
234
- }
235
- }
236
- });
237
- });
238
- });
239
- });
240
- }
241
- /**
242
- *
243
- * @summary Get all commands for an environment
244
- * @param organisation The organisation ID
245
- * @param environment The environment ID
246
- */
247
- listCommands(organisation, environment, options = { headers: {} }) {
248
- return __awaiter(this, void 0, void 0, function* () {
249
- const localVarPath = this.basePath + '/organisations/{organisation}/environments/{environment}/commands'
250
- .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
251
- .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)));
252
- let localVarQueryParameters = {};
253
- let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
254
- const produces = ['application/json'];
255
- // give precedence to 'application/json'
256
- if (produces.indexOf('application/json') >= 0) {
257
- localVarHeaderParams.Accept = 'application/json';
258
- }
259
- else {
260
- localVarHeaderParams.Accept = produces.join(',');
261
- }
262
- let localVarFormParams = {};
263
- // verify required parameter 'organisation' is not null or undefined
264
- if (organisation === null || organisation === undefined) {
265
- throw new Error('Required parameter organisation was null or undefined when calling listCommands.');
266
- }
267
- // verify required parameter 'environment' is not null or undefined
268
- if (environment === null || environment === undefined) {
269
- throw new Error('Required parameter environment was null or undefined when calling listCommands.');
270
- }
271
- Object.assign(localVarHeaderParams, options.headers);
272
- let localVarUseFormData = false;
273
- let localVarRequestOptions = {
274
- method: 'GET',
275
- qs: localVarQueryParameters,
276
- headers: localVarHeaderParams,
277
- uri: localVarPath,
278
- useQuerystring: this._useQuerystring,
279
- json: true,
280
- };
281
- let authenticationPromise = Promise.resolve();
282
- authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
283
- let interceptorPromise = authenticationPromise;
284
- for (const interceptor of this.interceptors) {
285
- interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
286
- }
287
- return interceptorPromise.then(() => {
288
- if (Object.keys(localVarFormParams).length) {
289
- if (localVarUseFormData) {
290
- localVarRequestOptions.formData = localVarFormParams;
291
- }
292
- else {
293
- localVarRequestOptions.form = localVarFormParams;
294
- }
295
- }
296
- return new Promise((resolve, reject) => {
297
- (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
298
- if (error) {
299
- reject(error);
300
- }
301
- else {
302
- if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
303
- body = models_1.ObjectSerializer.deserialize(body, "Command");
304
- resolve({ response: response, body: body });
305
- }
306
- else {
307
- reject(new apis_1.HttpError(response, body, response.statusCode));
308
- }
309
- }
310
- });
311
- });
312
- });
313
- });
314
- }
315
- }
316
- exports.CommandsApi = CommandsApi;
@@ -1,67 +0,0 @@
1
- /**
2
- * QuantCloud API
3
- * QuantCloud API
4
- *
5
- * The version of the OpenAPI document: 1.0.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
- /// <reference types="node" />
13
- import http from 'http';
14
- import { Compose } from '../model/compose';
15
- import { ValidateCompose200Response } from '../model/validateCompose200Response';
16
- import { ValidateComposeRequest } from '../model/validateComposeRequest';
17
- import { Authentication, Interceptor } from '../model/models';
18
- export declare enum ComposeApiApiKeys {
19
- }
20
- export declare class ComposeApi {
21
- protected _basePath: string;
22
- protected _defaultHeaders: any;
23
- protected _useQuerystring: boolean;
24
- protected authentications: {
25
- default: Authentication;
26
- };
27
- protected interceptors: Interceptor[];
28
- constructor(basePath?: string);
29
- set useQuerystring(value: boolean);
30
- set basePath(basePath: string);
31
- set defaultHeaders(defaultHeaders: any);
32
- get defaultHeaders(): any;
33
- get basePath(): string;
34
- setDefaultAuthentication(auth: Authentication): void;
35
- setApiKey(key: ComposeApiApiKeys, value: string): void;
36
- addInterceptor(interceptor: Interceptor): void;
37
- /**
38
- *
39
- * @summary Get the compose file for an environment
40
- * @param organisation The organisation ID
41
- * @param application The application ID
42
- * @param environment The environment ID
43
- */
44
- getEnvironmentCompose(organisation: string, application: string, environment: string, options?: {
45
- headers: {
46
- [name: string]: string;
47
- };
48
- }): Promise<{
49
- response: http.IncomingMessage;
50
- body: Compose;
51
- }>;
52
- /**
53
- * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
54
- * @summary Validate Docker Compose File
55
- * @param organisation The organisation ID
56
- * @param validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
57
- * @param imageSuffix Optional. Image tag suffix to apply during translation. Transforms internal image tags to consistent \&#39;{containerName}-{suffix}\&#39; format (e.g., \&#39;nginx-pr-456\&#39;). External images are left unchanged. Useful for feature branch deployments.
58
- */
59
- validateCompose(organisation: string, validateComposeRequest: ValidateComposeRequest, imageSuffix?: string, options?: {
60
- headers: {
61
- [name: string]: string;
62
- };
63
- }): Promise<{
64
- response: http.IncomingMessage;
65
- body: ValidateCompose200Response;
66
- }>;
67
- }
@@ -1,240 +0,0 @@
1
- "use strict";
2
- /**
3
- * QuantCloud API
4
- * QuantCloud API
5
- *
6
- * The version of the OpenAPI document: 1.0.0
7
- *
8
- *
9
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10
- * https://openapi-generator.tech
11
- * Do not edit the class manually.
12
- */
13
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
- return new (P || (P = Promise))(function (resolve, reject) {
16
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
- step((generator = generator.apply(thisArg, _arguments || [])).next());
20
- });
21
- };
22
- var __importDefault = (this && this.__importDefault) || function (mod) {
23
- return (mod && mod.__esModule) ? mod : { "default": mod };
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.ComposeApi = exports.ComposeApiApiKeys = void 0;
27
- const request_1 = __importDefault(require("request"));
28
- const models_1 = require("../model/models");
29
- const apis_1 = require("./apis");
30
- let defaultBasePath = 'http://localhost';
31
- // ===============================================
32
- // This file is autogenerated - Please do not edit
33
- // ===============================================
34
- var ComposeApiApiKeys;
35
- (function (ComposeApiApiKeys) {
36
- })(ComposeApiApiKeys = exports.ComposeApiApiKeys || (exports.ComposeApiApiKeys = {}));
37
- class ComposeApi {
38
- constructor(basePathOrUsername, password, basePath) {
39
- this._basePath = defaultBasePath;
40
- this._defaultHeaders = {};
41
- this._useQuerystring = false;
42
- this.authentications = {
43
- 'default': new models_1.VoidAuth(),
44
- };
45
- this.interceptors = [];
46
- if (password) {
47
- if (basePath) {
48
- this.basePath = basePath;
49
- }
50
- }
51
- else {
52
- if (basePathOrUsername) {
53
- this.basePath = basePathOrUsername;
54
- }
55
- }
56
- }
57
- set useQuerystring(value) {
58
- this._useQuerystring = value;
59
- }
60
- set basePath(basePath) {
61
- this._basePath = basePath;
62
- }
63
- set defaultHeaders(defaultHeaders) {
64
- this._defaultHeaders = defaultHeaders;
65
- }
66
- get defaultHeaders() {
67
- return this._defaultHeaders;
68
- }
69
- get basePath() {
70
- return this._basePath;
71
- }
72
- setDefaultAuthentication(auth) {
73
- this.authentications.default = auth;
74
- }
75
- setApiKey(key, value) {
76
- this.authentications[ComposeApiApiKeys[key]].apiKey = value;
77
- }
78
- addInterceptor(interceptor) {
79
- this.interceptors.push(interceptor);
80
- }
81
- /**
82
- *
83
- * @summary Get the compose file for an environment
84
- * @param organisation The organisation ID
85
- * @param application The application ID
86
- * @param environment The environment ID
87
- */
88
- getEnvironmentCompose(organisation, application, environment, options = { headers: {} }) {
89
- return __awaiter(this, void 0, void 0, function* () {
90
- const localVarPath = this.basePath + '/organisations/{organisation}/environments/{environment}/compose'
91
- .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
92
- .replace('{' + 'application' + '}', encodeURIComponent(String(application)))
93
- .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)));
94
- let localVarQueryParameters = {};
95
- let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
96
- const produces = ['application/json'];
97
- // give precedence to 'application/json'
98
- if (produces.indexOf('application/json') >= 0) {
99
- localVarHeaderParams.Accept = 'application/json';
100
- }
101
- else {
102
- localVarHeaderParams.Accept = produces.join(',');
103
- }
104
- let localVarFormParams = {};
105
- // verify required parameter 'organisation' is not null or undefined
106
- if (organisation === null || organisation === undefined) {
107
- throw new Error('Required parameter organisation was null or undefined when calling getEnvironmentCompose.');
108
- }
109
- // verify required parameter 'application' is not null or undefined
110
- if (application === null || application === undefined) {
111
- throw new Error('Required parameter application was null or undefined when calling getEnvironmentCompose.');
112
- }
113
- // verify required parameter 'environment' is not null or undefined
114
- if (environment === null || environment === undefined) {
115
- throw new Error('Required parameter environment was null or undefined when calling getEnvironmentCompose.');
116
- }
117
- Object.assign(localVarHeaderParams, options.headers);
118
- let localVarUseFormData = false;
119
- let localVarRequestOptions = {
120
- method: 'GET',
121
- qs: localVarQueryParameters,
122
- headers: localVarHeaderParams,
123
- uri: localVarPath,
124
- useQuerystring: this._useQuerystring,
125
- json: true,
126
- };
127
- let authenticationPromise = Promise.resolve();
128
- authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
129
- let interceptorPromise = authenticationPromise;
130
- for (const interceptor of this.interceptors) {
131
- interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
132
- }
133
- return interceptorPromise.then(() => {
134
- if (Object.keys(localVarFormParams).length) {
135
- if (localVarUseFormData) {
136
- localVarRequestOptions.formData = localVarFormParams;
137
- }
138
- else {
139
- localVarRequestOptions.form = localVarFormParams;
140
- }
141
- }
142
- return new Promise((resolve, reject) => {
143
- (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
144
- if (error) {
145
- reject(error);
146
- }
147
- else {
148
- if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
149
- body = models_1.ObjectSerializer.deserialize(body, "Compose");
150
- resolve({ response: response, body: body });
151
- }
152
- else {
153
- reject(new apis_1.HttpError(response, body, response.statusCode));
154
- }
155
- }
156
- });
157
- });
158
- });
159
- });
160
- }
161
- /**
162
- * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
163
- * @summary Validate Docker Compose File
164
- * @param organisation The organisation ID
165
- * @param validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
166
- * @param imageSuffix Optional. Image tag suffix to apply during translation. Transforms internal image tags to consistent \&#39;{containerName}-{suffix}\&#39; format (e.g., \&#39;nginx-pr-456\&#39;). External images are left unchanged. Useful for feature branch deployments.
167
- */
168
- validateCompose(organisation, validateComposeRequest, imageSuffix, options = { headers: {} }) {
169
- return __awaiter(this, void 0, void 0, function* () {
170
- const localVarPath = this.basePath + '/organisations/{organisation}/compose/validate'
171
- .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)));
172
- let localVarQueryParameters = {};
173
- let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
174
- const produces = ['application/json'];
175
- // give precedence to 'application/json'
176
- if (produces.indexOf('application/json') >= 0) {
177
- localVarHeaderParams.Accept = 'application/json';
178
- }
179
- else {
180
- localVarHeaderParams.Accept = produces.join(',');
181
- }
182
- let localVarFormParams = {};
183
- // verify required parameter 'organisation' is not null or undefined
184
- if (organisation === null || organisation === undefined) {
185
- throw new Error('Required parameter organisation was null or undefined when calling validateCompose.');
186
- }
187
- // verify required parameter 'validateComposeRequest' is not null or undefined
188
- if (validateComposeRequest === null || validateComposeRequest === undefined) {
189
- throw new Error('Required parameter validateComposeRequest was null or undefined when calling validateCompose.');
190
- }
191
- if (imageSuffix !== undefined) {
192
- localVarQueryParameters['imageSuffix'] = models_1.ObjectSerializer.serialize(imageSuffix, "string");
193
- }
194
- Object.assign(localVarHeaderParams, options.headers);
195
- let localVarUseFormData = false;
196
- let localVarRequestOptions = {
197
- method: 'POST',
198
- qs: localVarQueryParameters,
199
- headers: localVarHeaderParams,
200
- uri: localVarPath,
201
- useQuerystring: this._useQuerystring,
202
- json: true,
203
- body: models_1.ObjectSerializer.serialize(validateComposeRequest, "ValidateComposeRequest")
204
- };
205
- let authenticationPromise = Promise.resolve();
206
- authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
207
- let interceptorPromise = authenticationPromise;
208
- for (const interceptor of this.interceptors) {
209
- interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
210
- }
211
- return interceptorPromise.then(() => {
212
- if (Object.keys(localVarFormParams).length) {
213
- if (localVarUseFormData) {
214
- localVarRequestOptions.formData = localVarFormParams;
215
- }
216
- else {
217
- localVarRequestOptions.form = localVarFormParams;
218
- }
219
- }
220
- return new Promise((resolve, reject) => {
221
- (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
222
- if (error) {
223
- reject(error);
224
- }
225
- else {
226
- if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
227
- body = models_1.ObjectSerializer.deserialize(body, "ValidateCompose200Response");
228
- resolve({ response: response, body: body });
229
- }
230
- else {
231
- reject(new apis_1.HttpError(response, body, response.statusCode));
232
- }
233
- }
234
- });
235
- });
236
- });
237
- });
238
- }
239
- }
240
- exports.ComposeApi = ComposeApi;