@arrowsphere/api-client 2.2.0 → 2.5.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.5.0] - 2022-02-14
+
+### Added
+
+- Add endpoint cancel license
+
+## [2.4.0] - 2022-02-11
+
+### Added
+
+- Add endpoint reactivate license
+
+## [2.3.0] - 2022-02-11
+
+### Added
+
+- Add endpoint suspend license
+
+## [2.2.1] - 2022-02-10
+
+### Added
+
+- Fixed Class GetResult
+- Add Class GetLicenseResult for intermediate level between GetResult Class and LicenseGetResult
+- Refactoring of Units Tests
+- Refactoring names of variable in class LicenseGetResult
+
 ## [2.2.0] - 2022-01-04
 
 ### Added

package/build/abstractEntity.d.ts

@@ -3,6 +3,7 @@ import { ErrorMessages, Rules } from 'validatorjs';
  * Class AbstractEntity
  */
 export declare abstract class AbstractEntity<T> {
+    #private;
     protected VALIDATION_RULES: Rules;
     protected VALIDATION_MESSAGES: ErrorMessages;
     /**
@@ -14,6 +15,7 @@ export declare abstract class AbstractEntity<T> {
      * @param data - Data that will be used in the Entity
      */
     protected constructor(data: T);
+    get entityDataInput(): T;
     /**
      * Checks whether or not the entity data passes the validation rules
      * @param data - Data to validate

package/build/abstractEntity.js

@@ -1,7 +1,21 @@
 "use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _entityDataInput;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractEntity = void 0;
 const validatorjs_1 = __importDefault(require("validatorjs"));
@@ -15,6 +29,7 @@ class AbstractEntity {
      * @param data - Data that will be used in the Entity
      */
     constructor(data) {
+        _entityDataInput.set(this, void 0);
         this.VALIDATION_RULES = {};
         this.VALIDATION_MESSAGES = {};
         /**
@@ -22,6 +37,10 @@ class AbstractEntity {
          */
         this.enableValidation = false;
         this.validate(data);
+        __classPrivateFieldSet(this, _entityDataInput, data);
+    }
+    get entityDataInput() {
+        return __classPrivateFieldGet(this, _entityDataInput);
     }
     /**
      * Checks whether or not the entity data passes the validation rules
@@ -49,4 +68,5 @@ class AbstractEntity {
     }
 }
 exports.AbstractEntity = AbstractEntity;
+_entityDataInput = new WeakMap();
 //# sourceMappingURL=abstractEntity.js.map

package/build/licenses/entities/getLicense/licenseGetResult.d.ts

@@ -62,7 +62,7 @@ export declare type LicenseGetData = {
 };
 export declare class LicenseGetResult extends AbstractEntity<LicenseGetData> {
     #private;
-    constructor(data: LicenseGetData);
+    constructor(licenseGetDataInput: LicenseGetData);
     get id(): string;
     get parentLicenseId(): string | null;
     get friendlyName(): string | null;

package/build/licenses/entities/getLicense/licenseGetResult.js

@@ -51,9 +51,9 @@ var LicenseGetFields;
     LicenseGetFields["COLUMN_ARROW_SUB_CATEGORIES"] = "arrowSubCategories";
 })(LicenseGetFields = exports.LicenseGetFields || (exports.LicenseGetFields = {}));
 class LicenseGetResult extends abstractEntity_1.AbstractEntity {
-    constructor(data) {
+    constructor(licenseGetDataInput) {
         var _a;
-        super(data);
+        super(licenseGetDataInput);
         _license_id.set(this, void 0);
         _parent_license_id.set(this, void 0);
         _friendlyName.set(this, void 0);
@@ -80,34 +80,34 @@ class LicenseGetResult extends abstractEntity_1.AbstractEntity {
         _associatedSubscriptionProgram.set(this, void 0);
         _price.set(this, void 0);
         _arrowSubCategories.set(this, void 0);
-        __classPrivateFieldSet(this, _license_id, data[LicenseGetFields.COLUMN_LICENSE_ID]);
-        __classPrivateFieldSet(this, _parent_license_id, data[LicenseGetFields.COLUMN_PARENT_LICENSE_ID]);
-        __classPrivateFieldSet(this, _friendlyName, data[LicenseGetFields.COLUMN_FRIENDLY_NAME]);
-        __classPrivateFieldSet(this, _customer_ref, data[LicenseGetFields.COLUMN_CUSTOMER_REF]);
-        __classPrivateFieldSet(this, _state, data[LicenseGetFields.COLUMN_STATE]);
-        __classPrivateFieldSet(this, _service_ref, data[LicenseGetFields.COLUMN_SERVICE_REF]);
-        __classPrivateFieldSet(this, _sku, data[LicenseGetFields.COLUMN_SKU]);
-        __classPrivateFieldSet(this, _name, data[LicenseGetFields.COLUMN_NAME]);
-        __classPrivateFieldSet(this, _seats, data[LicenseGetFields.COLUMN_SEATS]);
-        __classPrivateFieldSet(this, _activeSeats, new activeSeatsFindResult_1.ActiveSeatsFindResult(data[LicenseGetFields.COLUMN_ACTIVE_SEATS]));
-        __classPrivateFieldSet(this, _activation_datetime, data[LicenseGetFields.COLUMN_ACTIVATION_DATETIME]);
-        __classPrivateFieldSet(this, _expiry_datetime, data[LicenseGetFields.COLUMN_EXPIRY_DATETIME]);
-        __classPrivateFieldSet(this, _autoRenew, data[LicenseGetFields.COLUMN_AUTO_RENEW]);
-        __classPrivateFieldSet(this, _message, data[LicenseGetFields.COLUMN_MESSAGE]);
-        __classPrivateFieldSet(this, _actions, data[LicenseGetFields.COLUMN_ACTIONS]
-            ? new actionsGetResult_1.ActionsGetResult(data[LicenseGetFields.COLUMN_ACTIONS])
+        __classPrivateFieldSet(this, _license_id, licenseGetDataInput[LicenseGetFields.COLUMN_LICENSE_ID]);
+        __classPrivateFieldSet(this, _parent_license_id, licenseGetDataInput[LicenseGetFields.COLUMN_PARENT_LICENSE_ID]);
+        __classPrivateFieldSet(this, _friendlyName, licenseGetDataInput[LicenseGetFields.COLUMN_FRIENDLY_NAME]);
+        __classPrivateFieldSet(this, _customer_ref, licenseGetDataInput[LicenseGetFields.COLUMN_CUSTOMER_REF]);
+        __classPrivateFieldSet(this, _state, licenseGetDataInput[LicenseGetFields.COLUMN_STATE]);
+        __classPrivateFieldSet(this, _service_ref, licenseGetDataInput[LicenseGetFields.COLUMN_SERVICE_REF]);
+        __classPrivateFieldSet(this, _sku, licenseGetDataInput[LicenseGetFields.COLUMN_SKU]);
+        __classPrivateFieldSet(this, _name, licenseGetDataInput[LicenseGetFields.COLUMN_NAME]);
+        __classPrivateFieldSet(this, _seats, licenseGetDataInput[LicenseGetFields.COLUMN_SEATS]);
+        __classPrivateFieldSet(this, _activeSeats, new activeSeatsFindResult_1.ActiveSeatsFindResult(licenseGetDataInput[LicenseGetFields.COLUMN_ACTIVE_SEATS]));
+        __classPrivateFieldSet(this, _activation_datetime, licenseGetDataInput[LicenseGetFields.COLUMN_ACTIVATION_DATETIME]);
+        __classPrivateFieldSet(this, _expiry_datetime, licenseGetDataInput[LicenseGetFields.COLUMN_EXPIRY_DATETIME]);
+        __classPrivateFieldSet(this, _autoRenew, licenseGetDataInput[LicenseGetFields.COLUMN_AUTO_RENEW]);
+        __classPrivateFieldSet(this, _message, licenseGetDataInput[LicenseGetFields.COLUMN_MESSAGE]);
+        __classPrivateFieldSet(this, _actions, licenseGetDataInput[LicenseGetFields.COLUMN_ACTIONS]
+            ? new actionsGetResult_1.ActionsGetResult(licenseGetDataInput[LicenseGetFields.COLUMN_ACTIONS])
             : undefined);
-        __classPrivateFieldSet(this, _actionMessages, (_a = data[LicenseGetFields.COLUMN_ACTION_MESSAGES]) === null || _a === void 0 ? void 0 : _a.map((result) => new actionMessagesGetResult_1.ActionMessagesGetResult(result)));
-        __classPrivateFieldSet(this, _order_reference, data[LicenseGetFields.COLUMN_ORDER_REFERENCE]);
-        __classPrivateFieldSet(this, _order, new orderGetResult_1.OrderGetResult(data[LicenseGetFields.COLUMN_ORDER]));
-        __classPrivateFieldSet(this, _vendor_license_id, data[LicenseGetFields.COLUMN_VENDOR_LICENSE_ID]);
-        __classPrivateFieldSet(this, _periodicity, data[LicenseGetFields.COLUMN_PERIODICITY]);
-        __classPrivateFieldSet(this, _term, data[LicenseGetFields.COLUMN_TERM]);
-        __classPrivateFieldSet(this, _category, data[LicenseGetFields.COLUMN_CATEGORY]);
-        __classPrivateFieldSet(this, _program, data[LicenseGetFields.COLUMN_PROGRAM]);
-        __classPrivateFieldSet(this, _associatedSubscriptionProgram, data[LicenseGetFields.COLUMN_ASSOCIATED_SUBSCRIPTION_PROGRAM]);
-        __classPrivateFieldSet(this, _price, new licensePriceGetResult_1.LicensePriceGetResult(data[LicenseGetFields.COLUMN_PRICE]));
-        __classPrivateFieldSet(this, _arrowSubCategories, data[LicenseGetFields.COLUMN_ARROW_SUB_CATEGORIES]);
+        __classPrivateFieldSet(this, _actionMessages, (_a = licenseGetDataInput[LicenseGetFields.COLUMN_ACTION_MESSAGES]) === null || _a === void 0 ? void 0 : _a.map((result) => new actionMessagesGetResult_1.ActionMessagesGetResult(result)));
+        __classPrivateFieldSet(this, _order_reference, licenseGetDataInput[LicenseGetFields.COLUMN_ORDER_REFERENCE]);
+        __classPrivateFieldSet(this, _order, new orderGetResult_1.OrderGetResult(licenseGetDataInput[LicenseGetFields.COLUMN_ORDER]));
+        __classPrivateFieldSet(this, _vendor_license_id, licenseGetDataInput[LicenseGetFields.COLUMN_VENDOR_LICENSE_ID]);
+        __classPrivateFieldSet(this, _periodicity, licenseGetDataInput[LicenseGetFields.COLUMN_PERIODICITY]);
+        __classPrivateFieldSet(this, _term, licenseGetDataInput[LicenseGetFields.COLUMN_TERM]);
+        __classPrivateFieldSet(this, _category, licenseGetDataInput[LicenseGetFields.COLUMN_CATEGORY]);
+        __classPrivateFieldSet(this, _program, licenseGetDataInput[LicenseGetFields.COLUMN_PROGRAM]);
+        __classPrivateFieldSet(this, _associatedSubscriptionProgram, licenseGetDataInput[LicenseGetFields.COLUMN_ASSOCIATED_SUBSCRIPTION_PROGRAM]);
+        __classPrivateFieldSet(this, _price, new licensePriceGetResult_1.LicensePriceGetResult(licenseGetDataInput[LicenseGetFields.COLUMN_PRICE]));
+        __classPrivateFieldSet(this, _arrowSubCategories, licenseGetDataInput[LicenseGetFields.COLUMN_ARROW_SUB_CATEGORIES]);
     }
     get id() {
         return __classPrivateFieldGet(this, _license_id);

package/build/licenses/entities/getResult/getLicenseResult.d.ts

@@ -0,0 +1,14 @@
+import { AbstractEntity } from '../../../abstractEntity';
+import { LicenseGetData, LicenseGetResult } from '../getLicense/licenseGetResult';
+export declare enum GetLicenseResultFields {
+    COLUMN_LICENSE = "license"
+}
+export declare type GetLicenseResultData = {
+    [GetLicenseResultFields.COLUMN_LICENSE]: LicenseGetData;
+};
+export declare class GetLicenseResult extends AbstractEntity<GetLicenseResultData> {
+    #private;
+    constructor(getLicenseResultDataInput: GetLicenseResultData);
+    get license(): LicenseGetResult;
+    toJSON(): GetLicenseResultData;
+}

package/build/licenses/entities/getResult/getLicenseResult.js

@@ -0,0 +1,41 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _license;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLicenseResult = exports.GetLicenseResultFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+const licenseGetResult_1 = require("../getLicense/licenseGetResult");
+var GetLicenseResultFields;
+(function (GetLicenseResultFields) {
+    GetLicenseResultFields["COLUMN_LICENSE"] = "license";
+})(GetLicenseResultFields = exports.GetLicenseResultFields || (exports.GetLicenseResultFields = {}));
+class GetLicenseResult extends abstractEntity_1.AbstractEntity {
+    constructor(getLicenseResultDataInput) {
+        super(getLicenseResultDataInput);
+        _license.set(this, void 0);
+        __classPrivateFieldSet(this, _license, new licenseGetResult_1.LicenseGetResult(getLicenseResultDataInput[GetLicenseResultFields.COLUMN_LICENSE]));
+    }
+    get license() {
+        return __classPrivateFieldGet(this, _license);
+    }
+    toJSON() {
+        return {
+            [GetLicenseResultFields.COLUMN_LICENSE]: this.license.toJSON(),
+        };
+    }
+}
+exports.GetLicenseResult = GetLicenseResult;
+_license = new WeakMap();
+//# sourceMappingURL=getLicenseResult.js.map

package/build/licenses/entities/getResult.d.ts

@@ -1,22 +1,34 @@
 import { LicenseGetData } from './getLicense/licenseGetResult';
 import { AbstractEntity } from '../../abstractEntity';
+export declare enum GetResultFields {
+    COLUMN_STATUS = "status",
+    COLUMN_DATA = "data"
+}
 /**
- * For future get endpoint, create type like LicenseGet
- * and add this type to TypesGet type
+ * @deprecated please use GetLicenseResultData for license
  */
 export declare type LicenseGet = {
     license: LicenseGetData;
 };
-declare type TypesGet = LicenseGet;
-export declare type GetData<TypesGet> = {
-    status: number;
-    data: TypesGet;
+export declare type GetData<Entity> = {
+    [GetResultFields.COLUMN_STATUS]: number;
+    [GetResultFields.COLUMN_DATA]: Entity;
 };
-export declare class GetResult extends AbstractEntity<GetData<TypesGet>> {
+/**
+ * This interface is use toJSON function in objects (data properties) you want to use
+ */
+interface AbstractEntityGet<Entity extends AbstractEntityGet<Entity>> extends AbstractEntity<Entity['entityDataInput']> {
+    toJSON: () => Entity['entityDataInput'];
+}
+/**
+ * WARNING: use this class only when the Entity in data properties is an object not an array or other type
+ * Use this class for get call when the response of API is a type of GetData<Entity>
+ */
+export declare class GetResult<Entity extends AbstractEntityGet<Entity>> extends AbstractEntity<GetData<Entity['entityDataInput']>> {
     #private;
-    constructor(data: GetData<TypesGet>);
+    constructor(cls: new (data: Entity['entityDataInput']) => Entity, getResultDataInput: GetData<Entity['entityDataInput']>);
     get status(): number;
-    get data(): TypesGet;
-    toJSON(): GetData<TypesGet>;
+    get data(): Entity;
+    toJSON(): GetData<Entity['entityDataInput']>;
 }
 export {};

package/build/licenses/entities/getResult.js

@@ -14,15 +14,24 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _status, _data;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetResult = void 0;
+exports.GetResult = exports.GetResultFields = void 0;
 const abstractEntity_1 = require("../../abstractEntity");
+var GetResultFields;
+(function (GetResultFields) {
+    GetResultFields["COLUMN_STATUS"] = "status";
+    GetResultFields["COLUMN_DATA"] = "data";
+})(GetResultFields = exports.GetResultFields || (exports.GetResultFields = {}));
+/**
+ * WARNING: use this class only when the Entity in data properties is an object not an array or other type
+ * Use this class for get call when the response of API is a type of GetData<Entity>
+ */
 class GetResult extends abstractEntity_1.AbstractEntity {
-    constructor(data) {
-        super(data);
+    constructor(cls, getResultDataInput) {
+        super(getResultDataInput);
         _status.set(this, void 0);
         _data.set(this, void 0);
-        __classPrivateFieldSet(this, _status, data.status);
-        __classPrivateFieldSet(this, _data, data.data);
+        __classPrivateFieldSet(this, _status, getResultDataInput.status);
+        __classPrivateFieldSet(this, _data, new cls(getResultDataInput.data));
     }
     get status() {
         return __classPrivateFieldGet(this, _status);
@@ -31,10 +40,10 @@ class GetResult extends abstractEntity_1.AbstractEntity {
         return __classPrivateFieldGet(this, _data);
     }
     toJSON() {
-        return {
-            status: this.status,
-            data: this.data,
-        };
+        return JSON.parse(JSON.stringify({
+            [GetResultFields.COLUMN_STATUS]: this.status,
+            [GetResultFields.COLUMN_DATA]: this.data.toJSON(),
+        }));
     }
 }
 exports.GetResult = GetResult;

package/build/licenses/licensesClient.d.ts

@@ -11,8 +11,9 @@ import { PriceFindResultDataKeywords, PriceFindResutDataSortParameters } from '.
 import { OfferFindResultDataFiltersParameters, OfferFindResultDataKeywords, OfferFindResultDataSortParameters } from './entities/offer/offerFindResult';
 import { ActionFlagsFindResultDataKeywords, ActionFlagsFindResultDataSortParameters } from './entities/offer/actionFlagsFindResult';
 import { PriceBandFindResultDataKeywords, PriceBandFindResultDataSortParameters } from './entities/offer/priceBandFindResult';
-import { GetData, LicenseGet } from './entities/getResult';
+import { GetResult } from './entities/getResult';
 import { LicenseGetFields } from './entities/getLicense/licenseGetResult';
+import { GetLicenseResult } from './entities/getResult/getLicenseResult';
 /**
  * Parameters passable to the request for refining search.
  */
@@ -204,6 +205,18 @@ export declare class LicensesClient extends AbstractClient {
      * The path of the Seats endpoint
      */
     private SEATS_PATH;
+    /**
+     * The path of suspend endpoint
+     */
+    private SUSPEND_PATH;
+    /**
+     * The path of reactivate endpoint
+     */
+    private REACTIVATE_PATH;
+    /**
+     * The path of cancel endpoint
+     */
+    private CANCEL_PATH;
     /**
      * Returns the raw result from the find endpoint call
      *
@@ -229,6 +242,9 @@ export declare class LicensesClient extends AbstractClient {
     getConfigs(reference: string): AsyncGenerator<ConfigFindResultData>;
     updateConfigRaw(reference: string, config: ConfigFindResult): Promise<ConfigFindResultData>;
     updateConfig(reference: string, config: ConfigFindResult): Promise<ConfigFindResult>;
-    getLicense(licenseReference: string, parameters?: Parameters): Promise<GetData<LicenseGet>>;
+    getLicense(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetLicenseResult>>;
     updateSeats(licenseReference: string, putData: UpdateSeatsData, parameters?: Parameters): Promise<void>;
+    suspendLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
+    reactivateLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
+    cancelLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
 }

package/build/licenses/licensesClient.js

@@ -9,6 +9,7 @@ const findResult_1 = require("./entities/findResult");
 const configFindResult_1 = require("./entities/license/configFindResult");
 const getResult_1 = require("./entities/getResult");
 const licenseGetResult_1 = require("./entities/getLicense/licenseGetResult");
+const getLicenseResult_1 = require("./entities/getResult/getLicenseResult");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -126,6 +127,18 @@ class LicensesClient extends abstractClient_1.AbstractClient {
          * The path of the Seats endpoint
          */
         this.SEATS_PATH = '/seats';
+        /**
+         * The path of suspend endpoint
+         */
+        this.SUSPEND_PATH = '/suspend';
+        /**
+         * The path of reactivate endpoint
+         */
+        this.REACTIVATE_PATH = '/reactivate';
+        /**
+         * The path of cancel endpoint
+         */
+        this.CANCEL_PATH = '/cancel';
     }
     /**
      * Returns the raw result from the find endpoint call
@@ -225,12 +238,24 @@ class LicensesClient extends abstractClient_1.AbstractClient {
     }
     async getLicense(licenseReference, parameters = {}) {
         this.path = licenseReference;
-        return new getResult_1.GetResult(await this.get(parameters)).toJSON();
+        return new getResult_1.GetResult(getLicenseResult_1.GetLicenseResult, await this.get(parameters));
     }
     updateSeats(licenseReference, putData, parameters = {}) {
         this.path = licenseReference + this.SEATS_PATH;
         return this.put(putData, parameters);
     }
+    suspendLicense(licenseReference, parameters = {}) {
+        this.path = licenseReference + this.SUSPEND_PATH;
+        return this.put(undefined, parameters);
+    }
+    reactivateLicense(licenseReference, parameters = {}) {
+        this.path = licenseReference + this.REACTIVATE_PATH;
+        return this.put(undefined, parameters);
+    }
+    cancelLicense(licenseReference, parameters = {}) {
+        this.path = licenseReference + this.CANCEL_PATH;
+        return this.put(undefined, parameters);
+    }
 }
 exports.LicensesClient = LicensesClient;
 //# sourceMappingURL=licensesClient.js.map

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "2.2.0",
+  "version": "2.5.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",