@devopness/sdk-js 2.16.0 → 2.18.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 (47) hide show
  1. package/dist/api/generated/apis/applications-sslcertificates-api.d.ts +6 -6
  2. package/dist/api/generated/apis/applications-sslcertificates-api.js +8 -8
  3. package/dist/api/generated/apis/applications-variables-api.d.ts +7 -6
  4. package/dist/api/generated/apis/applications-variables-api.js +7 -7
  5. package/dist/api/generated/apis/daemons-api.d.ts +10 -10
  6. package/dist/api/generated/apis/daemons-api.js +10 -10
  7. package/dist/api/generated/apis/environments-daemons-api.d.ts +11 -2
  8. package/dist/api/generated/apis/environments-daemons-api.js +22 -2
  9. package/dist/api/generated/apis/environments-network-rules-api.d.ts +2 -2
  10. package/dist/api/generated/apis/environments-network-rules-api.js +2 -2
  11. package/dist/api/generated/apis/environments-servers-api.d.ts +9 -0
  12. package/dist/api/generated/apis/environments-servers-api.js +25 -0
  13. package/dist/api/generated/apis/network-rules-api.d.ts +7 -7
  14. package/dist/api/generated/apis/network-rules-api.js +7 -7
  15. package/dist/api/generated/apis/projects-daemons-api.d.ts +7 -7
  16. package/dist/api/generated/apis/projects-daemons-api.js +10 -10
  17. package/dist/api/generated/apis/projects-network-rules-api.d.ts +6 -6
  18. package/dist/api/generated/apis/projects-network-rules-api.js +8 -8
  19. package/dist/api/generated/apis/sshkeys-api.d.ts +4 -4
  20. package/dist/api/generated/apis/sshkeys-api.js +4 -4
  21. package/dist/api/generated/apis/sslcertificates-api.d.ts +3 -3
  22. package/dist/api/generated/apis/sslcertificates-api.js +3 -3
  23. package/dist/api/generated/apis/variables-api.d.ts +4 -4
  24. package/dist/api/generated/apis/variables-api.js +4 -4
  25. package/dist/api/generated/models/daemon-create.d.ts +13 -20
  26. package/dist/api/generated/models/daemon-project-create.d.ts +61 -0
  27. package/dist/api/generated/models/daemon-project-create.js +14 -0
  28. package/dist/api/generated/models/daemon-relation.d.ts +13 -13
  29. package/dist/api/generated/models/daemon-restart.d.ts +1 -1
  30. package/dist/api/generated/models/daemon-update.d.ts +13 -19
  31. package/dist/api/generated/models/daemon.d.ts +23 -17
  32. package/dist/api/generated/models/index.d.ts +2 -0
  33. package/dist/api/generated/models/index.js +2 -0
  34. package/dist/api/generated/models/network-rule-create.d.ts +8 -8
  35. package/dist/api/generated/models/network-rule-relation.d.ts +21 -15
  36. package/dist/api/generated/models/network-rule-update.d.ts +7 -7
  37. package/dist/api/generated/models/network-rule.d.ts +23 -17
  38. package/dist/api/generated/models/ssh-key-update.d.ts +3 -4
  39. package/dist/api/generated/models/ssl-certificate-create.d.ts +9 -9
  40. package/dist/api/generated/models/ssl-certificate-relation.d.ts +24 -30
  41. package/dist/api/generated/models/ssl-certificate.d.ts +41 -40
  42. package/dist/api/generated/models/variable-create.d.ts +16 -4
  43. package/dist/api/generated/models/variable-relation.d.ts +92 -0
  44. package/dist/api/generated/models/variable-relation.js +14 -0
  45. package/dist/api/generated/models/variable-update.d.ts +4 -10
  46. package/dist/api/generated/models/variable.d.ts +30 -12
  47. package/package.json +1 -1
@@ -20,15 +20,15 @@ import { SslCertificateRelation } from '../../generated/models';
20
20
  export declare class ApplicationsSSLCertificatesApiService extends ApiBaseService {
21
21
  /**
22
22
  *
23
- * @summary Create a new SSL certificate linked to the current application
24
- * @param {number} applicationId Unique id of the parent application
25
- * @param {SslCertificateCreate} sslCertificateCreate A JSON object containing data for creating a new record of SSL certificate
23
+ * @summary Add a new SSL certificate to the current application
24
+ * @param {number} applicationId The ID of the application.
25
+ * @param {SslCertificateCreate} sslCertificateCreate A JSON object containing the resource data
26
26
  */
27
- addSslCertificateToApplication(applicationId: number, sslCertificateCreate: SslCertificateCreate): Promise<ApiResponse<SslCertificate>>;
27
+ addApplicationSslCertificate(applicationId: number, sslCertificateCreate: SslCertificateCreate): Promise<ApiResponse<SslCertificate>>;
28
28
  /**
29
29
  *
30
- * @summary Returns a list of SSL certificates issued to an application
31
- * @param {number} applicationId Unique ID of the application to retrieve SSL Certificates from
30
+ * @summary Return a list of SSL certificates issued to an application
31
+ * @param {number} applicationId The ID of the application.
32
32
  * @param {number} [page] Number of the page to be retrieved
33
33
  * @param {number} [perPage] Number of items returned per page
34
34
  */
@@ -31,17 +31,17 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class ApplicationsSSLCertificatesApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Create a new SSL certificate linked to the current application
35
- * @param {number} applicationId Unique id of the parent application
36
- * @param {SslCertificateCreate} sslCertificateCreate A JSON object containing data for creating a new record of SSL certificate
34
+ * @summary Add a new SSL certificate to the current application
35
+ * @param {number} applicationId The ID of the application.
36
+ * @param {SslCertificateCreate} sslCertificateCreate A JSON object containing the resource data
37
37
  */
38
- addSslCertificateToApplication(applicationId, sslCertificateCreate) {
38
+ addApplicationSslCertificate(applicationId, sslCertificateCreate) {
39
39
  return __awaiter(this, void 0, void 0, function* () {
40
40
  if (applicationId === null || applicationId === undefined) {
41
- throw new Exceptions_1.ArgumentNullException('applicationId', 'addSslCertificateToApplication');
41
+ throw new Exceptions_1.ArgumentNullException('applicationId', 'addApplicationSslCertificate');
42
42
  }
43
43
  if (sslCertificateCreate === null || sslCertificateCreate === undefined) {
44
- throw new Exceptions_1.ArgumentNullException('sslCertificateCreate', 'addSslCertificateToApplication');
44
+ throw new Exceptions_1.ArgumentNullException('sslCertificateCreate', 'addApplicationSslCertificate');
45
45
  }
46
46
  let queryString = '';
47
47
  const requestUrl = '/applications/{application_id}/ssl-certificates' + (queryString ? `?${queryString}` : '');
@@ -51,8 +51,8 @@ class ApplicationsSSLCertificatesApiService extends ApiBaseService_1.ApiBaseServ
51
51
  }
52
52
  /**
53
53
  *
54
- * @summary Returns a list of SSL certificates issued to an application
55
- * @param {number} applicationId Unique ID of the application to retrieve SSL Certificates from
54
+ * @summary Return a list of SSL certificates issued to an application
55
+ * @param {number} applicationId The ID of the application.
56
56
  * @param {number} [page] Number of the page to be retrieved
57
57
  * @param {number} [perPage] Number of items returned per page
58
58
  */
@@ -13,6 +13,7 @@ import { ApiBaseService } from "../../../services/ApiBaseService";
13
13
  import { ApiResponse } from "../../../common/ApiResponse";
14
14
  import { Variable } from '../../generated/models';
15
15
  import { VariableCreate } from '../../generated/models';
16
+ import { VariableRelation } from '../../generated/models';
16
17
  /**
17
18
  * ApplicationsVariablesApiService - Auto-generated
18
19
  */
@@ -20,16 +21,16 @@ export declare class ApplicationsVariablesApiService extends ApiBaseService {
20
21
  /**
21
22
  *
22
23
  * @summary Create a new variable linked to an application
23
- * @param {number} applicationId Unique id of the application
24
- * @param {VariableCreate} variableCreate A JSON object containing application variable data
24
+ * @param {number} applicationId The ID of the application.
25
+ * @param {VariableCreate} variableCreate A JSON object containing the resource data
25
26
  */
26
- addVariableToApplication(applicationId: number, variableCreate: VariableCreate): Promise<ApiResponse<Variable>>;
27
+ addApplicationVariable(applicationId: number, variableCreate: VariableCreate): Promise<ApiResponse<Variable>>;
27
28
  /**
28
29
  *
29
- * @summary Returns a list of variables belonging to an application
30
- * @param {number} applicationId Unique ID of the application to retrieve variables from
30
+ * @summary Return a list of variables belonging to an application
31
+ * @param {number} applicationId The ID of the application.
31
32
  * @param {number} [page] Number of the page to be retrieved
32
33
  * @param {number} [perPage] Number of items returned per page
33
34
  */
34
- listApplicationVariables(applicationId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<Variable>>>;
35
+ listApplicationVariables(applicationId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<VariableRelation>>>;
35
36
  }
@@ -32,16 +32,16 @@ class ApplicationsVariablesApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
34
  * @summary Create a new variable linked to an application
35
- * @param {number} applicationId Unique id of the application
36
- * @param {VariableCreate} variableCreate A JSON object containing application variable data
35
+ * @param {number} applicationId The ID of the application.
36
+ * @param {VariableCreate} variableCreate A JSON object containing the resource data
37
37
  */
38
- addVariableToApplication(applicationId, variableCreate) {
38
+ addApplicationVariable(applicationId, variableCreate) {
39
39
  return __awaiter(this, void 0, void 0, function* () {
40
40
  if (applicationId === null || applicationId === undefined) {
41
- throw new Exceptions_1.ArgumentNullException('applicationId', 'addVariableToApplication');
41
+ throw new Exceptions_1.ArgumentNullException('applicationId', 'addApplicationVariable');
42
42
  }
43
43
  if (variableCreate === null || variableCreate === undefined) {
44
- throw new Exceptions_1.ArgumentNullException('variableCreate', 'addVariableToApplication');
44
+ throw new Exceptions_1.ArgumentNullException('variableCreate', 'addApplicationVariable');
45
45
  }
46
46
  let queryString = '';
47
47
  const requestUrl = '/applications/{application_id}/variables' + (queryString ? `?${queryString}` : '');
@@ -51,8 +51,8 @@ class ApplicationsVariablesApiService extends ApiBaseService_1.ApiBaseService {
51
51
  }
52
52
  /**
53
53
  *
54
- * @summary Returns a list of variables belonging to an application
55
- * @param {number} applicationId Unique ID of the application to retrieve variables from
54
+ * @summary Return a list of variables belonging to an application
55
+ * @param {number} applicationId The ID of the application.
56
56
  * @param {number} [page] Number of the page to be retrieved
57
57
  * @param {number} [perPage] Number of items returned per page
58
58
  */
@@ -20,28 +20,28 @@ import { DaemonUpdate } from '../../generated/models';
20
20
  export declare class DaemonsApiService extends ApiBaseService {
21
21
  /**
22
22
  *
23
- * @summary Delete a given Background process
24
- * @param {number} daemonId Numeric ID of the daemon to be deleted
23
+ * @summary Delete a given Daemon
24
+ * @param {number} daemonId The ID of the daemon.
25
25
  */
26
26
  deleteDaemon(daemonId: number): Promise<ApiResponse<void>>;
27
27
  /**
28
28
  *
29
- * @summary Get a background process by ID
30
- * @param {number} daemonId Numeric ID of the daemon to get
29
+ * @summary Get a Daemon by ID
30
+ * @param {number} daemonId The ID of the daemon.
31
31
  */
32
32
  getDaemon(daemonId: number): Promise<ApiResponse<Daemon>>;
33
33
  /**
34
34
  *
35
- * @summary Restart a background process
36
- * @param {number} daemonId Numeric ID of the daemon to restart
37
- * @param {DaemonRestart} daemonRestart A JSON object containing the environment id
35
+ * @summary Restart a Daemon
36
+ * @param {number} daemonId The ID of the daemon.
37
+ * @param {DaemonRestart} daemonRestart A JSON object containing the resource data
38
38
  */
39
39
  restartDaemon(daemonId: number, daemonRestart: DaemonRestart): Promise<ApiResponse<void>>;
40
40
  /**
41
41
  *
42
- * @summary Update an existing background process
43
- * @param {number} daemonId Numeric ID of the daemon to update
44
- * @param {DaemonUpdate} daemonUpdate A JSON object containing daemon data
42
+ * @summary Update an existing Daemon
43
+ * @param {number} daemonId The ID of the daemon.
44
+ * @param {DaemonUpdate} daemonUpdate A JSON object containing the resource data
45
45
  */
46
46
  updateDaemon(daemonId: number, daemonUpdate: DaemonUpdate): Promise<ApiResponse<void>>;
47
47
  }
@@ -31,8 +31,8 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class DaemonsApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Delete a given Background process
35
- * @param {number} daemonId Numeric ID of the daemon to be deleted
34
+ * @summary Delete a given Daemon
35
+ * @param {number} daemonId The ID of the daemon.
36
36
  */
37
37
  deleteDaemon(daemonId) {
38
38
  return __awaiter(this, void 0, void 0, function* () {
@@ -47,8 +47,8 @@ class DaemonsApiService extends ApiBaseService_1.ApiBaseService {
47
47
  }
48
48
  /**
49
49
  *
50
- * @summary Get a background process by ID
51
- * @param {number} daemonId Numeric ID of the daemon to get
50
+ * @summary Get a Daemon by ID
51
+ * @param {number} daemonId The ID of the daemon.
52
52
  */
53
53
  getDaemon(daemonId) {
54
54
  return __awaiter(this, void 0, void 0, function* () {
@@ -63,9 +63,9 @@ class DaemonsApiService extends ApiBaseService_1.ApiBaseService {
63
63
  }
64
64
  /**
65
65
  *
66
- * @summary Restart a background process
67
- * @param {number} daemonId Numeric ID of the daemon to restart
68
- * @param {DaemonRestart} daemonRestart A JSON object containing the environment id
66
+ * @summary Restart a Daemon
67
+ * @param {number} daemonId The ID of the daemon.
68
+ * @param {DaemonRestart} daemonRestart A JSON object containing the resource data
69
69
  */
70
70
  restartDaemon(daemonId, daemonRestart) {
71
71
  return __awaiter(this, void 0, void 0, function* () {
@@ -83,9 +83,9 @@ class DaemonsApiService extends ApiBaseService_1.ApiBaseService {
83
83
  }
84
84
  /**
85
85
  *
86
- * @summary Update an existing background process
87
- * @param {number} daemonId Numeric ID of the daemon to update
88
- * @param {DaemonUpdate} daemonUpdate A JSON object containing daemon data
86
+ * @summary Update an existing Daemon
87
+ * @param {number} daemonId The ID of the daemon.
88
+ * @param {DaemonUpdate} daemonUpdate A JSON object containing the resource data
89
89
  */
90
90
  updateDaemon(daemonId, daemonUpdate) {
91
91
  return __awaiter(this, void 0, void 0, function* () {
@@ -11,6 +11,8 @@
11
11
  */
12
12
  import { ApiBaseService } from "../../../services/ApiBaseService";
13
13
  import { ApiResponse } from "../../../common/ApiResponse";
14
+ import { Daemon } from '../../generated/models';
15
+ import { DaemonCreate } from '../../generated/models';
14
16
  import { DaemonRelation } from '../../generated/models';
15
17
  /**
16
18
  * EnvironmentsDaemonsApiService - Auto-generated
@@ -18,8 +20,15 @@ import { DaemonRelation } from '../../generated/models';
18
20
  export declare class EnvironmentsDaemonsApiService extends ApiBaseService {
19
21
  /**
20
22
  *
21
- * @summary Returns a list of all daemons belonging to a environment
22
- * @param {number} environmentId Numeric ID of the environment to get daemons from
23
+ * @summary Add a Daemon to the given environment
24
+ * @param {number} environmentId The ID of the environment.
25
+ * @param {DaemonCreate} daemonCreate A JSON object containing the resource data
26
+ */
27
+ addEnvironmentDaemon(environmentId: number, daemonCreate: DaemonCreate): Promise<ApiResponse<Daemon>>;
28
+ /**
29
+ *
30
+ * @summary Return a list of all Daemons belonging to an environment
31
+ * @param {number} environmentId The ID of the environment.
23
32
  * @param {number} [page] Number of the page to be retrieved
24
33
  * @param {number} [perPage] Number of items returned per page
25
34
  */
@@ -31,8 +31,28 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class EnvironmentsDaemonsApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Returns a list of all daemons belonging to a environment
35
- * @param {number} environmentId Numeric ID of the environment to get daemons from
34
+ * @summary Add a Daemon to the given environment
35
+ * @param {number} environmentId The ID of the environment.
36
+ * @param {DaemonCreate} daemonCreate A JSON object containing the resource data
37
+ */
38
+ addEnvironmentDaemon(environmentId, daemonCreate) {
39
+ return __awaiter(this, void 0, void 0, function* () {
40
+ if (environmentId === null || environmentId === undefined) {
41
+ throw new Exceptions_1.ArgumentNullException('environmentId', 'addEnvironmentDaemon');
42
+ }
43
+ if (daemonCreate === null || daemonCreate === undefined) {
44
+ throw new Exceptions_1.ArgumentNullException('daemonCreate', 'addEnvironmentDaemon');
45
+ }
46
+ let queryString = '';
47
+ const requestUrl = '/environments/{environment_id}/daemons' + (queryString ? `?${queryString}` : '');
48
+ const response = yield this.post(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))), daemonCreate);
49
+ return new ApiResponse_1.ApiResponse(response);
50
+ });
51
+ }
52
+ /**
53
+ *
54
+ * @summary Return a list of all Daemons belonging to an environment
55
+ * @param {number} environmentId The ID of the environment.
36
56
  * @param {number} [page] Number of the page to be retrieved
37
57
  * @param {number} [perPage] Number of items returned per page
38
58
  */
@@ -18,8 +18,8 @@ import { NetworkRuleRelation } from '../../generated/models';
18
18
  export declare class EnvironmentsNetworkRulesApiService extends ApiBaseService {
19
19
  /**
20
20
  *
21
- * @summary Returns a list of all network rules belonging to a environment
22
- * @param {number} environmentId Numeric ID of the environment to get network rules from
21
+ * @summary Return a list of all Network Rules belonging to an environment
22
+ * @param {number} environmentId The ID of the environment.
23
23
  * @param {number} [page] Number of the page to be retrieved
24
24
  * @param {number} [perPage] Number of items returned per page
25
25
  */
@@ -31,8 +31,8 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class EnvironmentsNetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Returns a list of all network rules belonging to a environment
35
- * @param {number} environmentId Numeric ID of the environment to get network rules from
34
+ * @summary Return a list of all Network Rules belonging to an environment
35
+ * @param {number} environmentId The ID of the environment.
36
36
  * @param {number} [page] Number of the page to be retrieved
37
37
  * @param {number} [perPage] Number of items returned per page
38
38
  */
@@ -14,6 +14,7 @@ import { ApiResponse } from "../../../common/ApiResponse";
14
14
  import { EnvironmentLinkItem } from '../../generated/models';
15
15
  import { Server } from '../../generated/models';
16
16
  import { ServerCreate } from '../../generated/models';
17
+ import { ServerRelation } from '../../generated/models';
17
18
  /**
18
19
  * EnvironmentsServersApiService - Auto-generated
19
20
  */
@@ -33,6 +34,14 @@ export declare class EnvironmentsServersApiService extends ApiBaseService {
33
34
  * @param {EnvironmentLinkItem} [environmentLinkItem] A JSON object containing environment server link optional parameters
34
35
  */
35
36
  linkServerToEnvironment(environmentId: number, serverId: number, environmentLinkItem?: EnvironmentLinkItem): Promise<ApiResponse<void>>;
37
+ /**
38
+ *
39
+ * @summary Return a list of all servers belonging to a environment
40
+ * @param {number} environmentId The ID of the environment.
41
+ * @param {number} [page] Number of the page to be retrieved
42
+ * @param {number} [perPage] Number of items returned per page
43
+ */
44
+ listEnvironmentServers(environmentId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<ServerRelation>>>;
36
45
  /**
37
46
  *
38
47
  * @summary Replace all linked servers by new ones. Immediately deploying all changes to previously and newly linked servers
@@ -70,6 +70,31 @@ class EnvironmentsServersApiService extends ApiBaseService_1.ApiBaseService {
70
70
  return new ApiResponse_1.ApiResponse(response);
71
71
  });
72
72
  }
73
+ /**
74
+ *
75
+ * @summary Return a list of all servers belonging to a environment
76
+ * @param {number} environmentId The ID of the environment.
77
+ * @param {number} [page] Number of the page to be retrieved
78
+ * @param {number} [perPage] Number of items returned per page
79
+ */
80
+ listEnvironmentServers(environmentId, page, perPage) {
81
+ return __awaiter(this, void 0, void 0, function* () {
82
+ if (environmentId === null || environmentId === undefined) {
83
+ throw new Exceptions_1.ArgumentNullException('environmentId', 'listEnvironmentServers');
84
+ }
85
+ let queryString = '';
86
+ const queryParams = { page: page, per_page: perPage, };
87
+ for (const key in queryParams) {
88
+ if (queryParams[key] === undefined || queryParams[key] === null) {
89
+ continue;
90
+ }
91
+ queryString += (queryString ? '&' : '') + `${key}=${encodeURI(queryParams[key])}`;
92
+ }
93
+ const requestUrl = '/environments/{environment_id}/servers' + (queryString ? `?${queryString}` : '');
94
+ const response = yield this.get(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))));
95
+ return new ApiResponse_1.ApiResponse(response);
96
+ });
97
+ }
73
98
  /**
74
99
  *
75
100
  * @summary Replace all linked servers by new ones. Immediately deploying all changes to previously and newly linked servers
@@ -19,21 +19,21 @@ import { NetworkRuleUpdate } from '../../generated/models';
19
19
  export declare class NetworkRulesApiService extends ApiBaseService {
20
20
  /**
21
21
  *
22
- * @summary Delete a given network rule
23
- * @param {number} networkRuleId Numeric ID of the rule to be deleted
22
+ * @summary Delete a given Network Rule
23
+ * @param {number} networkRuleId The ID of the network rule.
24
24
  */
25
25
  deleteNetworkRule(networkRuleId: number): Promise<ApiResponse<void>>;
26
26
  /**
27
27
  *
28
- * @summary Get a network rule by ID
29
- * @param {number} networkRuleId Numeric ID of the rule to get
28
+ * @summary Get a Network Rule by ID
29
+ * @param {number} networkRuleId The ID of the network rule.
30
30
  */
31
31
  getNetworkRule(networkRuleId: number): Promise<ApiResponse<NetworkRule>>;
32
32
  /**
33
33
  *
34
- * @summary Update an existing network rule
35
- * @param {number} networkRuleId Numeric ID of the rule to update
36
- * @param {NetworkRuleUpdate} networkRuleUpdate A JSON object containing network rule data
34
+ * @summary Update an existing Network Rule
35
+ * @param {number} networkRuleId The ID of the network rule.
36
+ * @param {NetworkRuleUpdate} networkRuleUpdate A JSON object containing the resource data
37
37
  */
38
38
  updateNetworkRule(networkRuleId: number, networkRuleUpdate: NetworkRuleUpdate): Promise<ApiResponse<void>>;
39
39
  }
@@ -31,8 +31,8 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class NetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Delete a given network rule
35
- * @param {number} networkRuleId Numeric ID of the rule to be deleted
34
+ * @summary Delete a given Network Rule
35
+ * @param {number} networkRuleId The ID of the network rule.
36
36
  */
37
37
  deleteNetworkRule(networkRuleId) {
38
38
  return __awaiter(this, void 0, void 0, function* () {
@@ -47,8 +47,8 @@ class NetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
47
47
  }
48
48
  /**
49
49
  *
50
- * @summary Get a network rule by ID
51
- * @param {number} networkRuleId Numeric ID of the rule to get
50
+ * @summary Get a Network Rule by ID
51
+ * @param {number} networkRuleId The ID of the network rule.
52
52
  */
53
53
  getNetworkRule(networkRuleId) {
54
54
  return __awaiter(this, void 0, void 0, function* () {
@@ -63,9 +63,9 @@ class NetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
63
63
  }
64
64
  /**
65
65
  *
66
- * @summary Update an existing network rule
67
- * @param {number} networkRuleId Numeric ID of the rule to update
68
- * @param {NetworkRuleUpdate} networkRuleUpdate A JSON object containing network rule data
66
+ * @summary Update an existing Network Rule
67
+ * @param {number} networkRuleId The ID of the network rule.
68
+ * @param {NetworkRuleUpdate} networkRuleUpdate A JSON object containing the resource data
69
69
  */
70
70
  updateNetworkRule(networkRuleId, networkRuleUpdate) {
71
71
  return __awaiter(this, void 0, void 0, function* () {
@@ -12,7 +12,7 @@
12
12
  import { ApiBaseService } from "../../../services/ApiBaseService";
13
13
  import { ApiResponse } from "../../../common/ApiResponse";
14
14
  import { Daemon } from '../../generated/models';
15
- import { DaemonCreate } from '../../generated/models';
15
+ import { DaemonProjectCreate } from '../../generated/models';
16
16
  import { DaemonRelation } from '../../generated/models';
17
17
  /**
18
18
  * ProjectsDaemonsApiService - Auto-generated
@@ -20,15 +20,15 @@ import { DaemonRelation } from '../../generated/models';
20
20
  export declare class ProjectsDaemonsApiService extends ApiBaseService {
21
21
  /**
22
22
  *
23
- * @summary Add a daemon to the given project
24
- * @param {number} projectId The project numeric Id
25
- * @param {DaemonCreate} daemonCreate A JSON object containing daemon data
23
+ * @summary Add a Daemon to the given project
24
+ * @param {number} projectId The ID of the project.
25
+ * @param {DaemonProjectCreate} daemonProjectCreate A JSON object containing the resource data
26
26
  */
27
- addDaemonToProject(projectId: number, daemonCreate: DaemonCreate): Promise<ApiResponse<Daemon>>;
27
+ addProjectDaemon(projectId: number, daemonProjectCreate: DaemonProjectCreate): Promise<ApiResponse<Daemon>>;
28
28
  /**
29
29
  *
30
- * @summary Returns a list of all daemons belonging to a project
31
- * @param {number} projectId Numeric ID of the project to get daemons from
30
+ * @summary Return a list of all Daemons belonging to a project
31
+ * @param {number} projectId The ID of the project.
32
32
  * @param {number} [page] Number of the page to be retrieved
33
33
  * @param {number} [perPage] Number of items returned per page
34
34
  */
@@ -31,28 +31,28 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class ProjectsDaemonsApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Add a daemon to the given project
35
- * @param {number} projectId The project numeric Id
36
- * @param {DaemonCreate} daemonCreate A JSON object containing daemon data
34
+ * @summary Add a Daemon to the given project
35
+ * @param {number} projectId The ID of the project.
36
+ * @param {DaemonProjectCreate} daemonProjectCreate A JSON object containing the resource data
37
37
  */
38
- addDaemonToProject(projectId, daemonCreate) {
38
+ addProjectDaemon(projectId, daemonProjectCreate) {
39
39
  return __awaiter(this, void 0, void 0, function* () {
40
40
  if (projectId === null || projectId === undefined) {
41
- throw new Exceptions_1.ArgumentNullException('projectId', 'addDaemonToProject');
41
+ throw new Exceptions_1.ArgumentNullException('projectId', 'addProjectDaemon');
42
42
  }
43
- if (daemonCreate === null || daemonCreate === undefined) {
44
- throw new Exceptions_1.ArgumentNullException('daemonCreate', 'addDaemonToProject');
43
+ if (daemonProjectCreate === null || daemonProjectCreate === undefined) {
44
+ throw new Exceptions_1.ArgumentNullException('daemonProjectCreate', 'addProjectDaemon');
45
45
  }
46
46
  let queryString = '';
47
47
  const requestUrl = '/projects/{project_id}/daemons' + (queryString ? `?${queryString}` : '');
48
- const response = yield this.post(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))), daemonCreate);
48
+ const response = yield this.post(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))), daemonProjectCreate);
49
49
  return new ApiResponse_1.ApiResponse(response);
50
50
  });
51
51
  }
52
52
  /**
53
53
  *
54
- * @summary Returns a list of all daemons belonging to a project
55
- * @param {number} projectId Numeric ID of the project to get daemons from
54
+ * @summary Return a list of all Daemons belonging to a project
55
+ * @param {number} projectId The ID of the project.
56
56
  * @param {number} [page] Number of the page to be retrieved
57
57
  * @param {number} [perPage] Number of items returned per page
58
58
  */
@@ -20,15 +20,15 @@ import { NetworkRuleRelation } from '../../generated/models';
20
20
  export declare class ProjectsNetworkRulesApiService extends ApiBaseService {
21
21
  /**
22
22
  *
23
- * @summary Add a network rule to the given project
24
- * @param {number} projectId The project numeric Id
25
- * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing backgroud process data
23
+ * @summary Add a Network Rule to the given project
24
+ * @param {number} projectId The ID of the project.
25
+ * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing the resource data
26
26
  */
27
- addNetworkRuleToProject(projectId: number, networkRuleCreate: NetworkRuleCreate): Promise<ApiResponse<NetworkRule>>;
27
+ addProjectNetworkRule(projectId: number, networkRuleCreate: NetworkRuleCreate): Promise<ApiResponse<NetworkRule>>;
28
28
  /**
29
29
  *
30
- * @summary Returns a list of all network rules that applies to a project
31
- * @param {number} projectId Numeric ID of the project to get network rules from
30
+ * @summary Return a list of all Network Rules belonging to a project
31
+ * @param {number} projectId The ID of the project.
32
32
  * @param {number} [page] Number of the page to be retrieved
33
33
  * @param {number} [perPage] Number of items returned per page
34
34
  */
@@ -31,17 +31,17 @@ const Exceptions_1 = require("../../../common/Exceptions");
31
31
  class ProjectsNetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
- * @summary Add a network rule to the given project
35
- * @param {number} projectId The project numeric Id
36
- * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing backgroud process data
34
+ * @summary Add a Network Rule to the given project
35
+ * @param {number} projectId The ID of the project.
36
+ * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing the resource data
37
37
  */
38
- addNetworkRuleToProject(projectId, networkRuleCreate) {
38
+ addProjectNetworkRule(projectId, networkRuleCreate) {
39
39
  return __awaiter(this, void 0, void 0, function* () {
40
40
  if (projectId === null || projectId === undefined) {
41
- throw new Exceptions_1.ArgumentNullException('projectId', 'addNetworkRuleToProject');
41
+ throw new Exceptions_1.ArgumentNullException('projectId', 'addProjectNetworkRule');
42
42
  }
43
43
  if (networkRuleCreate === null || networkRuleCreate === undefined) {
44
- throw new Exceptions_1.ArgumentNullException('networkRuleCreate', 'addNetworkRuleToProject');
44
+ throw new Exceptions_1.ArgumentNullException('networkRuleCreate', 'addProjectNetworkRule');
45
45
  }
46
46
  let queryString = '';
47
47
  const requestUrl = '/projects/{project_id}/network-rules' + (queryString ? `?${queryString}` : '');
@@ -51,8 +51,8 @@ class ProjectsNetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
51
51
  }
52
52
  /**
53
53
  *
54
- * @summary Returns a list of all network rules that applies to a project
55
- * @param {number} projectId Numeric ID of the project to get network rules from
54
+ * @summary Return a list of all Network Rules belonging to a project
55
+ * @param {number} projectId The ID of the project.
56
56
  * @param {number} [page] Number of the page to be retrieved
57
57
  * @param {number} [perPage] Number of items returned per page
58
58
  */
@@ -20,20 +20,20 @@ export declare class SSHKeysApiService extends ApiBaseService {
20
20
  /**
21
21
  *
22
22
  * @summary Delete a given SSH key
23
- * @param {number} sshKeyId Numeric ID of the SSH key to be deleted
23
+ * @param {number} sshKeyId The ID of the ssh key.
24
24
  */
25
25
  deleteSshKey(sshKeyId: number): Promise<ApiResponse<void>>;
26
26
  /**
27
27
  *
28
28
  * @summary Get a SSH key by ID
29
- * @param {number} sshKeyId Numeric ID of the SSH key to get
29
+ * @param {number} sshKeyId The ID of the ssh key.
30
30
  */
31
31
  getSshKey(sshKeyId: number): Promise<ApiResponse<SshKey>>;
32
32
  /**
33
33
  *
34
34
  * @summary Update an existing SSH key
35
- * @param {number} sshKeyId Numeric ID of the SSH key to be updated
36
- * @param {SshKeyUpdate} sshKeyUpdate A JSON object containing SSH key data
35
+ * @param {number} sshKeyId The ID of the ssh key.
36
+ * @param {SshKeyUpdate} sshKeyUpdate A JSON object containing the resource data
37
37
  */
38
38
  updateSshKey(sshKeyId: number, sshKeyUpdate: SshKeyUpdate): Promise<ApiResponse<void>>;
39
39
  }
@@ -32,7 +32,7 @@ class SSHKeysApiService extends ApiBaseService_1.ApiBaseService {
32
32
  /**
33
33
  *
34
34
  * @summary Delete a given SSH key
35
- * @param {number} sshKeyId Numeric ID of the SSH key to be deleted
35
+ * @param {number} sshKeyId The ID of the ssh key.
36
36
  */
37
37
  deleteSshKey(sshKeyId) {
38
38
  return __awaiter(this, void 0, void 0, function* () {
@@ -48,7 +48,7 @@ class SSHKeysApiService extends ApiBaseService_1.ApiBaseService {
48
48
  /**
49
49
  *
50
50
  * @summary Get a SSH key by ID
51
- * @param {number} sshKeyId Numeric ID of the SSH key to get
51
+ * @param {number} sshKeyId The ID of the ssh key.
52
52
  */
53
53
  getSshKey(sshKeyId) {
54
54
  return __awaiter(this, void 0, void 0, function* () {
@@ -64,8 +64,8 @@ class SSHKeysApiService extends ApiBaseService_1.ApiBaseService {
64
64
  /**
65
65
  *
66
66
  * @summary Update an existing SSH key
67
- * @param {number} sshKeyId Numeric ID of the SSH key to be updated
68
- * @param {SshKeyUpdate} sshKeyUpdate A JSON object containing SSH key data
67
+ * @param {number} sshKeyId The ID of the ssh key.
68
+ * @param {SshKeyUpdate} sshKeyUpdate A JSON object containing the resource data
69
69
  */
70
70
  updateSshKey(sshKeyId, sshKeyUpdate) {
71
71
  return __awaiter(this, void 0, void 0, function* () {
@@ -18,14 +18,14 @@ import { SslCertificate } from '../../generated/models';
18
18
  export declare class SSLCertificatesApiService extends ApiBaseService {
19
19
  /**
20
20
  *
21
- * @summary Delete a SSL certificate
22
- * @param {number} sslCertificateId The unique id of the record to be deleted
21
+ * @summary Delete a given SSL Certificate
22
+ * @param {number} sslCertificateId The ID of the ssl certificate.
23
23
  */
24
24
  deleteSslCertificate(sslCertificateId: number): Promise<ApiResponse<void>>;
25
25
  /**
26
26
  *
27
27
  * @summary Get details of a single SSL certificate
28
- * @param {number} sslCertificateId Unique ID of the item to be retrieved
28
+ * @param {number} sslCertificateId The ID of the ssl certificate.
29
29
  */
30
30
  getSslCertificate(sslCertificateId: number): Promise<ApiResponse<SslCertificate>>;
31
31
  }