@devopness/sdk-js 2.135.0 → 2.136.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.
@@ -12,12 +12,12 @@
12
12
  import { ApiBaseService } from "../../../services/ApiBaseService";
13
13
  import { ApiResponse } from "../../../common/ApiResponse";
14
14
  import { Service } from '../../generated/models';
15
+ import { ServiceGetStatus } from '../../generated/models';
15
16
  import { ServiceReload } from '../../generated/models';
16
17
  import { ServiceRestart } from '../../generated/models';
17
18
  import { ServiceStart } from '../../generated/models';
18
19
  import { ServiceStop } from '../../generated/models';
19
20
  import { ServiceUpdate } from '../../generated/models';
20
- import { ServiceUpdateStatus } from '../../generated/models';
21
21
  /**
22
22
  * ServicesApiService - Auto-generated
23
23
  */
@@ -34,6 +34,13 @@ export declare class ServicesApiService extends ApiBaseService {
34
34
  * @param {number} serviceId The ID of the service.
35
35
  */
36
36
  getService(serviceId: number): Promise<ApiResponse<Service>>;
37
+ /**
38
+ *
39
+ * @summary Get current status of a service
40
+ * @param {number} serviceId The ID of the service.
41
+ * @param {ServiceGetStatus} serviceGetStatus A JSON object containing the resource data
42
+ */
43
+ getStatusService(serviceId: number, serviceGetStatus: ServiceGetStatus): Promise<ApiResponse<void>>;
37
44
  /**
38
45
  *
39
46
  * @summary Reload a service
@@ -69,11 +76,4 @@ export declare class ServicesApiService extends ApiBaseService {
69
76
  * @param {ServiceUpdate} serviceUpdate A JSON object containing the resource data
70
77
  */
71
78
  updateService(serviceId: number, serviceUpdate: ServiceUpdate): Promise<ApiResponse<void>>;
72
- /**
73
- *
74
- * @summary Update status of a service
75
- * @param {number} serviceId The ID of the service.
76
- * @param {ServiceUpdateStatus} serviceUpdateStatus A JSON object containing the resource data
77
- */
78
- updateStatusService(serviceId: number, serviceUpdateStatus: ServiceUpdateStatus): Promise<ApiResponse<void>>;
79
79
  }
@@ -61,6 +61,26 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
61
61
  return new ApiResponse_1.ApiResponse(response);
62
62
  });
63
63
  }
64
+ /**
65
+ *
66
+ * @summary Get current status of a service
67
+ * @param {number} serviceId The ID of the service.
68
+ * @param {ServiceGetStatus} serviceGetStatus A JSON object containing the resource data
69
+ */
70
+ getStatusService(serviceId, serviceGetStatus) {
71
+ return __awaiter(this, void 0, void 0, function* () {
72
+ if (serviceId === null || serviceId === undefined) {
73
+ throw new Exceptions_1.ArgumentNullException('serviceId', 'getStatusService');
74
+ }
75
+ if (serviceGetStatus === null || serviceGetStatus === undefined) {
76
+ throw new Exceptions_1.ArgumentNullException('serviceGetStatus', 'getStatusService');
77
+ }
78
+ let queryString = '';
79
+ const requestUrl = '/services/{service_id}/get-status' + (queryString ? `?${queryString}` : '');
80
+ const response = yield this.post(requestUrl.replace(`{${"service_id"}}`, encodeURIComponent(String(serviceId))), serviceGetStatus);
81
+ return new ApiResponse_1.ApiResponse(response);
82
+ });
83
+ }
64
84
  /**
65
85
  *
66
86
  * @summary Reload a service
@@ -161,25 +181,5 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
161
181
  return new ApiResponse_1.ApiResponse(response);
162
182
  });
163
183
  }
164
- /**
165
- *
166
- * @summary Update status of a service
167
- * @param {number} serviceId The ID of the service.
168
- * @param {ServiceUpdateStatus} serviceUpdateStatus A JSON object containing the resource data
169
- */
170
- updateStatusService(serviceId, serviceUpdateStatus) {
171
- return __awaiter(this, void 0, void 0, function* () {
172
- if (serviceId === null || serviceId === undefined) {
173
- throw new Exceptions_1.ArgumentNullException('serviceId', 'updateStatusService');
174
- }
175
- if (serviceUpdateStatus === null || serviceUpdateStatus === undefined) {
176
- throw new Exceptions_1.ArgumentNullException('serviceUpdateStatus', 'updateStatusService');
177
- }
178
- let queryString = '';
179
- const requestUrl = '/services/{service_id}/update-status' + (queryString ? `?${queryString}` : '');
180
- const response = yield this.post(requestUrl.replace(`{${"service_id"}}`, encodeURIComponent(String(serviceId))), serviceUpdateStatus);
181
- return new ApiResponse_1.ApiResponse(response);
182
- });
183
- }
184
184
  }
185
185
  exports.ServicesApiService = ServicesApiService;
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { ApplicationLastDeployments } from './application-last-deployments';
13
+ import { DaemonRelation } from './daemon-relation';
13
14
  import { EnvironmentRelation } from './environment-relation';
14
15
  import { ServerRelation } from './server-relation';
15
16
  import { SourceProvider } from './source-provider';
@@ -153,6 +154,12 @@ export interface Application {
153
154
  * @memberof Application
154
155
  */
155
156
  virtual_hosts: Array<VirtualHostRelation>;
157
+ /**
158
+ *
159
+ * @type {Array<DaemonRelation>}
160
+ * @memberof Application
161
+ */
162
+ daemons: Array<DaemonRelation>;
156
163
  /**
157
164
  * The date and time when the record was created
158
165
  * @type {string}
@@ -107,8 +107,8 @@ export * from './language-runtime-engine-versions';
107
107
  export * from './language-runtime-framework';
108
108
  export * from './language-runtime-framework-commands';
109
109
  export * from './language-runtime-framework-defaults';
110
- export * from './linked-resource-attribute';
111
110
  export * from './linked-resource-data';
111
+ export * from './linked-resource-summary-field';
112
112
  export * from './log';
113
113
  export * from './member';
114
114
  export * from './member-relation';
@@ -178,6 +178,7 @@ export * from './server-relation';
178
178
  export * from './server-update';
179
179
  export * from './service';
180
180
  export * from './service-environment-create';
181
+ export * from './service-get-status';
181
182
  export * from './service-initial-state';
182
183
  export * from './service-options';
183
184
  export * from './service-relation';
@@ -187,7 +188,6 @@ export * from './service-start';
187
188
  export * from './service-stop';
188
189
  export * from './service-type';
189
190
  export * from './service-update';
190
- export * from './service-update-status';
191
191
  export * from './social-account';
192
192
  export * from './social-account-create';
193
193
  export * from './social-account-displayable-name';
@@ -123,8 +123,8 @@ __exportStar(require("./language-runtime-engine-versions"), exports);
123
123
  __exportStar(require("./language-runtime-framework"), exports);
124
124
  __exportStar(require("./language-runtime-framework-commands"), exports);
125
125
  __exportStar(require("./language-runtime-framework-defaults"), exports);
126
- __exportStar(require("./linked-resource-attribute"), exports);
127
126
  __exportStar(require("./linked-resource-data"), exports);
127
+ __exportStar(require("./linked-resource-summary-field"), exports);
128
128
  __exportStar(require("./log"), exports);
129
129
  __exportStar(require("./member"), exports);
130
130
  __exportStar(require("./member-relation"), exports);
@@ -194,6 +194,7 @@ __exportStar(require("./server-relation"), exports);
194
194
  __exportStar(require("./server-update"), exports);
195
195
  __exportStar(require("./service"), exports);
196
196
  __exportStar(require("./service-environment-create"), exports);
197
+ __exportStar(require("./service-get-status"), exports);
197
198
  __exportStar(require("./service-initial-state"), exports);
198
199
  __exportStar(require("./service-options"), exports);
199
200
  __exportStar(require("./service-relation"), exports);
@@ -203,7 +204,6 @@ __exportStar(require("./service-start"), exports);
203
204
  __exportStar(require("./service-stop"), exports);
204
205
  __exportStar(require("./service-type"), exports);
205
206
  __exportStar(require("./service-update"), exports);
206
- __exportStar(require("./service-update-status"), exports);
207
207
  __exportStar(require("./social-account"), exports);
208
208
  __exportStar(require("./social-account-create"), exports);
209
209
  __exportStar(require("./social-account-displayable-name"), exports);
@@ -22,18 +22,6 @@ export interface LanguageRuntimeFrameworkDefaults {
22
22
  * @memberof LanguageRuntimeFrameworkDefaults
23
23
  */
24
24
  default_branch?: string;
25
- /**
26
- * Indicates if push to deploy webhooks are enabled for this application/environment, if so code will be deployed when commited to the default_branch
27
- * @type {boolean}
28
- * @memberof LanguageRuntimeFrameworkDefaults
29
- */
30
- push_to_deploy?: boolean;
31
- /**
32
- * Indicates if the application requires a daemon to keep it alive
33
- * @type {boolean}
34
- * @memberof LanguageRuntimeFrameworkDefaults
35
- */
36
- requires_daemon?: boolean;
37
25
  /**
38
26
  * The language runtime engine version to be used to execute this application code on the deployed servers
39
27
  * @type {string}
@@ -52,24 +40,6 @@ export interface LanguageRuntimeFrameworkDefaults {
52
40
  * @memberof LanguageRuntimeFrameworkDefaults
53
41
  */
54
42
  root_directory?: string;
55
- /**
56
- * The relative web directory where publicly accessible assets are located and the web content should be served from
57
- * @type {string}
58
- * @memberof LanguageRuntimeFrameworkDefaults
59
- */
60
- public_directory?: string;
61
- /**
62
- * The entrypoint tells devopness how an application should be started and has basically two forms: 1) `File`: if it\'s a simple file name/path an web app will be served using the entrypoint value as its index file. Example: `index.html` 2) `Command`: if a command line instruction is provided as the entrypoint value, it will be handled as the start up command that initalizes the application. It will be assumed that the user is an advanced user that knows what she/he is doing, therefore the command specified here will be run - as is - everytime the application needs to be started.
63
- * @type {string}
64
- * @memberof LanguageRuntimeFrameworkDefaults
65
- */
66
- entrypoint?: string;
67
- /**
68
- * Required for CGI|FastCGI|SCGI|WSGI based applications or `docker` containerized applications. It tells `devopness` the private address at which the application listens to external calls. The address has `http` or `https` protocol, an domain name or IP address, optional port and optional path. Or you can specify a UNIX-socket using `unix:` prefix after protocol.
69
- * @type {string}
70
- * @memberof LanguageRuntimeFrameworkDefaults
71
- */
72
- listening_address?: string;
73
43
  /**
74
44
  * The number of deployment history, logs and artifacts to keep stored in both devopness servers and user\'s servers
75
45
  * @type {number}
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { LinkedResourceAttribute } from './linked-resource-attribute';
12
+ import { LinkedResourceSummaryField } from './linked-resource-summary-field';
13
13
  /**
14
14
  * Object with common attributes that identify a linked resource
15
15
  * @export
@@ -29,11 +29,11 @@ export interface LinkedResourceData {
29
29
  */
30
30
  name: string;
31
31
  /**
32
- * The list of linked resource attributes
33
- * @type {Array<LinkedResourceAttribute>}
32
+ * The summary of linked resource fields
33
+ * @type {Array<LinkedResourceSummaryField>}
34
34
  * @memberof LinkedResourceData
35
35
  */
36
- extra_attributes?: Array<LinkedResourceAttribute>;
36
+ summary_fields?: Array<LinkedResourceSummaryField>;
37
37
  /**
38
38
  * The date and time when the record was created
39
39
  * @type {string}
@@ -12,25 +12,25 @@
12
12
  /**
13
13
  *
14
14
  * @export
15
- * @interface LinkedResourceAttribute
15
+ * @interface LinkedResourceSummaryField
16
16
  */
17
- export interface LinkedResourceAttribute {
17
+ export interface LinkedResourceSummaryField {
18
18
  /**
19
- * The attribute name
19
+ * The field name
20
20
  * @type {string}
21
- * @memberof LinkedResourceAttribute
21
+ * @memberof LinkedResourceSummaryField
22
22
  */
23
23
  field_name: string;
24
24
  /**
25
- * Human redable version of the attribute name
25
+ * Human readable version of the field name
26
26
  * @type {string}
27
- * @memberof LinkedResourceAttribute
27
+ * @memberof LinkedResourceSummaryField
28
28
  */
29
29
  field_name_human_readable: string;
30
30
  /**
31
- * The attribute value
31
+ * The field value
32
32
  * @type {string}
33
- * @memberof LinkedResourceAttribute
33
+ * @memberof LinkedResourceSummaryField
34
34
  */
35
- value?: string;
35
+ value: string;
36
36
  }
@@ -10,6 +10,8 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { EnvironmentRelation } from './environment-relation';
13
+ import { RoleRelation } from './role-relation';
14
+ import { TeamRelation } from './team-relation';
13
15
  import { UserRelation } from './user-relation';
14
16
  /**
15
17
  *
@@ -59,6 +61,18 @@ export interface Project {
59
61
  * @memberof Project
60
62
  */
61
63
  environments: Array<EnvironmentRelation>;
64
+ /**
65
+ *
66
+ * @type {Array<TeamRelation>}
67
+ * @memberof Project
68
+ */
69
+ teams: Array<TeamRelation>;
70
+ /**
71
+ *
72
+ * @type {Array<RoleRelation>}
73
+ * @memberof Project
74
+ */
75
+ roles: Array<RoleRelation>;
62
76
  /**
63
77
  * The date and time when the record was created
64
78
  * @type {string}
@@ -12,19 +12,19 @@
12
12
  /**
13
13
  *
14
14
  * @export
15
- * @interface ServiceUpdateStatus
15
+ * @interface ServiceGetStatus
16
16
  */
17
- export interface ServiceUpdateStatus {
17
+ export interface ServiceGetStatus {
18
18
  /**
19
19
  * The ID of the environment this service is running in.
20
20
  * @type {number}
21
- * @memberof ServiceUpdateStatus
21
+ * @memberof ServiceGetStatus
22
22
  */
23
23
  environment_id: number;
24
24
  /**
25
25
  * List of valid resource IDs
26
26
  * @type {Array<number>}
27
- * @memberof ServiceUpdateStatus
27
+ * @memberof ServiceGetStatus
28
28
  */
29
29
  servers?: Array<number>;
30
30
  }
@@ -22,7 +22,7 @@ export interface VirtualHostEnvironmentCreate {
22
22
  */
23
23
  type: string;
24
24
  /**
25
- * The name of the virtual host. Must not be greater than 255 characters.
25
+ * The name of the virtual host, unique within the environment. For `name-based` type, it must be a valid domain name (e.g., `my-site.example.com`). For `ip-based` type, it must be a valid IPv4 address or an IPv4 address with port (e.g., `127.0.0.1:3000`). Must not be greater than 255 characters.
26
26
  * @type {string}
27
27
  * @memberof VirtualHostEnvironmentCreate
28
28
  */
@@ -22,7 +22,7 @@ export interface VirtualHostUpdate {
22
22
  */
23
23
  id: number;
24
24
  /**
25
- * The name of the virtual host. Must not be greater than 255 characters.
25
+ * The name of the virtual host, unique within the environment. For `name-based` type, it must be a valid domain name (e.g., `my-app.example.com`). For `ip-based` type, it must be a valid IPv4 address or an IPv4 address with port (e.g., `127.0.0.1:3000`). Must not be greater than 255 characters.
26
26
  * @type {string}
27
27
  * @memberof VirtualHostUpdate
28
28
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devopness/sdk-js",
3
- "version": "2.135.0",
3
+ "version": "2.136.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },