@arrowsphere/api-client 3.81.1 → 3.82.0-rc-zss.1

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

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

package/build/licenses/index.js

@@ -56,4 +56,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

@@ -21,6 +21,7 @@ import { LicenseConversionSkuResult } from './entities/license/licenseConversion
 import { CredentialsResult } from './entities/license/credentialsResult';
 import { ScheduleTasksResult } from './entities/schedule/scheduleTasksResult';
 import { GetPricingRateResult, RateTypeEnum } from './entities/pricingRate/getPricingRateResult';
+import { BulkBodyArgument, BulkSetRateBody, BulkAutoRenewBody } from './types/bulkArguments';
 /**
  * Parameters passable to the request for refining search.
  */
@@ -295,6 +296,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
      *
@@ -319,6 +324,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<BulkSetRateBody | BulkAutoRenewBody>;
     updateConfig(reference: string, config: ConfigFindResult): Promise<ConfigFindResult>;
     getLicense(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetLicenseResult>>;
     updateSeats(licenseReference: string, putData: UpdateSeatsData, parameters?: Parameters): Promise<void>;

package/build/licenses/licensesClient.js

@@ -16,6 +16,7 @@ const licenseConversionSkuResult_1 = require("./entities/license/licenseConversi
 const credentialsResult_1 = require("./entities/license/credentialsResult");
 const scheduleTasksResult_1 = require("./entities/schedule/scheduleTasksResult");
 const getPricingRateResult_1 = require("./entities/pricingRate/getPricingRateResult");
+const bulkArguments_1 = require("./types/bulkArguments");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -119,6 +120,7 @@ var SaveBillingCommentsInputFields;
     SaveBillingCommentsInputFields["COLUMN_COMMENT_ONE"] = "comment1";
     SaveBillingCommentsInputFields["COLUMN_COMMENT_TWO"] = "comment2";
 })(SaveBillingCommentsInputFields = exports.SaveBillingCommentsInputFields || (exports.SaveBillingCommentsInputFields = {}));
+//export type BulkArguments = BulkBodyArgument;
 class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
     constructor() {
         super(...arguments);
@@ -194,6 +196,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
@@ -275,6 +281,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,31 @@
+import type { Except } from 'type-fest';
+export declare enum ActionTypes {
+    SET_RATE = "setRate",
+    AUTO_RENEW = "autoRenew"
+}
+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]?: boolean;
+    [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,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkBodyFields = exports.SpecialRateEffectiveApplicationDate = exports.SpecialPriceRateTypes = exports.ActionTypes = void 0;
+var ActionTypes;
+(function (ActionTypes) {
+    ActionTypes["SET_RATE"] = "setRate";
+    ActionTypes["AUTO_RENEW"] = "autoRenew";
+})(ActionTypes = exports.ActionTypes || (exports.ActionTypes = {}));
+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 = {}));
+/*export type BulkAutoRenewBody = {
+  [BulkBodyFields.ACTION_TYPE]: ActionTypes;
+  [BulkBodyFields.LICENSES]: string[];
+  [BulkBodyFields.AUTO_RENEW_STATUS]: boolean;
+};
+
+export type BulkSetRateBody = {
+  [BulkBodyFields.ACTION_TYPE]: ActionTypes;
+  [BulkBodyFields.LICENSES]: string[];
+  [BulkBodyFields.SPECIAL_PRICE_RATE_TYPE]: SpecialPriceRateTypes;
+  [BulkBodyFields.SPECIAL_PRICE_RATE_VALUE]: string;
+  [BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE]: SpecialRateEffectiveApplicationDate;
+};*/
+//# sourceMappingURL=bulkArguments.js.map

package/package.json

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