@devopness/sdk-js 1.103.0 → 1.104.2

package/README.md

@@ -20,7 +20,7 @@ yarn add @devopness/sdk-js
 
 ### Initializing
 
-To initialize the usage of Devopness SDK just import it and create a new instance of `DevopnessApiClient` class.
+To initialize the usage of Devopness SDK, just import it and create a new instance of `DevopnessApiClient` class.
 
 Here is a generic simple example that can be used from `Node.js`, `TypeScript` or `Javascript` applications:
 
@@ -30,8 +30,8 @@ const devopnessApi = new DevopnessApiClient();
 ```
 
 The instance of `DevopnessApiClient` has properties to all services provided by the API.
-The name of the methods at services is the same as operation name in the documentation of the
-Devopness API. You can consult the URL of a endpoint to see the operation name. For instance
+The name of the methods at services is the same as the operation name in the documentation of the
+Devopness API. You can consult the URL of an endpoint to see the operation name. For instance,
 the URL to endpoint `POST /users/login` in the documentation is: `/#operation/login`
 
 ### Authenticating
@@ -49,7 +49,7 @@ async function authenticate(email, pass) {
 authenticate('user@email.com', 'secret-password');
 ```
 
-In the example above, `userTokens` is a instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/master/src/common/ApiResponse.ts) for reference.
+In the example above, `userTokens` is an instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/master/src/common/ApiResponse.ts) for reference.
 
 ### Invoking authentication protected endpoints
 Once an authentication token is set, any protected endpoint can be invoked.
@@ -74,7 +74,7 @@ getUserProfile();
 This package includes TypeScript declarations for every method.
 TypeScript versions `>= 3.8` are supported.
 
-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.
+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.
 
 ## Building and testing
 To build and test the SDK locally, follow these steps:

package/dist/DevopnessApiClient.d.ts

@@ -13,7 +13,6 @@ import { SslCertificateService } from './services/SslCertificateService';
 import { UserService } from './services/UserService';
 import { CronJobService } from './services/CronJobService';
 import { StaticService } from './services/StaticService';
-import { ActionsApiService } from './api/generated/apis/actions-api';
 import { SocialAccountService } from './services/SocialAccountService';
 import { LogService } from './services/LogService';
 import { VariableService } from './services/VariableService';
@@ -24,8 +23,9 @@ import { CloudProviderService } from './services/CloudProviderService';
 import { InvitationService } from './services/InvitationService';
 import { TeamService } from './services/TeamService';
 import { ResourceEventService } from './services/ResourceEventService';
+import { ActionService } from './services/ActionService';
 export declare class DevopnessApiClient {
-    actions: ActionsApiService;
+    actions: ActionService;
     applications: ApplicationService;
     cloudProviders: CloudProviderService;
     cronjobs: CronJobService;

package/dist/DevopnessApiClient.js

@@ -16,7 +16,6 @@ const SslCertificateService_1 = require("./services/SslCertificateService");
 const UserService_1 = require("./services/UserService");
 const CronJobService_1 = require("./services/CronJobService");
 const StaticService_1 = require("./services/StaticService");
-const actions_api_1 = require("./api/generated/apis/actions-api");
 const SocialAccountService_1 = require("./services/SocialAccountService");
 const LogService_1 = require("./services/LogService");
 const VariableService_1 = require("./services/VariableService");
@@ -27,13 +26,14 @@ const CloudProviderService_1 = require("./services/CloudProviderService");
 const InvitationService_1 = require("./services/InvitationService");
 const TeamService_1 = require("./services/TeamService");
 const ResourceEventService_1 = require("./services/ResourceEventService");
+const ActionService_1 = require("./services/ActionService");
 class DevopnessApiClient {
     constructor(options) {
         ApiBaseService_1.ApiBaseService.configuration = new ApiBaseService_1.Configuration(options || {});
         // we initialize the services explicitly, instead of auto initialize them on property declaration in the beginning of the class,
         // cause some (or all) of them depend on `ApiBaseService.configuration` property be set. Furthermore, we ensure all assertions
         // for non provided required parameters are quickly returned to the end user before spending time loading extra resources
-        this.actions = new actions_api_1.ActionsApiService();
+        this.actions = new ActionService_1.ActionService();
         this.applications = new ApplicationService_1.ApplicationService();
         this.cloudProviders = new CloudProviderService_1.CloudProviderService();
         this.cronjobs = new CronJobService_1.CronJobService();

package/dist/api/generated/models/action-data.d.ts

@@ -0,0 +1,18 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ActionDeploymentData } from './action-deployment-data';
+/**
+ * @type ActionData
+ * Data related to action resource.
+ * @export
+ */
+export declare type ActionData = ActionDeploymentData;

package/dist/api/generated/models/action-data.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/action-deployment-commit.d.ts

@@ -0,0 +1,90 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Informations about the commit used on this deployment
+ * @export
+ * @interface ActionDeploymentCommit
+ */
+export interface ActionDeploymentCommit {
+    /**
+     * The ID of the source provider
+     * @type {number}
+     * @memberof ActionDeploymentCommit
+     */
+    source_provider_id: number;
+    /**
+     * The source provider\'s name
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    provider: string;
+    /**
+     * The repository of the deployed application
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    repository: string;
+    /**
+     * The branch used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    branch: string;
+    /**
+     * The commit hash used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    hash: string;
+    /**
+     * The commit message
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    message: string;
+    /**
+     * The author of the commit
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    author_name: string;
+    /**
+     * The commit author\'s email
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    author_email: string;
+    /**
+     * The date and time when the commit was created
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    committed_at: string;
+    /**
+     * The commit URL on the source provider
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    url: string;
+    /**
+     * The URL to clone the repository on the specific commit
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    clone_url: string;
+    /**
+     * The URL to download the commit source code
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    download_url: string;
+}

package/dist/api/generated/models/action-deployment-commit.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/action-deployment-content.d.ts

@@ -0,0 +1,55 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DeploymentType } from './deployment-type';
+/**
+ *
+ * @export
+ * @interface ActionDeploymentContent
+ */
+export interface ActionDeploymentContent {
+    /**
+     * The ID of the source provider
+     * @type {number}
+     * @memberof ActionDeploymentContent
+     */
+    provider_id: number;
+    /**
+     * The source provider\'s name
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    provider_name: string;
+    /**
+     *
+     * @type {DeploymentType}
+     * @memberof ActionDeploymentContent
+     */
+    type: DeploymentType;
+    /**
+     * The repository of the deployed application
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    repository: string;
+    /**
+     * The branch used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    branch: string;
+    /**
+     * The commit hash defined to be used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    hash: string | null;
+}

package/dist/api/generated/models/action-deployment-content.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/action-deployment-data.d.ts

@@ -0,0 +1,38 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ActionDeploymentCommit } from './action-deployment-commit';
+import { ActionDeploymentContent } from './action-deployment-content';
+/**
+ *
+ * @export
+ * @interface ActionDeploymentData
+ */
+export interface ActionDeploymentData {
+    /**
+     * The name generated to release created by this deployment
+     * @type {string}
+     * @memberof ActionDeploymentData
+     */
+    release_name: string;
+    /**
+     *
+     * @type {ActionDeploymentCommit}
+     * @memberof ActionDeploymentData
+     */
+    commit: ActionDeploymentCommit;
+    /**
+     *
+     * @type {ActionDeploymentContent}
+     * @memberof ActionDeploymentData
+     */
+    deployment: ActionDeploymentContent;
+}

package/dist/api/generated/models/action-deployment-data.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/action.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ActionData } from './action-data';
 import { ActionHookRequest } from './action-hook-request';
 import { ActionStatus } from './action-status';
 import { ActionSummary } from './action-summary';
@@ -61,6 +62,12 @@ export interface Action {
      * @memberof Action
      */
     url_web_permalink: string;
+    /**
+     *
+     * @type {ActionData}
+     * @memberof Action
+     */
+    action_data: ActionData | null;
     /**
      * List of actions dispatched to servers
      * @type {Array<ServerAction>}

package/dist/api/generated/models/index.d.ts

@@ -1,5 +1,9 @@
 export * from './accepted-response-message';
 export * from './action';
+export * from './action-data';
+export * from './action-deployment-commit';
+export * from './action-deployment-content';
+export * from './action-deployment-data';
 export * from './action-hook-request';
 export * from './action-list-item';
 export * from './action-list-item-params';

package/dist/api/generated/models/index.js

@@ -16,6 +16,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./accepted-response-message"), exports);
 __exportStar(require("./action"), exports);
+__exportStar(require("./action-data"), exports);
+__exportStar(require("./action-deployment-commit"), exports);
+__exportStar(require("./action-deployment-content"), exports);
+__exportStar(require("./action-deployment-data"), exports);
 __exportStar(require("./action-hook-request"), exports);
 __exportStar(require("./action-list-item"), exports);
 __exportStar(require("./action-list-item-params"), exports);

package/dist/services/EnvironmentService.d.ts

@@ -1,4 +1,5 @@
 import { EnvironmentsApiService } from '../api/generated/apis/environments-api';
+import { EnvironmentsActionsApiService } from '../api/generated/apis/environments-actions-api';
 import { EnvironmentsApplicationsApiService } from '../api/generated/apis/environments-applications-api';
 import { EnvironmentsCronJobsApiService } from '../api/generated/apis/environments-cron-jobs-api';
 import { EnvironmentsDaemonsApiService } from '../api/generated/apis/environments-daemons-api';
@@ -9,6 +10,7 @@ import { EnvironmentsServicesApiService } from '../api/generated/apis/environmen
 import { EnvironmentsSSHKeysApiService } from '../api/generated/apis/environments-sshkeys-api';
 import { EnvironmentsTeamsApiService } from '../api/generated/apis/environments-teams-api';
 export declare class EnvironmentService extends EnvironmentsApiService {
+    actions: EnvironmentsActionsApiService;
     applications: EnvironmentsApplicationsApiService;
     cronjobs: EnvironmentsCronJobsApiService;
     daemons: EnvironmentsDaemonsApiService;

package/dist/services/EnvironmentService.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnvironmentService = void 0;
 const environments_api_1 = require("../api/generated/apis/environments-api");
+const environments_actions_api_1 = require("../api/generated/apis/environments-actions-api");
 const environments_applications_api_1 = require("../api/generated/apis/environments-applications-api");
 const environments_cron_jobs_api_1 = require("../api/generated/apis/environments-cron-jobs-api");
 const environments_daemons_api_1 = require("../api/generated/apis/environments-daemons-api");
@@ -14,6 +15,7 @@ const environments_teams_api_1 = require("../api/generated/apis/environments-tea
 class EnvironmentService extends environments_api_1.EnvironmentsApiService {
     constructor() {
         super(...arguments);
+        this.actions = new environments_actions_api_1.EnvironmentsActionsApiService();
         this.applications = new environments_applications_api_1.EnvironmentsApplicationsApiService();
         this.cronjobs = new environments_cron_jobs_api_1.EnvironmentsCronJobsApiService();
         this.daemons = new environments_daemons_api_1.EnvironmentsDaemonsApiService();

package/dist/services/ProjectService.d.ts

@@ -1,4 +1,5 @@
 import { ProjectsApiService } from '../api/generated/apis/projects-api';
+import { ProjectsActionsApiService } from '../api/generated/apis/projects-actions-api';
 import { ProjectsApplicationsApiService } from '../api/generated/apis/projects-applications-api';
 import { ProjectsCronJobsApiService } from '../api/generated/apis/projects-cron-jobs-api';
 import { ProjectsEnvironmentsApiService } from '../api/generated/apis/projects-environments-api';
@@ -8,6 +9,7 @@ import { ProjectsServicesApiService } from '../api/generated/apis/projects-servi
 import { ProjectsSSHKeysApiService } from '../api/generated/apis/projects-sshkeys-api';
 import { ProjectsDaemonsApiService } from '../api/generated/apis/projects-daemons-api';
 export declare class ProjectService extends ProjectsApiService {
+    actions: ProjectsActionsApiService;
     applications: ProjectsApplicationsApiService;
     cronjobs: ProjectsCronJobsApiService;
     daemons: ProjectsDaemonsApiService;

package/dist/services/ProjectService.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectService = void 0;
 const projects_api_1 = require("../api/generated/apis/projects-api");
+const projects_actions_api_1 = require("../api/generated/apis/projects-actions-api");
 const projects_applications_api_1 = require("../api/generated/apis/projects-applications-api");
 const projects_cron_jobs_api_1 = require("../api/generated/apis/projects-cron-jobs-api");
 const projects_environments_api_1 = require("../api/generated/apis/projects-environments-api");
@@ -13,6 +14,7 @@ const projects_daemons_api_1 = require("../api/generated/apis/projects-daemons-a
 class ProjectService extends projects_api_1.ProjectsApiService {
     constructor() {
         super(...arguments);
+        this.actions = new projects_actions_api_1.ProjectsActionsApiService();
         this.applications = new projects_applications_api_1.ProjectsApplicationsApiService();
         this.cronjobs = new projects_cron_jobs_api_1.ProjectsCronJobsApiService();
         this.daemons = new projects_daemons_api_1.ProjectsDaemonsApiService();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "1.103.0",
+  "version": "1.104.2",
   "publishConfig": {
     "access": "public"
   },