@devopness/sdk-js 2.113.0 → 2.114.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.
package/README.md CHANGED
@@ -62,8 +62,8 @@ async function getUserProfile() {
62
62
  await authenticate('user@email.com', 'secret-password');
63
63
 
64
64
  // Now that we're authenticated, we can invoke methods on any services.
65
- // Here we're invoking the `getCurrentUser()` method on the `users` service
66
- const currentUser = await devopnessApi.users.getUserCurrent();
65
+ // Here we're invoking the `getUserMe()` method on the `users` service
66
+ const currentUser = await devopnessApi.users.getUserMe();
67
67
  console.log('Successfully retrieved user profile: ', currentUser);
68
68
  }
69
69
 
@@ -74,7 +74,7 @@ getUserProfile();
74
74
  This package includes TypeScript declarations for every method.
75
75
  TypeScript versions `>= 4.4` are supported.
76
76
 
77
- >Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'e using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
77
+ >Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you're using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
78
78
 
79
79
  ## Development & Testing
80
80
  To build and test the SDK locally, [**fork this repository**](https://github.com/devopness/devopness/fork) and follow these steps:
@@ -123,7 +123,7 @@ cd packages/sdks/javascript/
123
123
  ```
124
124
 
125
125
  #### 2. Install missing dependencies
126
- This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions
126
+ This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions
127
127
  for your operating system.
128
128
  ```
129
129
  npm install
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { DeploymentType } from './deployment-type';
13
+ import { SourceType } from './source-type';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -23,11 +24,11 @@ export interface ActionDeploymentContent {
23
24
  */
24
25
  type: DeploymentType;
25
26
  /**
26
- * The \'source type\' from which the application source code will be retrieved and deployed. It can be one of `branch`, `tag` or `commit`. If not provided, the application\'s default branch will be used.
27
- * @type {string}
27
+ *
28
+ * @type {SourceType}
28
29
  * @memberof ActionDeploymentContent
29
30
  */
30
- source_type: string;
31
+ source_type: SourceType;
31
32
  /**
32
33
  * A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash.
33
34
  * @type {string}
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { SourceType } from './source-type';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -22,11 +23,11 @@ export interface ActionPipelineCreate {
22
23
  */
23
24
  servers?: Array<number>;
24
25
  /**
25
- * The \'source type\' from which the application source code will be retrieved and deployed. It can be one of `branch`, `tag` or `commit`. If not provided, the application\'s default branch will be used. Must be one of <code>branch</code>, <code>tag</code>, or <code>commit</code>.
26
- * @type {string}
26
+ *
27
+ * @type {SourceType}
27
28
  * @memberof ActionPipelineCreate
28
29
  */
29
- source_type?: string;
30
+ source_type?: SourceType;
30
31
  /**
31
32
  * A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash. Must not be greater than 200 characters.
32
33
  * @type {string}
@@ -199,6 +199,7 @@ export * from './source-provider-create';
199
199
  export * from './source-provider-displayable-name';
200
200
  export * from './source-provider-name';
201
201
  export * from './source-provider-relation';
202
+ export * from './source-type';
202
203
  export * from './ssh-key';
203
204
  export * from './ssh-key-environment-create';
204
205
  export * from './ssh-key-relation';
@@ -215,6 +215,7 @@ __exportStar(require("./source-provider-create"), exports);
215
215
  __exportStar(require("./source-provider-displayable-name"), exports);
216
216
  __exportStar(require("./source-provider-name"), exports);
217
217
  __exportStar(require("./source-provider-relation"), exports);
218
+ __exportStar(require("./source-type"), exports);
218
219
  __exportStar(require("./ssh-key"), exports);
219
220
  __exportStar(require("./ssh-key-environment-create"), exports);
220
221
  __exportStar(require("./ssh-key-relation"), exports);
@@ -0,0 +1,21 @@
1
+ /**
2
+ * devopness API
3
+ * Devopness API - Painless essential DevOps to everyone
4
+ *
5
+ * The version of the OpenAPI document: latest
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The \'source type\' from which the application source code will be retrieved and deployed. It can be one of `branch`, `tag` or `commit`. If not provided, the application\'s default branch will be used.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum SourceType {
18
+ Branch = "branch",
19
+ Commit = "commit",
20
+ Tag = "tag"
21
+ }
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ /* eslint-disable */
3
+ /**
4
+ * devopness API
5
+ * Devopness API - Painless essential DevOps to everyone
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.SourceType = void 0;
16
+ /**
17
+ * The \'source type\' from which the application source code will be retrieved and deployed. It can be one of `branch`, `tag` or `commit`. If not provided, the application\'s default branch will be used.
18
+ * @export
19
+ * @enum {string}
20
+ */
21
+ var SourceType;
22
+ (function (SourceType) {
23
+ SourceType["Branch"] = "branch";
24
+ SourceType["Commit"] = "commit";
25
+ SourceType["Tag"] = "tag";
26
+ })(SourceType = exports.SourceType || (exports.SourceType = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devopness/sdk-js",
3
- "version": "2.113.0",
3
+ "version": "2.114.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },