@northflank/js-client 0.4.1 → 0.5.0-beta.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 (257) hide show
  1. package/dist/cjs/api-client.d.ts +6013 -0
  2. package/dist/cjs/api-client.js +1 -0
  3. package/dist/cjs/package.json +3 -0
  4. package/dist/esm/api-client.d.ts +6013 -0
  5. package/dist/esm/api-client.js +15 -0
  6. package/dist/esm/package.json +3 -0
  7. package/package.json +12 -19
  8. package/dist/api-client.d.ts +0 -481
  9. package/dist/api-client.js +0 -748
  10. package/dist/api-endpoint.d.ts +0 -63
  11. package/dist/api-endpoint.js +0 -216
  12. package/dist/context/api-client-context-provider.d.ts +0 -47
  13. package/dist/context/api-client-context-provider.js +0 -332
  14. package/dist/context/api-client-file-context-provider.d.ts +0 -11
  15. package/dist/context/api-client-file-context-provider.js +0 -138
  16. package/dist/context/api-client-in-memory-context-provider.d.ts +0 -6
  17. package/dist/context/api-client-in-memory-context-provider.js +0 -82
  18. package/dist/context/index.d.ts +0 -3
  19. package/dist/context/index.js +0 -15
  20. package/dist/endpoints/abort/addon/backup.d.ts +0 -21
  21. package/dist/endpoints/abort/addon/backup.js +0 -36
  22. package/dist/endpoints/abort/addon/restore.d.ts +0 -26
  23. package/dist/endpoints/abort/addon/restore.js +0 -36
  24. package/dist/endpoints/abort/job/build.d.ts +0 -21
  25. package/dist/endpoints/abort/job/build.js +0 -36
  26. package/dist/endpoints/abort/job/run.d.ts +0 -21
  27. package/dist/endpoints/abort/job/run.js +0 -36
  28. package/dist/endpoints/abort/service/build.d.ts +0 -21
  29. package/dist/endpoints/abort/service/build.js +0 -36
  30. package/dist/endpoints/add/domain/subdomain.d.ts +0 -33
  31. package/dist/endpoints/add/domain/subdomain.js +0 -36
  32. package/dist/endpoints/add/registryCredentials.d.ts +0 -47
  33. package/dist/endpoints/add/registryCredentials.js +0 -36
  34. package/dist/endpoints/assign/subdomain/service.d.ts +0 -28
  35. package/dist/endpoints/assign/subdomain/service.js +0 -36
  36. package/dist/endpoints/backup/addon.d.ts +0 -51
  37. package/dist/endpoints/backup/addon.js +0 -36
  38. package/dist/endpoints/create/addon.d.ts +0 -90
  39. package/dist/endpoints/create/addon.js +0 -36
  40. package/dist/endpoints/create/domain.d.ts +0 -27
  41. package/dist/endpoints/create/domain.js +0 -36
  42. package/dist/endpoints/create/job/cron.d.ts +0 -157
  43. package/dist/endpoints/create/job/cron.js +0 -36
  44. package/dist/endpoints/create/job/manual.d.ts +0 -147
  45. package/dist/endpoints/create/job/manual.js +0 -36
  46. package/dist/endpoints/create/project.d.ts +0 -29
  47. package/dist/endpoints/create/project.js +0 -36
  48. package/dist/endpoints/create/secret.d.ts +0 -79
  49. package/dist/endpoints/create/secret.js +0 -36
  50. package/dist/endpoints/create/service/build.d.ts +0 -116
  51. package/dist/endpoints/create/service/build.js +0 -36
  52. package/dist/endpoints/create/service/combined.d.ts +0 -166
  53. package/dist/endpoints/create/service/combined.js +0 -36
  54. package/dist/endpoints/create/service/deployment.d.ts +0 -137
  55. package/dist/endpoints/create/service/deployment.js +0 -36
  56. package/dist/endpoints/delete/addon.d.ts +0 -19
  57. package/dist/endpoints/delete/addon.js +0 -36
  58. package/dist/endpoints/delete/backup.d.ts +0 -21
  59. package/dist/endpoints/delete/backup.js +0 -36
  60. package/dist/endpoints/delete/domain.d.ts +0 -17
  61. package/dist/endpoints/delete/domain.js +0 -36
  62. package/dist/endpoints/delete/job.d.ts +0 -19
  63. package/dist/endpoints/delete/job.js +0 -36
  64. package/dist/endpoints/delete/project.d.ts +0 -17
  65. package/dist/endpoints/delete/project.js +0 -36
  66. package/dist/endpoints/delete/registryCredentials.d.ts +0 -17
  67. package/dist/endpoints/delete/registryCredentials.js +0 -36
  68. package/dist/endpoints/delete/secret.d.ts +0 -19
  69. package/dist/endpoints/delete/secret.js +0 -36
  70. package/dist/endpoints/delete/secretLink.d.ts +0 -21
  71. package/dist/endpoints/delete/secretLink.js +0 -36
  72. package/dist/endpoints/delete/service.d.ts +0 -19
  73. package/dist/endpoints/delete/service.js +0 -36
  74. package/dist/endpoints/delete/subdomain.d.ts +0 -19
  75. package/dist/endpoints/delete/subdomain.js +0 -36
  76. package/dist/endpoints/get/addon/backup/download.d.ts +0 -24
  77. package/dist/endpoints/get/addon/backup/download.js +0 -36
  78. package/dist/endpoints/get/addon/backup.d.ts +0 -46
  79. package/dist/endpoints/get/addon/backup.js +0 -36
  80. package/dist/endpoints/get/addon/backups.d.ts +0 -54
  81. package/dist/endpoints/get/addon/backups.js +0 -40
  82. package/dist/endpoints/get/addon/containers.d.ts +0 -40
  83. package/dist/endpoints/get/addon/containers.js +0 -40
  84. package/dist/endpoints/get/addon/credentials.d.ts +0 -24
  85. package/dist/endpoints/get/addon/credentials.js +0 -36
  86. package/dist/endpoints/get/addon/types.d.ts +0 -48
  87. package/dist/endpoints/get/addon/types.js +0 -36
  88. package/dist/endpoints/get/addon/version.d.ts +0 -53
  89. package/dist/endpoints/get/addon/version.js +0 -36
  90. package/dist/endpoints/get/addon.d.ts +0 -69
  91. package/dist/endpoints/get/addon.js +0 -36
  92. package/dist/endpoints/get/dnsId.d.ts +0 -15
  93. package/dist/endpoints/get/dnsId.js +0 -36
  94. package/dist/endpoints/get/domain.d.ts +0 -33
  95. package/dist/endpoints/get/domain.js +0 -36
  96. package/dist/endpoints/get/job/buildArguments.d.ts +0 -19
  97. package/dist/endpoints/get/job/buildArguments.js +0 -36
  98. package/dist/endpoints/get/job/builds.d.ts +0 -50
  99. package/dist/endpoints/get/job/builds.js +0 -39
  100. package/dist/endpoints/get/job/containers.d.ts +0 -40
  101. package/dist/endpoints/get/job/containers.js +0 -40
  102. package/dist/endpoints/get/job/deployment.d.ts +0 -51
  103. package/dist/endpoints/get/job/deployment.js +0 -36
  104. package/dist/endpoints/get/job/environment.d.ts +0 -24
  105. package/dist/endpoints/get/job/environment.js +0 -40
  106. package/dist/endpoints/get/job/environmentDetails.d.ts +0 -42
  107. package/dist/endpoints/get/job/environmentDetails.js +0 -36
  108. package/dist/endpoints/get/job/healthChecks.d.ts +0 -44
  109. package/dist/endpoints/get/job/healthChecks.js +0 -36
  110. package/dist/endpoints/get/job/run.d.ts +0 -42
  111. package/dist/endpoints/get/job/run.js +0 -36
  112. package/dist/endpoints/get/job/runs.d.ts +0 -52
  113. package/dist/endpoints/get/job/runs.js +0 -39
  114. package/dist/endpoints/get/job.d.ts +0 -86
  115. package/dist/endpoints/get/job.js +0 -36
  116. package/dist/endpoints/get/project.d.ts +0 -72
  117. package/dist/endpoints/get/project.js +0 -36
  118. package/dist/endpoints/get/registryCredentials.d.ts +0 -34
  119. package/dist/endpoints/get/registryCredentials.js +0 -36
  120. package/dist/endpoints/get/secret.d.ts +0 -55
  121. package/dist/endpoints/get/secret.js +0 -39
  122. package/dist/endpoints/get/secretDetails.d.ts +0 -63
  123. package/dist/endpoints/get/secretDetails.js +0 -36
  124. package/dist/endpoints/get/secretLink.d.ts +0 -44
  125. package/dist/endpoints/get/secretLink.js +0 -36
  126. package/dist/endpoints/get/service/buildArguments.d.ts +0 -19
  127. package/dist/endpoints/get/service/buildArguments.js +0 -36
  128. package/dist/endpoints/get/service/builds.d.ts +0 -50
  129. package/dist/endpoints/get/service/builds.js +0 -40
  130. package/dist/endpoints/get/service/containers.d.ts +0 -40
  131. package/dist/endpoints/get/service/containers.js +0 -40
  132. package/dist/endpoints/get/service/deployment.d.ts +0 -51
  133. package/dist/endpoints/get/service/deployment.js +0 -36
  134. package/dist/endpoints/get/service/environmentVariableDetails.d.ts +0 -42
  135. package/dist/endpoints/get/service/environmentVariableDetails.js +0 -36
  136. package/dist/endpoints/get/service/environmentVariables.d.ts +0 -24
  137. package/dist/endpoints/get/service/environmentVariables.js +0 -40
  138. package/dist/endpoints/get/service/healthChecks.d.ts +0 -44
  139. package/dist/endpoints/get/service/healthChecks.js +0 -36
  140. package/dist/endpoints/get/service/ports.d.ts +0 -35
  141. package/dist/endpoints/get/service/ports.js +0 -36
  142. package/dist/endpoints/get/service.d.ts +0 -103
  143. package/dist/endpoints/get/service.js +0 -36
  144. package/dist/endpoints/get/subdomain.d.ts +0 -30
  145. package/dist/endpoints/get/subdomain.js +0 -36
  146. package/dist/endpoints/import/addon/backup.d.ts +0 -31
  147. package/dist/endpoints/import/addon/backup.js +0 -36
  148. package/dist/endpoints/list/addons.d.ts +0 -45
  149. package/dist/endpoints/list/addons.js +0 -39
  150. package/dist/endpoints/list/domains.d.ts +0 -34
  151. package/dist/endpoints/list/domains.js +0 -39
  152. package/dist/endpoints/list/jobs.d.ts +0 -44
  153. package/dist/endpoints/list/jobs.js +0 -39
  154. package/dist/endpoints/list/plans.d.ts +0 -30
  155. package/dist/endpoints/list/plans.js +0 -36
  156. package/dist/endpoints/list/projects.d.ts +0 -32
  157. package/dist/endpoints/list/projects.js +0 -39
  158. package/dist/endpoints/list/regions.d.ts +0 -18
  159. package/dist/endpoints/list/regions.js +0 -36
  160. package/dist/endpoints/list/registryCredentials.d.ts +0 -41
  161. package/dist/endpoints/list/registryCredentials.js +0 -39
  162. package/dist/endpoints/list/secrets.d.ts +0 -52
  163. package/dist/endpoints/list/secrets.js +0 -39
  164. package/dist/endpoints/list/services.d.ts +0 -44
  165. package/dist/endpoints/list/services.js +0 -39
  166. package/dist/endpoints/list/vcs.d.ts +0 -51
  167. package/dist/endpoints/list/vcs.js +0 -36
  168. package/dist/endpoints/pause/addon.d.ts +0 -19
  169. package/dist/endpoints/pause/addon.js +0 -36
  170. package/dist/endpoints/pause/service.d.ts +0 -19
  171. package/dist/endpoints/pause/service.js +0 -36
  172. package/dist/endpoints/restart/addon.d.ts +0 -19
  173. package/dist/endpoints/restart/addon.js +0 -36
  174. package/dist/endpoints/restart/service.d.ts +0 -19
  175. package/dist/endpoints/restart/service.js +0 -36
  176. package/dist/endpoints/restore/addon/backup.d.ts +0 -21
  177. package/dist/endpoints/restore/addon/backup.js +0 -36
  178. package/dist/endpoints/resume/addon.d.ts +0 -19
  179. package/dist/endpoints/resume/addon.js +0 -36
  180. package/dist/endpoints/resume/service.d.ts +0 -24
  181. package/dist/endpoints/resume/service.js +0 -36
  182. package/dist/endpoints/scale/addon.d.ts +0 -28
  183. package/dist/endpoints/scale/addon.js +0 -36
  184. package/dist/endpoints/scale/service.d.ts +0 -26
  185. package/dist/endpoints/scale/service.js +0 -36
  186. package/dist/endpoints/start/job/build.d.ts +0 -37
  187. package/dist/endpoints/start/job/build.js +0 -36
  188. package/dist/endpoints/start/job/run.d.ts +0 -37
  189. package/dist/endpoints/start/job/run.js +0 -36
  190. package/dist/endpoints/start/service/build.d.ts +0 -41
  191. package/dist/endpoints/start/service/build.js +0 -36
  192. package/dist/endpoints/unassign/subdomain.d.ts +0 -19
  193. package/dist/endpoints/unassign/subdomain.js +0 -36
  194. package/dist/endpoints/update/addon/networkSettings.d.ts +0 -26
  195. package/dist/endpoints/update/addon/networkSettings.js +0 -36
  196. package/dist/endpoints/update/addon/security.d.ts +0 -29
  197. package/dist/endpoints/update/addon/security.js +0 -36
  198. package/dist/endpoints/update/addon/version.d.ts +0 -24
  199. package/dist/endpoints/update/addon/version.js +0 -36
  200. package/dist/endpoints/update/job/buildArguments.d.ts +0 -24
  201. package/dist/endpoints/update/job/buildArguments.js +0 -36
  202. package/dist/endpoints/update/job/cmdOverride.d.ts +0 -24
  203. package/dist/endpoints/update/job/cmdOverride.js +0 -36
  204. package/dist/endpoints/update/job/deployment.d.ts +0 -37
  205. package/dist/endpoints/update/job/deployment.js +0 -36
  206. package/dist/endpoints/update/job/environment.d.ts +0 -24
  207. package/dist/endpoints/update/job/environment.js +0 -36
  208. package/dist/endpoints/update/job/healthChecks.d.ts +0 -45
  209. package/dist/endpoints/update/job/healthChecks.js +0 -36
  210. package/dist/endpoints/update/job/settings.d.ts +0 -30
  211. package/dist/endpoints/update/job/settings.js +0 -36
  212. package/dist/endpoints/update/registryCredentials.d.ts +0 -31
  213. package/dist/endpoints/update/registryCredentials.js +0 -36
  214. package/dist/endpoints/update/secret.d.ts +0 -54
  215. package/dist/endpoints/update/secret.js +0 -36
  216. package/dist/endpoints/update/secretLink.d.ts +0 -40
  217. package/dist/endpoints/update/secretLink.js +0 -36
  218. package/dist/endpoints/update/service/buildArguments.d.ts +0 -24
  219. package/dist/endpoints/update/service/buildArguments.js +0 -36
  220. package/dist/endpoints/update/service/buildOptions.d.ts +0 -52
  221. package/dist/endpoints/update/service/buildOptions.js +0 -36
  222. package/dist/endpoints/update/service/cmdOverride.d.ts +0 -24
  223. package/dist/endpoints/update/service/cmdOverride.js +0 -36
  224. package/dist/endpoints/update/service/deployment.d.ts +0 -37
  225. package/dist/endpoints/update/service/deployment.js +0 -36
  226. package/dist/endpoints/update/service/environmentVariables.d.ts +0 -29
  227. package/dist/endpoints/update/service/environmentVariables.js +0 -36
  228. package/dist/endpoints/update/service/healthChecks.d.ts +0 -45
  229. package/dist/endpoints/update/service/healthChecks.js +0 -36
  230. package/dist/endpoints/update/service/ports.d.ts +0 -55
  231. package/dist/endpoints/update/service/ports.js +0 -36
  232. package/dist/endpoints/verify/domain.d.ts +0 -17
  233. package/dist/endpoints/verify/domain.js +0 -36
  234. package/dist/endpoints/verify/subdomain.d.ts +0 -19
  235. package/dist/endpoints/verify/subdomain.js +0 -36
  236. package/dist/port-forward/client/api-helper.d.ts +0 -30
  237. package/dist/port-forward/client/api-helper.js +0 -102
  238. package/dist/port-forward/client/atomic-write.d.ts +0 -3
  239. package/dist/port-forward/client/atomic-write.js +0 -95
  240. package/dist/port-forward/client/host-file-ast.d.ts +0 -52
  241. package/dist/port-forward/client/host-file-ast.js +0 -279
  242. package/dist/port-forward/client/host-file.d.ts +0 -26
  243. package/dist/port-forward/client/host-file.js +0 -226
  244. package/dist/port-forward/client/loopback.d.ts +0 -4
  245. package/dist/port-forward/client/loopback.js +0 -219
  246. package/dist/port-forward/client/port-forwarder.d.ts +0 -86
  247. package/dist/port-forward/client/port-forwarder.js +0 -593
  248. package/dist/port-forward/client/port-tunnel-tcp.d.ts +0 -34
  249. package/dist/port-forward/client/port-tunnel-tcp.js +0 -209
  250. package/dist/port-forward/client/port-tunnel-udp.d.ts +0 -25
  251. package/dist/port-forward/client/port-tunnel-udp.js +0 -147
  252. package/dist/port-forward/client/port-tunnel.d.ts +0 -32
  253. package/dist/port-forward/client/port-tunnel.js +0 -2
  254. package/dist/port-forward/client/promise-mutex.d.ts +0 -4
  255. package/dist/port-forward/client/promise-mutex.js +0 -62
  256. package/dist/utils.d.ts +0 -8
  257. package/dist/utils.js +0 -97
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateRegistrycredentialsEndpoint = void 0;
20
- var api_endpoint_1 = require("../../api-endpoint");
21
- /** Updates a set of registry credential data. */
22
- var UpdateRegistrycredentialsEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateRegistrycredentialsEndpoint, _super);
24
- function UpdateRegistrycredentialsEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Updates a set of registry credential data.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/registry-credentials/" + opts.parameters.credentialId + "/modify";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateRegistrycredentialsEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateRegistrycredentialsEndpoint = UpdateRegistrycredentialsEndpoint;
@@ -1,54 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
3
- export declare type UpdateSecretResult = any;
4
- export declare type UpdateSecretCall = (opts: UpdateSecretRequest) => Promise<ApiCallResponse<UpdateSecretResult>>;
5
- export declare type UpdateSecretRequest = {
6
- parameters: UpdateSecretParameters;
7
- data: UpdateSecretData;
8
- };
9
- export declare type UpdateSecretParameters = {
10
- /** ID of the project */ 'projectId': string;
11
- /** ID of the secret */
12
- 'secretId': string;
13
- };
14
- export declare type UpdateSecretData = {
15
- /** A description of the secret. Example: "A description" */
16
- 'description'?: string;
17
- /** The priority with which different secrets will be merged. Example: 10 */
18
- 'priority'?: number;
19
- /** Restriction settings of the secret */
20
- 'restrictions'?: {
21
- /** Is the secret restricted Example: true */
22
- 'restricted'?: boolean;
23
- /** List of Northflank services & jobs the secret is restricted to */
24
- 'nfObjects'?: {
25
- /** ID of the entity the secret is restricted to. Example: "example-service" */
26
- 'id': string;
27
- /** Type of the entity the secret is restricted to. Example: "service" */
28
- 'type': 'service' | 'job';
29
- }[];
30
- };
31
- /** An array of addons to link to this secret group. If provided, this will overwrite any existing linked addons. */
32
- 'addonDependencies'?: {
33
- /** The internal id of the addon to link. Example: "example-addon" */
34
- 'addonId': string;
35
- /** An array of objects containing details about the keys to link to this secret group. */
36
- 'keys': {
37
- /** The name of the key to link. Example: "username" */
38
- 'keyName': string;
39
- /** An array of aliases for the key. */
40
- 'aliases'?: string[];
41
- }[];
42
- }[];
43
- /** The type of the created secret Example: "environment" */
44
- 'secretType'?: 'environment' | 'arguments';
45
- /** Secret contents as JSON object, encrypted at rest Example: {"NODE_ENV":"production","MONGO_DB":"some_connection_string"} */
46
- 'data'?: any;
47
- };
48
- /** Update a secret */
49
- export declare class UpdateSecretEndpoint extends PostApiEndpoint<UpdateSecretRequest, UpdateSecretResult> {
50
- description: string;
51
- withAuth: boolean;
52
- endpointUrl: (opts: UpdateSecretRequest) => string;
53
- body: (payload: UpdateSecretRequest) => string;
54
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateSecretEndpoint = void 0;
20
- var api_endpoint_1 = require("../../api-endpoint");
21
- /** Update a secret */
22
- var UpdateSecretEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateSecretEndpoint, _super);
24
- function UpdateSecretEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Update a secret';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/secrets/" + opts.parameters.secretId;
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateSecretEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateSecretEndpoint = UpdateSecretEndpoint;
@@ -1,40 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
3
- export declare type UpdateSecretlinkResult = {
4
- /** An array of objects containing details about the keys linked to this secret group. */
5
- 'keys': {
6
- /** The name of the key to link. Example: "username" */
7
- 'keyName': string;
8
- /** An array of aliases for the key. */
9
- 'aliases'?: string[];
10
- 'defaultKey': string;
11
- }[];
12
- };
13
- export declare type UpdateSecretlinkCall = (opts: UpdateSecretlinkRequest) => Promise<ApiCallResponse<UpdateSecretlinkResult>>;
14
- export declare type UpdateSecretlinkRequest = {
15
- parameters: UpdateSecretlinkParameters;
16
- data: UpdateSecretlinkData;
17
- };
18
- export declare type UpdateSecretlinkParameters = {
19
- /** ID of the project */ 'projectId': string;
20
- /** ID of the secret */
21
- 'secretId': string;
22
- /** ID of the addon */
23
- 'addonId': string;
24
- };
25
- export declare type UpdateSecretlinkData = {
26
- /** An array of objects containing details about the keys to link to this secret group. */
27
- 'keys': {
28
- /** The name of the key to link. Example: "username" */
29
- 'keyName': string;
30
- /** An array of aliases for the key. */
31
- 'aliases'?: string[];
32
- }[];
33
- };
34
- /** Link an addon to the secret group or edit the settings of the linked addon. */
35
- export declare class UpdateSecretlinkEndpoint extends PostApiEndpoint<UpdateSecretlinkRequest, UpdateSecretlinkResult> {
36
- description: string;
37
- withAuth: boolean;
38
- endpointUrl: (opts: UpdateSecretlinkRequest) => string;
39
- body: (payload: UpdateSecretlinkRequest) => string;
40
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateSecretlinkEndpoint = void 0;
20
- var api_endpoint_1 = require("../../api-endpoint");
21
- /** Link an addon to the secret group or edit the settings of the linked addon. */
22
- var UpdateSecretlinkEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateSecretlinkEndpoint, _super);
24
- function UpdateSecretlinkEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Link an addon to the secret group or edit the settings of the linked addon.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/secrets/" + opts.parameters.secretId + "/addons/" + opts.parameters.addonId;
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateSecretlinkEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateSecretlinkEndpoint = UpdateSecretlinkEndpoint;
@@ -1,24 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
3
- export declare type UpdateServiceBuildargumentsResult = any;
4
- export declare type UpdateServiceBuildargumentsCall = (opts: UpdateServiceBuildargumentsRequest) => Promise<ApiCallResponse<UpdateServiceBuildargumentsResult>>;
5
- export declare type UpdateServiceBuildargumentsRequest = {
6
- parameters: UpdateServiceBuildargumentsParameters;
7
- data: UpdateServiceBuildargumentsData;
8
- };
9
- export declare type UpdateServiceBuildargumentsParameters = {
10
- /** ID of the project */ 'projectId': string;
11
- /** ID of the service */
12
- 'serviceId': string;
13
- };
14
- export declare type UpdateServiceBuildargumentsData = {
15
- /** An object containing the all of the build arguments to set for the service Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
16
- 'buildParameters': any;
17
- };
18
- /** Sets the build arguments for the given service. */
19
- export declare class UpdateServiceBuildargumentsEndpoint extends PostApiEndpoint<UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult> {
20
- description: string;
21
- withAuth: boolean;
22
- endpointUrl: (opts: UpdateServiceBuildargumentsRequest) => string;
23
- body: (payload: UpdateServiceBuildargumentsRequest) => string;
24
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateServiceBuildargumentsEndpoint = void 0;
20
- var api_endpoint_1 = require("../../../api-endpoint");
21
- /** Sets the build arguments for the given service. */
22
- var UpdateServiceBuildargumentsEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateServiceBuildargumentsEndpoint, _super);
24
- function UpdateServiceBuildargumentsEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Sets the build arguments for the given service.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/services/" + opts.parameters.serviceId + "/build-arguments";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateServiceBuildargumentsEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateServiceBuildargumentsEndpoint = UpdateServiceBuildargumentsEndpoint;
@@ -1,52 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
3
- export declare type UpdateServiceBuildoptionsResult = any;
4
- export declare type UpdateServiceBuildoptionsCall = (opts: UpdateServiceBuildoptionsRequest) => Promise<ApiCallResponse<UpdateServiceBuildoptionsResult>>;
5
- export declare type UpdateServiceBuildoptionsRequest = {
6
- parameters: UpdateServiceBuildoptionsParameters;
7
- data: UpdateServiceBuildoptionsData;
8
- };
9
- export declare type UpdateServiceBuildoptionsParameters = {
10
- /** ID of the project */ 'projectId': string;
11
- /** ID of the service */
12
- 'serviceId': string;
13
- };
14
- export declare type UpdateServiceBuildoptionsData = {
15
- 'dockerfile': {
16
- /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
17
- 'buildEngine'?: 'kaniko' | 'buildkit';
18
- /** The file path of the Dockerfile. Example: "/Dockerfile" */
19
- 'dockerFilePath'?: string;
20
- /** The working directory of the Dockerfile. Example: "/" */
21
- 'dockerWorkDir'?: string;
22
- };
23
- /** An array of pull request build rules. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
24
- 'prRestrictions'?: string[];
25
- /** An array of branch build rules. Each commit belonging to a branch that matches one of the provided build rules will be built automatically. */
26
- 'branchRestrictions'?: string[];
27
- } | {
28
- 'buildpack': {
29
- /** Buildpack stack to use. Defaults to recommended stack `HEROKU_20`. Example: "HEROKU_20" */
30
- 'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
31
- /** Array of custom buildpacks to use. */
32
- 'buildpackLocators'?: string[];
33
- /** The working directory to build in. Example: "/" */
34
- 'buildContext'?: string;
35
- };
36
- /** An array of pull request build rules. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
37
- 'prRestrictions'?: string[];
38
- /** An array of branch build rules. Each commit belonging to a branch that matches one of the provided build rules will be built automatically. */
39
- 'branchRestrictions'?: string[];
40
- } | {
41
- /** An array of pull request build rules. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
42
- 'prRestrictions'?: string[];
43
- /** An array of branch build rules. Each commit belonging to a branch that matches one of the provided build rules will be built automatically. */
44
- 'branchRestrictions'?: string[];
45
- };
46
- /** Updates the build options for a given service. */
47
- export declare class UpdateServiceBuildoptionsEndpoint extends PostApiEndpoint<UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult> {
48
- description: string;
49
- withAuth: boolean;
50
- endpointUrl: (opts: UpdateServiceBuildoptionsRequest) => string;
51
- body: (payload: UpdateServiceBuildoptionsRequest) => string;
52
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateServiceBuildoptionsEndpoint = void 0;
20
- var api_endpoint_1 = require("../../../api-endpoint");
21
- /** Updates the build options for a given service. */
22
- var UpdateServiceBuildoptionsEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateServiceBuildoptionsEndpoint, _super);
24
- function UpdateServiceBuildoptionsEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Updates the build options for a given service.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/services/" + opts.parameters.serviceId + "/build-options";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateServiceBuildoptionsEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateServiceBuildoptionsEndpoint = UpdateServiceBuildoptionsEndpoint;
@@ -1,24 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
3
- export declare type UpdateServiceCmdoverrideResult = any;
4
- export declare type UpdateServiceCmdoverrideCall = (opts: UpdateServiceCmdoverrideRequest) => Promise<ApiCallResponse<UpdateServiceCmdoverrideResult>>;
5
- export declare type UpdateServiceCmdoverrideRequest = {
6
- parameters: UpdateServiceCmdoverrideParameters;
7
- data: UpdateServiceCmdoverrideData;
8
- };
9
- export declare type UpdateServiceCmdoverrideParameters = {
10
- /** ID of the project */ 'projectId': string;
11
- /** ID of the service */
12
- 'serviceId': string;
13
- };
14
- export declare type UpdateServiceCmdoverrideData = {
15
- /** The CMD to run, or null to disable the override. Example: "nginx -g" */
16
- 'cmd': string;
17
- };
18
- /** Sets the Docker CMD override for the given service. */
19
- export declare class UpdateServiceCmdoverrideEndpoint extends PostApiEndpoint<UpdateServiceCmdoverrideRequest, UpdateServiceCmdoverrideResult> {
20
- description: string;
21
- withAuth: boolean;
22
- endpointUrl: (opts: UpdateServiceCmdoverrideRequest) => string;
23
- body: (payload: UpdateServiceCmdoverrideRequest) => string;
24
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateServiceCmdoverrideEndpoint = void 0;
20
- var api_endpoint_1 = require("../../../api-endpoint");
21
- /** Sets the Docker CMD override for the given service. */
22
- var UpdateServiceCmdoverrideEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateServiceCmdoverrideEndpoint, _super);
24
- function UpdateServiceCmdoverrideEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Sets the Docker CMD override for the given service.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/services/" + opts.parameters.serviceId + "/cmd-override";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateServiceCmdoverrideEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateServiceCmdoverrideEndpoint = UpdateServiceCmdoverrideEndpoint;
@@ -1,37 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
3
- export declare type UpdateServiceDeploymentResult = any;
4
- export declare type UpdateServiceDeploymentCall = (opts: UpdateServiceDeploymentRequest) => Promise<ApiCallResponse<UpdateServiceDeploymentResult>>;
5
- export declare type UpdateServiceDeploymentRequest = {
6
- parameters: UpdateServiceDeploymentParameters;
7
- data: UpdateServiceDeploymentData;
8
- };
9
- export declare type UpdateServiceDeploymentParameters = {
10
- /** ID of the project */ 'projectId': string;
11
- /** ID of the service */
12
- 'serviceId': string;
13
- };
14
- export declare type UpdateServiceDeploymentData = {
15
- 'external': {
16
- /** Path of the external image excluding the hostname Example: "nginx:latest" */
17
- 'imagePath': string;
18
- /** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
19
- 'credentials'?: string;
20
- };
21
- } | {
22
- 'internal': {
23
- /** ID of the build service to deploy Example: "example-build-service" */
24
- 'id'?: string;
25
- /** Branch to deploy Example: "master" */
26
- 'branch'?: string;
27
- /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
28
- 'buildSHA'?: any;
29
- };
30
- };
31
- /** Updates the deployment settings of the given service. */
32
- export declare class UpdateServiceDeploymentEndpoint extends PostApiEndpoint<UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult> {
33
- description: string;
34
- withAuth: boolean;
35
- endpointUrl: (opts: UpdateServiceDeploymentRequest) => string;
36
- body: (payload: UpdateServiceDeploymentRequest) => string;
37
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateServiceDeploymentEndpoint = void 0;
20
- var api_endpoint_1 = require("../../../api-endpoint");
21
- /** Updates the deployment settings of the given service. */
22
- var UpdateServiceDeploymentEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateServiceDeploymentEndpoint, _super);
24
- function UpdateServiceDeploymentEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Updates the deployment settings of the given service.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/services/" + opts.parameters.serviceId + "/deployment";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateServiceDeploymentEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateServiceDeploymentEndpoint = UpdateServiceDeploymentEndpoint;
@@ -1,29 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
3
- export declare type UpdateServiceEnvironmentvariablesResult = {
4
- /** True if the operation was successful. Example: true */
5
- 'success': boolean;
6
- /** Did the service successfully restart with the new environment variables? Example: true */
7
- 'restartSuccessful': boolean;
8
- };
9
- export declare type UpdateServiceEnvironmentvariablesCall = (opts: UpdateServiceEnvironmentvariablesRequest) => Promise<ApiCallResponse<UpdateServiceEnvironmentvariablesResult>>;
10
- export declare type UpdateServiceEnvironmentvariablesRequest = {
11
- parameters: UpdateServiceEnvironmentvariablesParameters;
12
- data: UpdateServiceEnvironmentvariablesData;
13
- };
14
- export declare type UpdateServiceEnvironmentvariablesParameters = {
15
- /** ID of the project */ 'projectId': string;
16
- /** ID of the service */
17
- 'serviceId': string;
18
- };
19
- export declare type UpdateServiceEnvironmentvariablesData = {
20
- /** An object containing the all of the environment variables to set for the service Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
21
- 'runtimeEnvironment': any;
22
- };
23
- /** Sets the environment variables for the given service. */
24
- export declare class UpdateServiceEnvironmentvariablesEndpoint extends PostApiEndpoint<UpdateServiceEnvironmentvariablesRequest, UpdateServiceEnvironmentvariablesResult> {
25
- description: string;
26
- withAuth: boolean;
27
- endpointUrl: (opts: UpdateServiceEnvironmentvariablesRequest) => string;
28
- body: (payload: UpdateServiceEnvironmentvariablesRequest) => string;
29
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateServiceEnvironmentvariablesEndpoint = void 0;
20
- var api_endpoint_1 = require("../../../api-endpoint");
21
- /** Sets the environment variables for the given service. */
22
- var UpdateServiceEnvironmentvariablesEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateServiceEnvironmentvariablesEndpoint, _super);
24
- function UpdateServiceEnvironmentvariablesEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Sets the environment variables for the given service.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/services/" + opts.parameters.serviceId + "/environment";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateServiceEnvironmentvariablesEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateServiceEnvironmentvariablesEndpoint = UpdateServiceEnvironmentvariablesEndpoint;
@@ -1,45 +0,0 @@
1
- /** WARNING: Autogenerated Code - do not modify! */
2
- import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
3
- export declare type UpdateServiceHealthchecksResult = any;
4
- export declare type UpdateServiceHealthchecksCall = (opts: UpdateServiceHealthchecksRequest) => Promise<ApiCallResponse<UpdateServiceHealthchecksResult>>;
5
- export declare type UpdateServiceHealthchecksRequest = {
6
- parameters: UpdateServiceHealthchecksParameters;
7
- data: UpdateServiceHealthchecksData;
8
- };
9
- export declare type UpdateServiceHealthchecksParameters = {
10
- /** ID of the project */ 'projectId': string;
11
- /** ID of the service */
12
- 'serviceId': string;
13
- };
14
- export declare type UpdateServiceHealthchecksData = {
15
- /** An array of health checks */
16
- 'healthChecks': {
17
- /** The protocol to access the health check with. Example: "HTTP" */
18
- 'protocol': 'HTTP' | 'CMD';
19
- /** The type of health check. Example: "readinessProbe" */
20
- 'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
21
- /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
22
- 'path'?: string;
23
- /** The command to run for the health check. Required when protocol is CMD */
24
- 'cmd'?: string;
25
- /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
26
- 'port'?: number;
27
- /** Initial delay, in seconds, before the health check is first run. Example: 10 */
28
- 'initialDelaySeconds': number;
29
- /** The time between each check, in seconds. Example: 60 */
30
- 'periodSeconds': number;
31
- /** The time to wait for a response before marking the health check as a failure. Example: 1 */
32
- 'timeoutSeconds': number;
33
- /** The maximum number of allowed failures. Example: 3 */
34
- 'failureThreshold': number;
35
- /** The number of successes required to mark the health check as a success. Example: 1 */
36
- 'successThreshold'?: number;
37
- }[];
38
- };
39
- /** Updates health checks for the given service. */
40
- export declare class UpdateServiceHealthchecksEndpoint extends PostApiEndpoint<UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult> {
41
- description: string;
42
- withAuth: boolean;
43
- endpointUrl: (opts: UpdateServiceHealthchecksRequest) => string;
44
- body: (payload: UpdateServiceHealthchecksRequest) => string;
45
- }
@@ -1,36 +0,0 @@
1
- "use strict";
2
- /** WARNING: Autogenerated Code - do not modify! */
3
- var __extends = (this && this.__extends) || (function () {
4
- var extendStatics = function (d, b) {
5
- extendStatics = Object.setPrototypeOf ||
6
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
7
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
8
- return extendStatics(d, b);
9
- };
10
- return function (d, b) {
11
- if (typeof b !== "function" && b !== null)
12
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
13
- extendStatics(d, b);
14
- function __() { this.constructor = d; }
15
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
16
- };
17
- })();
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.UpdateServiceHealthchecksEndpoint = void 0;
20
- var api_endpoint_1 = require("../../../api-endpoint");
21
- /** Updates health checks for the given service. */
22
- var UpdateServiceHealthchecksEndpoint = /** @class */ (function (_super) {
23
- __extends(UpdateServiceHealthchecksEndpoint, _super);
24
- function UpdateServiceHealthchecksEndpoint() {
25
- var _this = _super !== null && _super.apply(this, arguments) || this;
26
- _this.description = 'Updates health checks for the given service.';
27
- _this.withAuth = true;
28
- _this.endpointUrl = function (opts) {
29
- return "/v1/projects/" + opts.parameters.projectId + "/services/" + opts.parameters.serviceId + "/health-checks";
30
- };
31
- _this.body = function (payload) { return JSON.stringify(payload.data); };
32
- return _this;
33
- }
34
- return UpdateServiceHealthchecksEndpoint;
35
- }(api_endpoint_1.PostApiEndpoint));
36
- exports.UpdateServiceHealthchecksEndpoint = UpdateServiceHealthchecksEndpoint;