@arrowsphere/api-client 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 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.7.0] - 2022-03-03
+
+### Added
+
+- Update object license for getLicense endpoint
+- Add endpoint update license friendlyName
+
 ## [2.6.0] - 2022-02-22
 
 ### Added

package/build/abstractClient.js

@@ -121,10 +121,10 @@ class AbstractClient {
     getResponse(response) {
         const statusCode = response.status;
         if (statusCode === 404) {
-            throw new exception_1.NotFoundException(`Resource not found on URL ${this.getUrl()}`);
+            throw new exception_1.NotFoundException(`Resource not found on URL ${this.getUrl()}`, response.data.error, statusCode);
         }
         if (statusCode >= 400 && statusCode <= 599) {
-            throw new exception_1.PublicApiClientException(`Error: status code: ${statusCode}. URL: ${this.getUrl()}`);
+            throw new exception_1.PublicApiClientException(`Error: status code: ${statusCode}. URL: ${this.getUrl()}`, response.data.error, statusCode);
         }
         return response.data;
     }

package/build/exception/entityValidationException.d.ts

@@ -1,3 +1,5 @@
 export declare class EntityValidationException extends Error {
-    constructor(message: string);
+    httpCode: number;
+    httpError: string;
+    constructor(message: string, httpError?: string, httpCode?: number);
 }

package/build/exception/entityValidationException.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityValidationException = void 0;
 class EntityValidationException extends Error {
-    constructor(message) {
+    constructor(message, httpError = '', httpCode = 0) {
         super(message);
+        this.httpCode = httpCode;
+        this.httpError = httpError;
     }
 }
 exports.EntityValidationException = EntityValidationException;

package/build/exception/notFoundException.d.ts

@@ -1,3 +1,5 @@
 export declare class NotFoundException extends Error {
-    constructor(message: string);
+    httpCode: number;
+    httpError: string;
+    constructor(message: string, httpError?: string, httpCode?: number);
 }

package/build/exception/notFoundException.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundException = void 0;
 class NotFoundException extends Error {
-    constructor(message) {
+    constructor(message, httpError = '', httpCode = 0) {
         super(message);
+        this.httpCode = httpCode;
+        this.httpError = httpError;
     }
 }
 exports.NotFoundException = NotFoundException;

package/build/exception/publicApiClientException.d.ts

@@ -1,3 +1,5 @@
 export declare class PublicApiClientException extends Error {
-    constructor(message: string);
+    httpCode: number;
+    httpError: string;
+    constructor(message: string, httpError?: string, httpCode?: number);
 }

package/build/exception/publicApiClientException.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PublicApiClientException = void 0;
 class PublicApiClientException extends Error {
-    constructor(message) {
+    constructor(message, httpError = '', httpCode = 0) {
         super(message);
+        this.httpCode = httpCode;
+        this.httpError = httpError;
     }
 }
 exports.PublicApiClientException = PublicApiClientException;

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

@@ -10,6 +10,10 @@ export declare enum LicenseGetFields {
     COLUMN_FRIENDLY_NAME = "friendlyName",
     COLUMN_CUSTOMER_REF = "customer_ref",
     COLUMN_STATE = "state",
+    COLUMN_STATUS_CODE = "statusCode",
+    COLUMN_IS_TRIAL = "isTrial",
+    COLUMN_IS_ADDON = "isAddon",
+    COLUMN_CURRENCY = "currency",
     COLUMN_SERVICE_REF = "service_ref",
     COLUMN_SKU = "sku",
     COLUMN_NAME = "name",
@@ -38,6 +42,10 @@ export declare type LicenseGetData = {
     [LicenseGetFields.COLUMN_FRIENDLY_NAME]: string | null;
     [LicenseGetFields.COLUMN_CUSTOMER_REF]: string;
     [LicenseGetFields.COLUMN_STATE]: string;
+    [LicenseGetFields.COLUMN_STATUS_CODE]: number;
+    [LicenseGetFields.COLUMN_IS_TRIAL]: boolean;
+    [LicenseGetFields.COLUMN_IS_ADDON]: boolean;
+    [LicenseGetFields.COLUMN_CURRENCY]: string;
     [LicenseGetFields.COLUMN_SERVICE_REF]: string;
     [LicenseGetFields.COLUMN_SKU]: string;
     [LicenseGetFields.COLUMN_NAME]: string;
@@ -68,6 +76,10 @@ export declare class LicenseGetResult extends AbstractEntity<LicenseGetData> {
     get friendlyName(): string | null;
     get customerRef(): string;
     get state(): string;
+    get statusCode(): number;
+    get isTrial(): boolean;
+    get isAddon(): boolean;
+    get currency(): string;
     get serviceRef(): string;
     get sku(): string;
     get name(): string;

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

@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     }
     return privateMap.get(receiver);
 };
-var _license_id, _parent_license_id, _friendlyName, _customer_ref, _state, _service_ref, _sku, _name, _seats, _activeSeats, _activation_datetime, _expiry_datetime, _autoRenew, _message, _actions, _actionMessages, _order_reference, _order, _vendor_license_id, _periodicity, _term, _category, _program, _associatedSubscriptionProgram, _price, _arrowSubCategories;
+var _license_id, _parent_license_id, _friendlyName, _customer_ref, _state, _statusCode, _isTrial, _isAddon, _currency, _service_ref, _sku, _name, _seats, _activeSeats, _activation_datetime, _expiry_datetime, _autoRenew, _message, _actions, _actionMessages, _order_reference, _order, _vendor_license_id, _periodicity, _term, _category, _program, _associatedSubscriptionProgram, _price, _arrowSubCategories;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LicenseGetResult = exports.LicenseGetFields = void 0;
 const actionsGetResult_1 = require("./actionsGetResult");
@@ -28,6 +28,10 @@ var LicenseGetFields;
     LicenseGetFields["COLUMN_FRIENDLY_NAME"] = "friendlyName";
     LicenseGetFields["COLUMN_CUSTOMER_REF"] = "customer_ref";
     LicenseGetFields["COLUMN_STATE"] = "state";
+    LicenseGetFields["COLUMN_STATUS_CODE"] = "statusCode";
+    LicenseGetFields["COLUMN_IS_TRIAL"] = "isTrial";
+    LicenseGetFields["COLUMN_IS_ADDON"] = "isAddon";
+    LicenseGetFields["COLUMN_CURRENCY"] = "currency";
     LicenseGetFields["COLUMN_SERVICE_REF"] = "service_ref";
     LicenseGetFields["COLUMN_SKU"] = "sku";
     LicenseGetFields["COLUMN_NAME"] = "name";
@@ -59,6 +63,10 @@ class LicenseGetResult extends abstractEntity_1.AbstractEntity {
         _friendlyName.set(this, void 0);
         _customer_ref.set(this, void 0);
         _state.set(this, void 0);
+        _statusCode.set(this, void 0);
+        _isTrial.set(this, void 0);
+        _isAddon.set(this, void 0);
+        _currency.set(this, void 0);
         _service_ref.set(this, void 0);
         _sku.set(this, void 0);
         _name.set(this, void 0);
@@ -85,6 +93,10 @@ class LicenseGetResult extends abstractEntity_1.AbstractEntity {
         __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, _statusCode, licenseGetDataInput[LicenseGetFields.COLUMN_STATUS_CODE]);
+        __classPrivateFieldSet(this, _isTrial, licenseGetDataInput[LicenseGetFields.COLUMN_IS_TRIAL]);
+        __classPrivateFieldSet(this, _isAddon, licenseGetDataInput[LicenseGetFields.COLUMN_IS_ADDON]);
+        __classPrivateFieldSet(this, _currency, licenseGetDataInput[LicenseGetFields.COLUMN_CURRENCY]);
         __classPrivateFieldSet(this, _service_ref, licenseGetDataInput[LicenseGetFields.COLUMN_SERVICE_REF]);
         __classPrivateFieldSet(this, _sku, licenseGetDataInput[LicenseGetFields.COLUMN_SKU]);
         __classPrivateFieldSet(this, _name, licenseGetDataInput[LicenseGetFields.COLUMN_NAME]);
@@ -124,6 +136,18 @@ class LicenseGetResult extends abstractEntity_1.AbstractEntity {
     get state() {
         return __classPrivateFieldGet(this, _state);
     }
+    get statusCode() {
+        return __classPrivateFieldGet(this, _statusCode);
+    }
+    get isTrial() {
+        return __classPrivateFieldGet(this, _isTrial);
+    }
+    get isAddon() {
+        return __classPrivateFieldGet(this, _isAddon);
+    }
+    get currency() {
+        return __classPrivateFieldGet(this, _currency);
+    }
     get serviceRef() {
         return __classPrivateFieldGet(this, _service_ref);
     }
@@ -195,6 +219,10 @@ class LicenseGetResult extends abstractEntity_1.AbstractEntity {
             [LicenseGetFields.COLUMN_FRIENDLY_NAME]: this.friendlyName,
             [LicenseGetFields.COLUMN_CUSTOMER_REF]: this.customerRef,
             [LicenseGetFields.COLUMN_STATE]: this.state,
+            [LicenseGetFields.COLUMN_STATUS_CODE]: this.statusCode,
+            [LicenseGetFields.COLUMN_IS_TRIAL]: this.isTrial,
+            [LicenseGetFields.COLUMN_IS_ADDON]: this.isAddon,
+            [LicenseGetFields.COLUMN_CURRENCY]: this.currency,
             [LicenseGetFields.COLUMN_SERVICE_REF]: this.serviceRef,
             [LicenseGetFields.COLUMN_SKU]: this.sku,
             [LicenseGetFields.COLUMN_NAME]: this.name,
@@ -221,5 +249,5 @@ class LicenseGetResult extends abstractEntity_1.AbstractEntity {
     }
 }
 exports.LicenseGetResult = LicenseGetResult;
-_license_id = new WeakMap(), _parent_license_id = new WeakMap(), _friendlyName = new WeakMap(), _customer_ref = new WeakMap(), _state = new WeakMap(), _service_ref = new WeakMap(), _sku = new WeakMap(), _name = new WeakMap(), _seats = new WeakMap(), _activeSeats = new WeakMap(), _activation_datetime = new WeakMap(), _expiry_datetime = new WeakMap(), _autoRenew = new WeakMap(), _message = new WeakMap(), _actions = new WeakMap(), _actionMessages = new WeakMap(), _order_reference = new WeakMap(), _order = new WeakMap(), _vendor_license_id = new WeakMap(), _periodicity = new WeakMap(), _term = new WeakMap(), _category = new WeakMap(), _program = new WeakMap(), _associatedSubscriptionProgram = new WeakMap(), _price = new WeakMap(), _arrowSubCategories = new WeakMap();
+_license_id = new WeakMap(), _parent_license_id = new WeakMap(), _friendlyName = new WeakMap(), _customer_ref = new WeakMap(), _state = new WeakMap(), _statusCode = new WeakMap(), _isTrial = new WeakMap(), _isAddon = new WeakMap(), _currency = new WeakMap(), _service_ref = new WeakMap(), _sku = new WeakMap(), _name = new WeakMap(), _seats = new WeakMap(), _activeSeats = new WeakMap(), _activation_datetime = new WeakMap(), _expiry_datetime = new WeakMap(), _autoRenew = new WeakMap(), _message = new WeakMap(), _actions = new WeakMap(), _actionMessages = new WeakMap(), _order_reference = new WeakMap(), _order = new WeakMap(), _vendor_license_id = new WeakMap(), _periodicity = new WeakMap(), _term = new WeakMap(), _category = new WeakMap(), _program = new WeakMap(), _associatedSubscriptionProgram = new WeakMap(), _price = new WeakMap(), _arrowSubCategories = new WeakMap();
 //# sourceMappingURL=licenseGetResult.js.map

package/build/licenses/licensesClient.d.ts

@@ -184,6 +184,9 @@ export declare type LicenseFindRawPayload = {
 export declare type UpdateSeatsData = {
     [LicenseGetFields.COLUMN_SEATS]: number;
 };
+export declare type PutFriendlyName = {
+    [LicenseGetFields.COLUMN_FRIENDLY_NAME]: string;
+};
 export declare class LicensesClient extends AbstractClient {
     /**
      * The base path of the Licenses API
@@ -217,6 +220,10 @@ export declare class LicensesClient extends AbstractClient {
      * The path of cancel endpoint
      */
     private CANCEL_PATH;
+    /**
+     * The path of update friendlyName endpoint
+     */
+    private UPDATE_FRIENDLYNAME;
     /**
      * Returns the raw result from the find endpoint call
      *
@@ -247,4 +254,5 @@ export declare class LicensesClient extends AbstractClient {
     suspendLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
     reactivateLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
     cancelLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
+    updateFriendlyName(licenseReference: string, putData: PutFriendlyName, parameters?: Parameters): Promise<void>;
 }

package/build/licenses/licensesClient.js

@@ -139,6 +139,10 @@ class LicensesClient extends abstractClient_1.AbstractClient {
          * The path of cancel endpoint
          */
         this.CANCEL_PATH = '/cancel';
+        /**
+         * The path of update friendlyName endpoint
+         */
+        this.UPDATE_FRIENDLYNAME = '/friendlyName';
     }
     /**
      * Returns the raw result from the find endpoint call
@@ -256,6 +260,10 @@ class LicensesClient extends abstractClient_1.AbstractClient {
         this.path = licenseReference + this.CANCEL_PATH;
         return this.put(undefined, parameters);
     }
+    async updateFriendlyName(licenseReference, putData, parameters = {}) {
+        this.path = licenseReference + this.UPDATE_FRIENDLYNAME;
+        return await this.put(putData, 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.6.0",
+  "version": "2.7.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",