@arrowsphere/api-client 3.88.0-rc.fdi.2 → 3.89.0

package/CHANGELOG.md

@@ -3,10 +3,15 @@
 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).
 
-## [3.88.0] - 2024.01.09
+## [3.89.0] - 2024.01.11
 
 ### Added
-- add organization unit endpoint for updating in mass
+- [Organization Unit] add countLicenses fields to get List organization unit
+
+## [3.88.0] - 2024.01.08
+
+### Added
+- [license] add bulk action on licenses
 
 ## [3.87.0] - 2024.01.08
 

package/build/abstractRestfulClient.js

@@ -321,6 +321,9 @@ class AbstractRestfulClient extends AbstractHttpClient_1.AbstractHttpClient {
                 ? ParameterKeys.PER_PAGE_CAMEL
                 : ParameterKeys.PER_PAGE] = `${this.perPage}`;
         }
+        // to keep client stateless
+        this.page = 1;
+        this.perPage = 0;
         return params;
     }
 }

package/build/licenses/index.d.ts

@@ -41,3 +41,4 @@ export * from './licenseRequestClient';
 export * from './licensesClient';
 export * from './entities/license/securityFindResult';
 export * from './licensesEventClient';
+export * from './types/bulkArguments';

package/build/licenses/index.js

@@ -57,4 +57,5 @@ __exportStar(require("./licenseRequestClient"), exports);
 __exportStar(require("./licensesClient"), exports);
 __exportStar(require("./entities/license/securityFindResult"), exports);
 __exportStar(require("./licensesEventClient"), exports);
+__exportStar(require("./types/bulkArguments"), exports);
 //# sourceMappingURL=index.js.map

package/build/licenses/licensesClient.d.ts

@@ -22,6 +22,7 @@ import { CredentialsResult } from './entities/license/credentialsResult';
 import { ScheduleTasksResult } from './entities/schedule/scheduleTasksResult';
 import { GetPricingRateResult, RateTypeEnum } from './entities/pricingRate/getPricingRateResult';
 import { PartialResponse } from '../partialResponse';
+import { BulkBodyArgument } from './types/bulkArguments';
 /**
  * Parameters passable to the request for refining search.
  */
@@ -301,6 +302,10 @@ export declare class LicensesClient extends AbstractRestfulClient {
      * The path to get/set pricing rate on a license
      */
     private PRICING_RATE_PATH;
+    /**
+     * The path to apply bulk action on license(s)
+     */
+    private BULK_PATH;
     /**
      * Returns the raw result from the find endpoint call
      *
@@ -325,6 +330,7 @@ export declare class LicensesClient extends AbstractRestfulClient {
     getConfigsRaw(reference: string): Promise<FindConfig>;
     getConfigs(reference: string): AsyncGenerator<ConfigFindResultData>;
     updateConfigRaw(reference: string, config: ConfigFindResult): Promise<ConfigFindResultData>;
+    bulkAction(bulkData: BulkBodyArgument): Promise<void>;
     updateConfig(reference: string, config: ConfigFindResult): Promise<ConfigFindResult>;
     getLicense(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetLicenseResult>>;
     updateLicense(licenseReference: string, payload: UpdateLicenseData, parameters?: Parameters): Promise<void | PartialResponse>;

package/build/licenses/licensesClient.js

@@ -18,6 +18,7 @@ const scheduleTasksResult_1 = require("./entities/schedule/scheduleTasksResult")
 const getPricingRateResult_1 = require("./entities/pricingRate/getPricingRateResult");
 const partialResponse_1 = require("../partialResponse");
 const http2_1 = require("http2");
+const bulkArguments_1 = require("./types/bulkArguments");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -196,6 +197,10 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
          * The path to get/set pricing rate on a license
          */
         this.PRICING_RATE_PATH = '/pricing-rate';
+        /**
+         * The path to apply bulk action on license(s)
+         */
+        this.BULK_PATH = '/bulk';
     }
     /**
      * Returns the raw result from the find endpoint call
@@ -277,6 +282,30 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         };
         return await this.post(postData);
     }
+    async bulkAction(bulkData) {
+        this.path = this.BULK_PATH;
+        let postData = {
+            [bulkArguments_1.BulkBodyFields.ACTION_TYPE]: bulkData.actionType,
+            [bulkArguments_1.BulkBodyFields.LICENSES]: bulkData.licenses,
+        };
+        if (bulkData.actionType == bulkArguments_1.ActionTypes.AUTO_RENEW) {
+            const postAutoRenewData = {
+                ...postData,
+                [bulkArguments_1.BulkBodyFields.AUTO_RENEW_STATUS]: bulkData.autoRenewStatus,
+            };
+            postData = postAutoRenewData;
+        }
+        else if (bulkData.actionType == bulkArguments_1.ActionTypes.SET_RATE) {
+            const postSetRateData = {
+                ...postData,
+                [bulkArguments_1.BulkBodyFields.SPECIAL_PRICE_RATE_TYPE]: bulkData.specialPriceRateType,
+                [bulkArguments_1.BulkBodyFields.SPECIAL_PRICE_RATE_VALUE]: bulkData.specialPriceRateValue,
+                [bulkArguments_1.BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE]: bulkData.specialRateEffectiveApplicationDate,
+            };
+            postData = postSetRateData;
+        }
+        return await this.post(postData);
+    }
     async updateConfig(reference, config) {
         const rawResponse = await this.updateConfigRaw(reference, config);
         return new configFindResult_1.ConfigFindResult(rawResponse);

package/build/licenses/types/bulkArguments.d.ts

@@ -0,0 +1,35 @@
+import type { Except } from 'type-fest';
+export declare enum ActionTypes {
+    SET_RATE = "setRate",
+    AUTO_RENEW = "autoRenew"
+}
+export declare enum AutoRenewStatuses {
+    OFF = "off",
+    ON = "on"
+}
+export declare enum SpecialPriceRateTypes {
+    DISCOUNT = "discount",
+    UPLIFT = "uplift"
+}
+export declare enum SpecialRateEffectiveApplicationDate {
+    APPLY_IMMEDIATELY = "apply immediately",
+    APPLY_ON_NEXT_BILLING_PERIOD = "apply on next billing period"
+}
+export declare enum BulkBodyFields {
+    ACTION_TYPE = "actionType",
+    AUTO_RENEW_STATUS = "autoRenewStatus",
+    LICENSES = "licenses",
+    SPECIAL_PRICE_RATE_TYPE = "specialPriceRateType",
+    SPECIAL_PRICE_RATE_VALUE = "specialPriceRateValue",
+    SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE = "specialRateEffectiveApplicationDate"
+}
+export declare type BulkBodyArgument = {
+    [BulkBodyFields.ACTION_TYPE]: ActionTypes;
+    [BulkBodyFields.LICENSES]: string[];
+    [BulkBodyFields.AUTO_RENEW_STATUS]?: AutoRenewStatuses;
+    [BulkBodyFields.SPECIAL_PRICE_RATE_TYPE]?: SpecialPriceRateTypes;
+    [BulkBodyFields.SPECIAL_PRICE_RATE_VALUE]?: string;
+    [BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE]?: SpecialRateEffectiveApplicationDate;
+};
+export declare type BulkAutoRenewBody = Except<BulkBodyArgument, BulkBodyFields.SPECIAL_PRICE_RATE_TYPE & BulkBodyFields.SPECIAL_PRICE_RATE_VALUE & BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE>;
+export declare type BulkSetRateBody = Except<BulkBodyArgument, BulkBodyFields.AUTO_RENEW_STATUS>;

package/build/licenses/types/bulkArguments.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkBodyFields = exports.SpecialRateEffectiveApplicationDate = exports.SpecialPriceRateTypes = exports.AutoRenewStatuses = exports.ActionTypes = void 0;
+var ActionTypes;
+(function (ActionTypes) {
+    ActionTypes["SET_RATE"] = "setRate";
+    ActionTypes["AUTO_RENEW"] = "autoRenew";
+})(ActionTypes = exports.ActionTypes || (exports.ActionTypes = {}));
+var AutoRenewStatuses;
+(function (AutoRenewStatuses) {
+    AutoRenewStatuses["OFF"] = "off";
+    AutoRenewStatuses["ON"] = "on";
+})(AutoRenewStatuses = exports.AutoRenewStatuses || (exports.AutoRenewStatuses = {}));
+var SpecialPriceRateTypes;
+(function (SpecialPriceRateTypes) {
+    SpecialPriceRateTypes["DISCOUNT"] = "discount";
+    SpecialPriceRateTypes["UPLIFT"] = "uplift";
+})(SpecialPriceRateTypes = exports.SpecialPriceRateTypes || (exports.SpecialPriceRateTypes = {}));
+var SpecialRateEffectiveApplicationDate;
+(function (SpecialRateEffectiveApplicationDate) {
+    SpecialRateEffectiveApplicationDate["APPLY_IMMEDIATELY"] = "apply immediately";
+    SpecialRateEffectiveApplicationDate["APPLY_ON_NEXT_BILLING_PERIOD"] = "apply on next billing period";
+})(SpecialRateEffectiveApplicationDate = exports.SpecialRateEffectiveApplicationDate || (exports.SpecialRateEffectiveApplicationDate = {}));
+var BulkBodyFields;
+(function (BulkBodyFields) {
+    BulkBodyFields["ACTION_TYPE"] = "actionType";
+    BulkBodyFields["AUTO_RENEW_STATUS"] = "autoRenewStatus";
+    BulkBodyFields["LICENSES"] = "licenses";
+    BulkBodyFields["SPECIAL_PRICE_RATE_TYPE"] = "specialPriceRateType";
+    BulkBodyFields["SPECIAL_PRICE_RATE_VALUE"] = "specialPriceRateValue";
+    BulkBodyFields["SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE"] = "specialRateEffectiveApplicationDate";
+})(BulkBodyFields = exports.BulkBodyFields || (exports.BulkBodyFields = {}));
+//# sourceMappingURL=bulkArguments.js.map

package/build/organisationUnit/entities/organizationUnit.d.ts

@@ -4,7 +4,8 @@ export declare enum OrganizationUnitFields {
     COLUMN_COMPANY_REF = "companyRef",
     COLUMN_NAME = "name",
     COLUMN_COUNT_USERS = "countUsers",
-    COLUMN_COUNT_CUSTOMERS = "countCustomers"
+    COLUMN_COUNT_CUSTOMERS = "countCustomers",
+    COLUMN_COUNT_LICENSES = "countLicenses"
 }
 export declare type OrganizationUnitType = {
     [OrganizationUnitFields.COLUMN_ORGANIZATION_UNIT_REF]: string;
@@ -12,6 +13,7 @@ export declare type OrganizationUnitType = {
     [OrganizationUnitFields.COLUMN_NAME]: string;
     [OrganizationUnitFields.COLUMN_COUNT_USERS]?: number;
     [OrganizationUnitFields.COLUMN_COUNT_CUSTOMERS]?: number;
+    [OrganizationUnitFields.COLUMN_COUNT_LICENSES]?: number;
 };
 export declare class OrganizationUnit extends AbstractEntity<OrganizationUnitType> {
     #private;
@@ -21,5 +23,6 @@ export declare class OrganizationUnit extends AbstractEntity<OrganizationUnitTyp
     get name(): string;
     get countUsers(): number | undefined;
     get countCustomers(): number | undefined;
+    get countLicenses(): number | undefined;
     toJSON(): OrganizationUnitType;
 }

package/build/organisationUnit/entities/organizationUnit.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _OrganizationUnit_organizationUnitRef, _OrganizationUnit_companyRef, _OrganizationUnit_name, _OrganizationUnit_countUsers, _OrganizationUnit_countCustomers;
+var _OrganizationUnit_organizationUnitRef, _OrganizationUnit_companyRef, _OrganizationUnit_name, _OrganizationUnit_countUsers, _OrganizationUnit_countCustomers, _OrganizationUnit_countLicenses;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrganizationUnit = exports.OrganizationUnitFields = void 0;
 const abstractEntity_1 = require("../../abstractEntity");
@@ -21,6 +21,7 @@ var OrganizationUnitFields;
     OrganizationUnitFields["COLUMN_NAME"] = "name";
     OrganizationUnitFields["COLUMN_COUNT_USERS"] = "countUsers";
     OrganizationUnitFields["COLUMN_COUNT_CUSTOMERS"] = "countCustomers";
+    OrganizationUnitFields["COLUMN_COUNT_LICENSES"] = "countLicenses";
 })(OrganizationUnitFields = exports.OrganizationUnitFields || (exports.OrganizationUnitFields = {}));
 class OrganizationUnit extends abstractEntity_1.AbstractEntity {
     constructor(organizationUnitInput) {
@@ -30,11 +31,13 @@ class OrganizationUnit extends abstractEntity_1.AbstractEntity {
         _OrganizationUnit_name.set(this, void 0);
         _OrganizationUnit_countUsers.set(this, void 0);
         _OrganizationUnit_countCustomers.set(this, void 0);
+        _OrganizationUnit_countLicenses.set(this, void 0);
         __classPrivateFieldSet(this, _OrganizationUnit_organizationUnitRef, organizationUnitInput[OrganizationUnitFields.COLUMN_ORGANIZATION_UNIT_REF], "f");
         __classPrivateFieldSet(this, _OrganizationUnit_companyRef, organizationUnitInput[OrganizationUnitFields.COLUMN_COMPANY_REF], "f");
         __classPrivateFieldSet(this, _OrganizationUnit_name, organizationUnitInput[OrganizationUnitFields.COLUMN_NAME], "f");
         __classPrivateFieldSet(this, _OrganizationUnit_countUsers, organizationUnitInput[OrganizationUnitFields.COLUMN_COUNT_USERS], "f");
         __classPrivateFieldSet(this, _OrganizationUnit_countCustomers, organizationUnitInput[OrganizationUnitFields.COLUMN_COUNT_CUSTOMERS], "f");
+        __classPrivateFieldSet(this, _OrganizationUnit_countLicenses, organizationUnitInput[OrganizationUnitFields.COLUMN_COUNT_LICENSES], "f");
     }
     get organizationUnitRef() {
         return __classPrivateFieldGet(this, _OrganizationUnit_organizationUnitRef, "f");
@@ -51,6 +54,9 @@ class OrganizationUnit extends abstractEntity_1.AbstractEntity {
     get countCustomers() {
         return __classPrivateFieldGet(this, _OrganizationUnit_countCustomers, "f");
     }
+    get countLicenses() {
+        return __classPrivateFieldGet(this, _OrganizationUnit_countLicenses, "f");
+    }
     toJSON() {
         return {
             [OrganizationUnitFields.COLUMN_ORGANIZATION_UNIT_REF]: this
@@ -59,9 +65,10 @@ class OrganizationUnit extends abstractEntity_1.AbstractEntity {
             [OrganizationUnitFields.COLUMN_NAME]: this.name,
             [OrganizationUnitFields.COLUMN_COUNT_USERS]: this.countUsers,
             [OrganizationUnitFields.COLUMN_COUNT_CUSTOMERS]: this.countCustomers,
+            [OrganizationUnitFields.COLUMN_COUNT_LICENSES]: this.countLicenses,
         };
     }
 }
 exports.OrganizationUnit = OrganizationUnit;
-_OrganizationUnit_organizationUnitRef = new WeakMap(), _OrganizationUnit_companyRef = new WeakMap(), _OrganizationUnit_name = new WeakMap(), _OrganizationUnit_countUsers = new WeakMap(), _OrganizationUnit_countCustomers = new WeakMap();
+_OrganizationUnit_organizationUnitRef = new WeakMap(), _OrganizationUnit_companyRef = new WeakMap(), _OrganizationUnit_name = new WeakMap(), _OrganizationUnit_countUsers = new WeakMap(), _OrganizationUnit_countCustomers = new WeakMap(), _OrganizationUnit_countLicenses = new WeakMap();
 //# sourceMappingURL=organizationUnit.js.map

package/build/organisationUnit/organizationUnitClient.d.ts

@@ -8,14 +8,6 @@ export declare enum OrganizationUnitPayloadFields {
 export declare type OrganizationUnitPayloadType = {
     [OrganizationUnitPayloadFields.COLUMN_NAME]: string;
 };
-export declare enum OrganizationUnitClientActionFields {
-    ACTION_ATTACH = "attach",
-    ACTION_DETACH = "detach"
-}
-export declare type OrganizationUnitClientActionType = {
-    licenses: string[];
-    users: string[];
-};
 export declare class OrganizationUnitClient extends AbstractRestfulClient {
     protected basePath: string;
     getList(perPage?: number, page?: number, parameters?: Parameters): Promise<GetResult<OrganizationUnitList>>;
@@ -23,5 +15,4 @@ export declare class OrganizationUnitClient extends AbstractRestfulClient {
     getOne(organizationUnitRef: string, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
     update(organizationUnitRef: string, payload: OrganizationUnitPayloadType, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
     deleteOne(organizationUnitRef: string, parameters?: Parameters): Promise<void>;
-    batchUpdate(action: OrganizationUnitClientActionFields, organizationUnitId: number, payload: OrganizationUnitClientActionType, parameters?: Parameters): Promise<void>;
 }

package/build/organisationUnit/organizationUnitClient.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganizationUnitClient = exports.OrganizationUnitClientActionFields = exports.OrganizationUnitPayloadFields = void 0;
+exports.OrganizationUnitClient = exports.OrganizationUnitPayloadFields = void 0;
 const abstractRestfulClient_1 = require("../abstractRestfulClient");
 const getResult_1 = require("../getResult");
 const organizationUnit_1 = require("./entities/organizationUnit");
@@ -9,11 +9,6 @@ var OrganizationUnitPayloadFields;
 (function (OrganizationUnitPayloadFields) {
     OrganizationUnitPayloadFields["COLUMN_NAME"] = "name";
 })(OrganizationUnitPayloadFields = exports.OrganizationUnitPayloadFields || (exports.OrganizationUnitPayloadFields = {}));
-var OrganizationUnitClientActionFields;
-(function (OrganizationUnitClientActionFields) {
-    OrganizationUnitClientActionFields["ACTION_ATTACH"] = "attach";
-    OrganizationUnitClientActionFields["ACTION_DETACH"] = "detach";
-})(OrganizationUnitClientActionFields = exports.OrganizationUnitClientActionFields || (exports.OrganizationUnitClientActionFields = {}));
 class OrganizationUnitClient extends abstractRestfulClient_1.AbstractRestfulClient {
     constructor() {
         super(...arguments);
@@ -39,11 +34,6 @@ class OrganizationUnitClient extends abstractRestfulClient_1.AbstractRestfulClie
         this.path = `/${organizationUnitRef}`;
         return await this.delete(parameters);
     }
-    async batchUpdate(action, organizationUnitId, payload, parameters = {}) {
-        this.basePath = '/organizationUnit';
-        this.path = `/${action}/${organizationUnitId}`;
-        return await this.patch(payload, parameters);
-    }
 }
 exports.OrganizationUnitClient = OrganizationUnitClient;
 //# sourceMappingURL=organizationUnitClient.js.map

package/package.json

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