@devopness/sdk-js 2.44.0 → 2.45.0

package/README.md

@@ -49,7 +49,7 @@ async function authenticate(email, pass) {
 authenticate('user@email.com', 'secret-password');
 ```
 
-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.
+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/main/packages/sdks/javascript/src/common/ApiResponse.ts) for reference.
 
 ### Invoking authentication protected endpoints
 Once an authentication token is set, any protected endpoint can be invoked.
@@ -106,19 +106,26 @@ make test
 ```
 
 ### Without Docker
+Installing on ``Linux`` or ``macOS`` systems.
 
-#### 1. Install missing dependencies
-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 for your operating system.
+#### 1. Navigate to the project directory!
+```shell
+cd packages/sdks/javascript/
+```
+
+#### 2. Install missing dependencies
+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 
+for your operating system.
 ```
 npm install
 ```
 
-#### 2. Build SDK
+#### 3. Build SDK
 ```
 npm run build
 ```
 
-#### 3. Run tests
+#### 4. Run tests
 ```
 npm run test
 ```

package/dist/api/generated/apis/resource-events-api.d.ts

@@ -16,6 +16,13 @@ import { ResourceEventRelation } from '../../generated/models';
  * ResourceEventsApiService - Auto-generated
  */
 export declare class ResourceEventsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Process event for a resource
+     * @param {string} resourceId The resource ID.
+     * @param {string} resourceType The resource type to create events for.
+     */
+    addResourceEvent(resourceId: string, resourceType: string): Promise<ApiResponse<void>>;
     /**
      *
      * @summary List events of a resource type

package/dist/api/generated/apis/resource-events-api.js

@@ -29,6 +29,26 @@ const Exceptions_1 = require("../../../common/Exceptions");
  * ResourceEventsApiService - Auto-generated
  */
 class ResourceEventsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Process event for a resource
+     * @param {string} resourceId The resource ID.
+     * @param {string} resourceType The resource type to create events for.
+     */
+    addResourceEvent(resourceId, resourceType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (resourceId === null || resourceId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceId', 'addResourceEvent');
+            }
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'addResourceEvent');
+            }
+            let queryString = '';
+            const requestUrl = '/events/{resource_type}/{resource_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"resource_id"}}`, encodeURIComponent(String(resourceId))).replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary List events of a resource type

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

@@ -185,6 +185,7 @@ export * from './static-service-type-supported-versions';
 export * from './step';
 export * from './step-pipeline-create';
 export * from './step-pipeline-update';
+export * from './subscription';
 export * from './subscription-plan';
 export * from './team';
 export * from './team-environment-link';

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

@@ -201,6 +201,7 @@ __exportStar(require("./static-service-type-supported-versions"), exports);
 __exportStar(require("./step"), exports);
 __exportStar(require("./step-pipeline-create"), exports);
 __exportStar(require("./step-pipeline-update"), exports);
+__exportStar(require("./subscription"), exports);
 __exportStar(require("./subscription-plan"), exports);
 __exportStar(require("./team"), exports);
 __exportStar(require("./team-environment-link"), exports);

package/dist/api/generated/models/server-blueprint.d.ts

@@ -22,10 +22,4 @@ export interface ServerBlueprint {
      * @memberof ServerBlueprint
      */
     services?: Array<BlueprintService> | null;
-    /**
-     * If `true`, create a landing page on the server to validate if has public access
-     * @type {boolean}
-     * @memberof ServerBlueprint
-     */
-    validate_web_public_access: boolean;
 }

package/dist/api/generated/models/server-environment-create.d.ts

@@ -30,7 +30,7 @@ export interface ServerEnvironmentCreate {
      */
     ip_address?: string;
     /**
-     * The network port to which the SSH daemon is listening to SSH connections on the server. This field is required when <code>provision_settings.self_hosted</code> is <code>true</code>.
+     * The network port to which the SSH daemon is listening to SSH connections on the server. This field is required when <code>provision_settings.self_hosted</code> is <code>true</code>. Must be between 22 and 65535.
      * @type {number}
      * @memberof ServerEnvironmentCreate
      */

package/dist/api/generated/models/server-update.d.ts

@@ -28,7 +28,7 @@ export interface ServerUpdate {
      */
     ip_address?: string;
     /**
-     * The network port to which the SSH daemon is listening to SSH connections on the server. This field is required when <code>provision_settings.self_hosted</code> is <code>true</code>.
+     * The network port to which the SSH daemon is listening to SSH connections on the server. This field is required when <code>provision_settings.self_hosted</code> is <code>true</code>. Must be between 22 and 65535.
      * @type {number}
      * @memberof ServerUpdate
      */

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

@@ -0,0 +1,96 @@
+/**
+ * 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.
+ */
+/**
+ * The user\'s active subscription
+ * @export
+ * @interface Subscription
+ */
+export interface Subscription {
+    /**
+     * The ID of the subscription
+     * @type {number}
+     * @memberof Subscription
+     */
+    id?: number;
+    /**
+     * The ID of the user this subscription belongs to
+     * @type {number}
+     * @memberof Subscription
+     */
+    user_id?: number;
+    /**
+     * The plan name of this subscription
+     * @type {string}
+     * @memberof Subscription
+     */
+    plan_name?: string;
+    /**
+     * Status of this subscription
+     * @type {string}
+     * @memberof Subscription
+     */
+    status?: string;
+    /**
+     * Amount of plans purchased in this subscription
+     * @type {number}
+     * @memberof Subscription
+     */
+    quantity?: number;
+    /**
+     * Unitary price of the subscribed plan
+     * @type {number}
+     * @memberof Subscription
+     */
+    price_unit?: number;
+    /**
+     * Total price of this subscription (quantity x price_unit)
+     * @type {number}
+     * @memberof Subscription
+     */
+    price_total?: number;
+    /**
+     * Currency of the prices
+     * @type {string}
+     * @memberof Subscription
+     */
+    price_currency?: string;
+    /**
+     * If this subscription is a trial, this field indicates when it will end
+     * @type {string}
+     * @memberof Subscription
+     */
+    trial_ends_at?: string | null;
+    /**
+     * If not null, indicates the date when this subscription was cancelled
+     * @type {string}
+     * @memberof Subscription
+     */
+    cancelled_at?: string | null;
+    /**
+     * Indicates the date and time when this subscription ends
+     * @type {string}
+     * @memberof Subscription
+     */
+    ends_at?: string;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof Subscription
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof Subscription
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/subscription.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/user-me.d.ts

@@ -11,7 +11,7 @@
  */
 import { Language } from './language';
 import { SocialAccountRelation } from './social-account-relation';
-import { SubscriptionPlan } from './subscription-plan';
+import { Subscription } from './subscription';
 /**
  *
  * @export
@@ -55,17 +55,11 @@ export interface UserMe {
      */
     social_accounts: Array<SocialAccountRelation>;
     /**
-     * The code of current billing plan
-     * @type {string}
-     * @memberof UserMe
-     */
-    current_billing_plan: string;
-    /**
-     * The list of subscription plans
-     * @type {Array<SubscriptionPlan>}
+     *
+     * @type {Subscription}
      * @memberof UserMe
      */
-    subscription_plans: Array<SubscriptionPlan>;
+    active_subscription: Subscription | null;
     /**
      * The date and time when the record was created
      * @type {string}

package/dist/api/generated/models/user-update.d.ts

@@ -39,10 +39,4 @@ export interface UserUpdate {
      * @memberof UserUpdate
      */
     language?: string;
-    /**
-     * The user subscription plan. Must be one of <code>FREE</code> or <code>PAID</code>.
-     * @type {string}
-     * @memberof UserUpdate
-     */
-    current_billing_plan?: string;
 }

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

@@ -11,7 +11,7 @@
  */
 import { Language } from './language';
 import { SocialAccountRelation } from './social-account-relation';
-import { SubscriptionPlan } from './subscription-plan';
+import { Subscription } from './subscription';
 /**
  *
  * @export
@@ -55,17 +55,11 @@ export interface User {
      */
     social_accounts: Array<SocialAccountRelation>;
     /**
-     * The code of current billing plan
-     * @type {string}
-     * @memberof User
-     */
-    current_billing_plan: string;
-    /**
-     * The list of subscription plans
-     * @type {Array<SubscriptionPlan>}
+     *
+     * @type {Subscription}
      * @memberof User
      */
-    subscription_plans: Array<SubscriptionPlan>;
+    active_subscription: Subscription | null;
     /**
      * The date and time when the record was created
      * @type {string}

package/package.json

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