@arrowsphere/api-client 1.0.2 → 2.1.0

package/build/licenses/licensesClient.js

@@ -6,6 +6,7 @@ exports.LicensesClient = exports.LicenseFindParameters = void 0;
  */
 const abstractClient_1 = require("../abstractClient");
 const findResult_1 = require("./entities/findResult");
+const configFindResult_1 = require("./entities/license/configFindResult");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -59,6 +60,46 @@ var LicenseFindParameters;
      * Use this operator to search for all keywords with values in the range specified (for date ranges)
      */
     LicenseFindParameters["OPERATOR_BETWEEN"] = "BETWEEN";
+    /**
+     * Use this operator to search with a compare field Equal
+     */
+    LicenseFindParameters["OPERATOR_EQ"] = "EQ";
+    /**
+     * Use this operator to search with a compare field Not Equal
+     */
+    LicenseFindParameters["OPERATOR_NEQ"] = "NEQ";
+    /**
+     * Use this operator to search with a compare field Greater Than
+     */
+    LicenseFindParameters["OPERATOR_GT"] = "GT";
+    /**
+     * Use this operator to search with a compare field Greater Than or Equal
+     */
+    LicenseFindParameters["OPERATOR_GTE"] = "GTE";
+    /**
+     * Use this operator to search with a compare field Lower Than
+     */
+    LicenseFindParameters["OPERATOR_LT"] = "LT";
+    /**
+     * Use this operator to search with a compare field Lower Than or Equal
+     */
+    LicenseFindParameters["OPERATOR_LTE"] = "LTE";
+    /**
+     * Use this filter to compare 2 value with other filter like FILTERS_GTE / FILTERS_LT / FILTERS_LTE
+     */
+    LicenseFindParameters["FILTERS_GT"] = "gt";
+    /**
+     * Use this filter to compare 2 value with other filter like FILTERS_GT / FILTERS_LT / FILTERS_LTE
+     */
+    LicenseFindParameters["FILTERS_GTE"] = "gte";
+    /**
+     * Use this filter to compare 2 value with other filter like FILTERS_GT / FILTERS_GTE / FILTERS_LTE
+     */
+    LicenseFindParameters["FILTERS_LT"] = "lt";
+    /**
+     * Use this filter to compare 2 value with other filter like FILTERS_GT / FILTERS_GTE / FILTERS_LT
+     */
+    LicenseFindParameters["FILTERS_LTE"] = "lte";
 })(LicenseFindParameters = exports.LicenseFindParameters || (exports.LicenseFindParameters = {}));
 class LicensesClient extends abstractClient_1.AbstractClient {
     constructor() {
@@ -75,6 +116,10 @@ class LicensesClient extends abstractClient_1.AbstractClient {
          * The path of the Find endpoint
          */
         this.FIND_PATH = 'v2/find';
+        /**
+         * The path of the Configs endpoint
+         */
+        this.CONFIGS_PATH = '/configs';
     }
     /**
      * Returns the raw result from the find endpoint call
@@ -100,12 +145,11 @@ class LicensesClient extends abstractClient_1.AbstractClient {
      *
      */
     async find(postData = {}, perPage = 100, page = 1, parameters = {}) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         this.setPerPage(perPage);
         this.setPage(page);
         const rawLicensePayload = {
             keyword: postData.keyword,
-            sort: postData.sort,
             highlight: postData.highlight,
         };
         if (postData.keywords) {
@@ -124,12 +168,25 @@ class LicensesClient extends abstractClient_1.AbstractClient {
         if (postData.filters) {
             // Flatten with prefix for each type of filter (license and offer)
             rawLicensePayload.filters = {
-                ...Object.entries((_c = postData.filters.license) !== null && _c !== void 0 ? _c : {}).reduce((acc, [keyword, value]) => {
-                    acc[`license.${keyword}`] = value;
+                ...Object.entries((_c = postData.filters.license) !== null && _c !== void 0 ? _c : {}).reduce((acc, [filter, value]) => {
+                    acc[`license.${filter}`] = value;
                     return acc;
                 }, {}),
-                ...Object.entries((_d = postData.filters.offer) !== null && _d !== void 0 ? _d : {}).reduce((acc, [keyword, value]) => {
-                    acc[`offer.${keyword}`] = value;
+                ...Object.entries((_d = postData.filters.offer) !== null && _d !== void 0 ? _d : {}).reduce((acc, [filter, value]) => {
+                    acc[`offer.${filter}`] = value;
+                    return acc;
+                }, {}),
+            };
+        }
+        if (postData.sort) {
+            // Flatten with prefix for each type of sort keys (license and offer)
+            rawLicensePayload.sort = {
+                ...Object.entries((_e = postData.sort.license) !== null && _e !== void 0 ? _e : {}).reduce((acc, [sort, value]) => {
+                    acc[`license.${sort}`] = value;
+                    return acc;
+                }, {}),
+                ...Object.entries((_f = postData.sort.offer) !== null && _f !== void 0 ? _f : {}).reduce((acc, [sort, value]) => {
+                    acc[`offer.${sort}`] = value;
                     return acc;
                 }, {}),
             };
@@ -137,6 +194,33 @@ class LicensesClient extends abstractClient_1.AbstractClient {
         const response = await this.findRaw(rawLicensePayload, parameters);
         return new findResult_1.FindResult(response, this, rawLicensePayload, parameters);
     }
+    getConfigsRaw(reference) {
+        this.path = reference + this.CONFIGS_PATH;
+        return this.get();
+    }
+    async *getConfigs(reference) {
+        const rawResponse = await this.getConfigsRaw(reference);
+        for (const response of rawResponse.data) {
+            yield new configFindResult_1.ConfigFindResult(response).toJSON();
+        }
+    }
+    async updateConfigRaw(reference, config) {
+        this.path = reference + this.CONFIGS_PATH;
+        const postData = {
+            [configFindResult_1.ConfigFindResultFields.COLUMN_NAME]: config.name,
+            [configFindResult_1.ConfigFindResultFields.COLUMN_SCOPE]: config.scope,
+            [configFindResult_1.ConfigFindResultFields.COLUMN_STATE]: config.state,
+        };
+        return await this.post(postData);
+    }
+    async updateConfig(reference, config) {
+        const rawResponse = await this.updateConfigRaw(reference, config);
+        return new configFindResult_1.ConfigFindResult(rawResponse);
+    }
+    getLicense(licenseReference, parameters = {}) {
+        this.path = licenseReference;
+        return this.get(parameters);
+    }
 }
 exports.LicensesClient = LicensesClient;
 //# sourceMappingURL=licensesClient.js.map

package/build/publicApiClient.js

@@ -17,7 +17,9 @@ class PublicApiClient extends abstractClient_1.AbstractClient {
      * @returns {@link WhoAmIClient}
      */
     getWhoamiClient() {
-        return new general_1.WhoAmIClient(this.client).setUrl(this.url).setApiKey(this.apiKey);
+        return new general_1.WhoAmIClient(this.client)
+            .setUrl(this.url)
+            .setApiKey(this.apiKey);
     }
     /**
      * Creates a new {@link LicensesClient} instance and returns it

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "1.0.2",
+  "version": "2.1.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -14,7 +14,7 @@
     "doc": "typedoc ./src/index.ts ./src/**/index.ts",
     "lint": "eslint ./{src,tests}/**/*.ts && prettier --list-different ./{src,tests}/**/*.ts",
     "lint:fix": "eslint ./{src,tests}/**/*.ts --fix && prettier --write ./{src,tests}/**/*.ts",
-    "prepublishOnly": "npm run clean && npm run build",
+    "prepare": "npm run clean && npm run build",
     "test": "mocha -r ts-node/register \"tests/**/*.ts\"",
     "test:watch": "mocha --watch -r ts-node/register \"tests/**/*.ts\"",
     "test:coverage": "nyc --check-coverage npm run test",

package/build/licenses/entities/license/abstractLicense.d.ts

@@ -1,177 +0,0 @@
-import { AbstractEntity } from '../../../abstractEntity';
-/**
- * Fields that can be present in License response and request data.
- */
-export declare enum LicenseFields {
-    COLUMN_ACCEPT_EULA = "accept_eula",
-    COLUMN_AUTO_RENEW = "auto_renew",
-    COLUMN_BASE_SEAT = "base_seat",
-    COLUMN_CATEGORY = "category",
-    COLUMN_CLOUD_TYPE = "cloud_type",
-    COLUMN_CUSTOMER_NAME = "customer_name",
-    COLUMN_CUSTOMER_REF = "customer_ref",
-    COLUMN_END_DATE = "end_date",
-    COLUMN_FRIENDLY_NAME = "friendly_name",
-    COLUMN_ID = "id",
-    COLUMN_IS_ENABLED = "isEnabled",
-    COLUMN_LAST_UPDATE = "lastUpdate",
-    COLUMN_PARENT_LINE_ID = "parent_line_id",
-    COLUMN_MARKETPLACE = "marketplace",
-    COLUMN_MESSAGE = "message",
-    COLUMN_OFFER = "offer",
-    COLUMN_PARENT_ORDER_REF = "parent_order_ref",
-    COLUMN_PARTNER_REF = "partner_ref",
-    COLUMN_PERIODICITY = "periodicity",
-    COLUMN_RESELLER_NAME = "reseller_name",
-    COLUMN_RESELLER_REF = "reseller_ref",
-    COLUMN_SEAT = "seat",
-    COLUMN_SERVICE_REF = "service_ref",
-    COLUMN_SKU = "sku",
-    COLUMN_START_DATE = "start_date",
-    COLUMN_STATUS_CODE = "status_code",
-    COLUMN_STATUS_LABEL = "status_label",
-    COLUMN_SUBSCRIPTION_ID = "subscription_id",
-    COLUMN_SUBSIDIARY_NAME = "subsidiary_name",
-    COLUMN_TERM = "term",
-    COLUMN_TRIAL = "trial",
-    COLUMN_TYPE = "type",
-    COLUMN_UOM = "uom",
-    COLUMN_VENDOR_CODE = "vendor_code",
-    COLUMN_VENDOR_NAME = "vendor_name",
-    COLUMN_VENDOR_SUBSCRIPTION_ID = "vendor_subscription_id",
-    COLUMN_PRICE = "price",
-    PRICE_BUY_PRICE = "buy_price",
-    PRICE_LIST_PRICE = "list_price",
-    PRICE_CURRENCY = "currency",
-    COLUMN_ACTIVE_SEATS = "active_seats",
-    ACTIVE_SEATS_LAST_UPDATE = "lastUpdate",
-    ACTIVE_SEATS_NUMBER = "number"
-}
-/**
- * License data fields and their corresponding types
- */
-export declare type LicenseData = {
-    [LicenseFields.COLUMN_ID]: number;
-    [LicenseFields.COLUMN_ACCEPT_EULA]: boolean;
-    [LicenseFields.COLUMN_ACTIVE_SEATS]: {
-        [LicenseFields.ACTIVE_SEATS_LAST_UPDATE]: string | null;
-        [LicenseFields.ACTIVE_SEATS_NUMBER]: number | null;
-    };
-    [LicenseFields.COLUMN_AUTO_RENEW]: boolean;
-    [LicenseFields.COLUMN_BASE_SEAT]: number;
-    [LicenseFields.COLUMN_CATEGORY]: string;
-    [LicenseFields.COLUMN_CLOUD_TYPE]: string;
-    [LicenseFields.COLUMN_CUSTOMER_NAME]: string;
-    [LicenseFields.COLUMN_CUSTOMER_REF]: string;
-    [LicenseFields.COLUMN_END_DATE]: string;
-    [LicenseFields.COLUMN_FRIENDLY_NAME]: string | null;
-    [LicenseFields.COLUMN_IS_ENABLED]: boolean;
-    [LicenseFields.COLUMN_LAST_UPDATE]: string | null;
-    [LicenseFields.COLUMN_MARKETPLACE]: string;
-    [LicenseFields.COLUMN_MESSAGE]: string;
-    [LicenseFields.COLUMN_OFFER]: string;
-    [LicenseFields.COLUMN_PARENT_LINE_ID]: number | null;
-    [LicenseFields.COLUMN_PARENT_ORDER_REF]: string | null;
-    [LicenseFields.COLUMN_PARTNER_REF]: string;
-    [LicenseFields.COLUMN_PERIODICITY]: number;
-    [LicenseFields.COLUMN_PRICE]: {
-        [LicenseFields.PRICE_BUY_PRICE]: number;
-        [LicenseFields.PRICE_LIST_PRICE]: number;
-        [LicenseFields.PRICE_CURRENCY]: string | null;
-    };
-    [LicenseFields.COLUMN_RESELLER_NAME]: string;
-    [LicenseFields.COLUMN_RESELLER_REF]: string;
-    [LicenseFields.COLUMN_SEAT]: number;
-    [LicenseFields.COLUMN_SERVICE_REF]: string;
-    [LicenseFields.COLUMN_SKU]: string;
-    [LicenseFields.COLUMN_START_DATE]: string;
-    [LicenseFields.COLUMN_STATUS_CODE]: number;
-    [LicenseFields.COLUMN_STATUS_LABEL]: string;
-    [LicenseFields.COLUMN_SUBSCRIPTION_ID]: string;
-    [LicenseFields.COLUMN_SUBSIDIARY_NAME]: string;
-    [LicenseFields.COLUMN_TERM]: number;
-    [LicenseFields.COLUMN_TRIAL]: boolean;
-    [LicenseFields.COLUMN_TYPE]: string;
-    [LicenseFields.COLUMN_UOM]: string;
-    [LicenseFields.COLUMN_VENDOR_CODE]: string;
-    [LicenseFields.COLUMN_VENDOR_NAME]: string;
-    [LicenseFields.COLUMN_VENDOR_SUBSCRIPTION_ID]: string | null;
-};
-/**
- * Abstract class of a License entity. Can only be instantiated through a {@link LicenseFindResult} object class
- */
-export declare abstract class AbstractLicense extends AbstractEntity<LicenseData> {
-    #private;
-    protected VALIDATION_RULES: {
-        [x: string]: string;
-        id: string;
-        subscription_id: string;
-        vendor_name: string;
-        vendor_code: string;
-        subsidiary_name: string;
-        partner_ref: string;
-        status_code: string;
-        status_label: string;
-        sku: string;
-        cloud_type: string;
-        base_seat: string;
-        seat: string;
-        trial: string;
-        auto_renew: string;
-        offer: string;
-        accept_eula: string;
-        price: string;
-    };
-    /**
-     * AbstractLicense constructor.
-     *
-     * @param data - License data to construct the entity with.
-     */
-    protected constructor(data: LicenseData);
-    get id(): number;
-    get acceptEula(): boolean;
-    get activeSeatsLastUpdate(): string | null;
-    get activeSeatsNumber(): number | null;
-    get autoRenew(): boolean;
-    get baseSeat(): number;
-    get buyPrice(): number;
-    get category(): string;
-    get classification(): string;
-    get currency(): string | null;
-    get customerName(): string;
-    get customerRef(): string;
-    get endDate(): string;
-    get friendlyName(): string | null;
-    get enabled(): boolean;
-    get lastUpdate(): string | null;
-    get listPrice(): number;
-    get marketplace(): string;
-    get message(): string;
-    get offer(): string;
-    get parentLineId(): number | null;
-    get parentOrderRef(): string | null;
-    get partnerRef(): string;
-    get periodicity(): number;
-    get resellerName(): string;
-    get resellerRef(): string;
-    get seat(): number;
-    get serviceRef(): string;
-    get sku(): string;
-    get startDate(): string;
-    get statusCode(): number;
-    get statusLabel(): string;
-    get subscriptionId(): string;
-    get subsidiaryName(): string;
-    get term(): number;
-    isTrial(): boolean;
-    get type(): string;
-    get uom(): string;
-    get vendorCode(): string;
-    get vendorName(): string;
-    get vendorSubscriptionId(): string | null;
-    /**
-     * Plain JSON object representation of the license entity.
-     * @returns {@link LicenseData}
-     */
-    toJSON(): LicenseData;
-}