@arrowsphere/api-client 3.79.0 → 3.80.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.80.0] - 2023-12-21
+
+### Added
+- Adds post schedule tasks
+- Adds Get/Set Pricing rate on a license
+
 ## [3.79.0] - 2023-12-20
 
 ### Changed

package/build/licenses/entities/pricingRate/getPricingRateResult.d.ts

@@ -0,0 +1,34 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum CompanyTypeEnum {
+    UNKNOWN = "UKW",
+    MSP_CUSTOMER = "MSP",
+    VAR_CUSTOMER = "VAR",
+    ARROW = "ARW"
+}
+export declare enum RateTypeEnum {
+    DISCOUNT = "discount",
+    UPLIFT = "uplift"
+}
+declare type RateType = {
+    id: number;
+    name: RateTypeEnum;
+};
+declare type CompanyType = {
+    id: number;
+    type: CompanyTypeEnum;
+};
+export declare type GetPricingRateData = {
+    id: number;
+    rate: number;
+    start_date: string;
+    end_date: string | null;
+    created_at: string;
+    rateType: RateType;
+    companyType: CompanyType;
+};
+export declare class GetPricingRateResult extends AbstractEntity<GetPricingRateData> {
+    #private;
+    constructor(data: GetPricingRateData);
+    toJSON(): GetPricingRateData;
+}
+export {};

package/build/licenses/entities/pricingRate/getPricingRateResult.js

@@ -0,0 +1,61 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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 _GetPricingRateResult_id, _GetPricingRateResult_rate, _GetPricingRateResult_start_date, _GetPricingRateResult_end_date, _GetPricingRateResult_created_at, _GetPricingRateResult_rateType, _GetPricingRateResult_companyType;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetPricingRateResult = exports.RateTypeEnum = exports.CompanyTypeEnum = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var CompanyTypeEnum;
+(function (CompanyTypeEnum) {
+    CompanyTypeEnum["UNKNOWN"] = "UKW";
+    CompanyTypeEnum["MSP_CUSTOMER"] = "MSP";
+    CompanyTypeEnum["VAR_CUSTOMER"] = "VAR";
+    CompanyTypeEnum["ARROW"] = "ARW";
+})(CompanyTypeEnum = exports.CompanyTypeEnum || (exports.CompanyTypeEnum = {}));
+var RateTypeEnum;
+(function (RateTypeEnum) {
+    RateTypeEnum["DISCOUNT"] = "discount";
+    RateTypeEnum["UPLIFT"] = "uplift";
+})(RateTypeEnum = exports.RateTypeEnum || (exports.RateTypeEnum = {}));
+class GetPricingRateResult extends abstractEntity_1.AbstractEntity {
+    constructor(data) {
+        super(data);
+        _GetPricingRateResult_id.set(this, void 0);
+        _GetPricingRateResult_rate.set(this, void 0);
+        _GetPricingRateResult_start_date.set(this, void 0);
+        _GetPricingRateResult_end_date.set(this, void 0);
+        _GetPricingRateResult_created_at.set(this, void 0);
+        _GetPricingRateResult_rateType.set(this, void 0);
+        _GetPricingRateResult_companyType.set(this, void 0);
+        __classPrivateFieldSet(this, _GetPricingRateResult_id, data === null || data === void 0 ? void 0 : data.id, "f");
+        __classPrivateFieldSet(this, _GetPricingRateResult_rate, data === null || data === void 0 ? void 0 : data.rate, "f");
+        __classPrivateFieldSet(this, _GetPricingRateResult_start_date, data === null || data === void 0 ? void 0 : data.start_date, "f");
+        __classPrivateFieldSet(this, _GetPricingRateResult_end_date, data === null || data === void 0 ? void 0 : data.end_date, "f");
+        __classPrivateFieldSet(this, _GetPricingRateResult_created_at, data === null || data === void 0 ? void 0 : data.created_at, "f");
+        __classPrivateFieldSet(this, _GetPricingRateResult_rateType, data === null || data === void 0 ? void 0 : data.rateType, "f");
+        __classPrivateFieldSet(this, _GetPricingRateResult_companyType, data === null || data === void 0 ? void 0 : data.companyType, "f");
+    }
+    toJSON() {
+        return {
+            id: __classPrivateFieldGet(this, _GetPricingRateResult_id, "f"),
+            rate: __classPrivateFieldGet(this, _GetPricingRateResult_rate, "f"),
+            start_date: __classPrivateFieldGet(this, _GetPricingRateResult_start_date, "f"),
+            end_date: __classPrivateFieldGet(this, _GetPricingRateResult_end_date, "f"),
+            created_at: __classPrivateFieldGet(this, _GetPricingRateResult_created_at, "f"),
+            rateType: __classPrivateFieldGet(this, _GetPricingRateResult_rateType, "f"),
+            companyType: __classPrivateFieldGet(this, _GetPricingRateResult_companyType, "f"),
+        };
+    }
+}
+exports.GetPricingRateResult = GetPricingRateResult;
+_GetPricingRateResult_id = new WeakMap(), _GetPricingRateResult_rate = new WeakMap(), _GetPricingRateResult_start_date = new WeakMap(), _GetPricingRateResult_end_date = new WeakMap(), _GetPricingRateResult_created_at = new WeakMap(), _GetPricingRateResult_rateType = new WeakMap(), _GetPricingRateResult_companyType = new WeakMap();
+//# sourceMappingURL=getPricingRateResult.js.map

package/build/licenses/entities/schedule/scheduleTasksResult.d.ts

@@ -0,0 +1,9 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare type ScheduleTaskData = {
+    scheduleTaskId: number;
+};
+export declare class ScheduleTasksResult extends AbstractEntity<ScheduleTaskData> {
+    #private;
+    constructor(data: ScheduleTaskData);
+    toJSON(): ScheduleTaskData;
+}

package/build/licenses/entities/schedule/scheduleTasksResult.js

@@ -0,0 +1,31 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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 _ScheduleTasksResult_scheduleTaskId;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduleTasksResult = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+class ScheduleTasksResult extends abstractEntity_1.AbstractEntity {
+    constructor(data) {
+        super(data);
+        _ScheduleTasksResult_scheduleTaskId.set(this, void 0);
+        __classPrivateFieldSet(this, _ScheduleTasksResult_scheduleTaskId, data.scheduleTaskId, "f");
+    }
+    toJSON() {
+        return {
+            scheduleTaskId: __classPrivateFieldGet(this, _ScheduleTasksResult_scheduleTaskId, "f"),
+        };
+    }
+}
+exports.ScheduleTasksResult = ScheduleTasksResult;
+_ScheduleTasksResult_scheduleTaskId = new WeakMap();
+//# sourceMappingURL=scheduleTasksResult.js.map

package/build/licenses/index.d.ts

@@ -33,6 +33,8 @@ export * from './entities/offer/priceband/priceBandActionFlagsFindResult';
 export * from './entities/offer/priceband/priceBandPriceFindResult';
 export * from './entities/offer/priceband/saleConstraintsFindResult';
 export * from './entities/offer/priceband/identifiers/arrowsphereFindResult';
+export * from './entities/schedule/scheduleTasksResult';
+export * from './entities/pricingRate/getPricingRateResult';
 export * from './licenseRequestClient';
 export * from './licensesClient';
 export * from './entities/license/securityFindResult';

package/build/licenses/index.js

@@ -49,6 +49,8 @@ __exportStar(require("./entities/offer/priceband/priceBandActionFlagsFindResult"
 __exportStar(require("./entities/offer/priceband/priceBandPriceFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/saleConstraintsFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/identifiers/arrowsphereFindResult"), exports);
+__exportStar(require("./entities/schedule/scheduleTasksResult"), exports);
+__exportStar(require("./entities/pricingRate/getPricingRateResult"), exports);
 __exportStar(require("./licenseRequestClient"), exports);
 __exportStar(require("./licensesClient"), exports);
 __exportStar(require("./entities/license/securityFindResult"), exports);

package/build/licenses/licensesClient.d.ts

@@ -19,6 +19,8 @@ import { LicenceHistoryResult } from './entities/history/licenceHistoryResult';
 import { UpgradeResult } from './entities/license/upgradeResult';
 import { LicenseConversionSkuResult } from './entities/license/licenseConversionSkuResult';
 import { CredentialsResult } from './entities/license/credentialsResult';
+import { ScheduleTasksResult } from './entities/schedule/scheduleTasksResult';
+import { GetPricingRateResult, RateTypeEnum } from './entities/pricingRate/getPricingRateResult';
 /**
  * Parameters passable to the request for refining search.
  */
@@ -209,6 +211,17 @@ export declare type SaveBillingCommentsInputType = {
     [SaveBillingCommentsInputFields.COLUMN_COMMENT_ONE]?: string | null;
     [SaveBillingCommentsInputFields.COLUMN_COMMENT_TWO]?: string | null;
 };
+export declare type ScheduleTasks = {
+    periodicity: number;
+    term: number;
+    seats: number;
+    executionDate: string;
+};
+export declare type LicensePricingRate = {
+    rateType: RateTypeEnum;
+    rateValue: number;
+    applyOnNextBillingPeriod: boolean;
+};
 export declare class LicensesClient extends AbstractRestfulClient {
     /**
      * The base path of the API
@@ -274,6 +287,14 @@ export declare class LicensesClient extends AbstractRestfulClient {
      * The path to retrieve license credentials
      */
     private GET_LICENSE_CREDENTIALS;
+    /**
+     * The path of schedule tasks on a license
+     */
+    private SCHEDULE_TASKS_PATH;
+    /**
+     * The path to get/set pricing rate on a license
+     */
+    private PRICING_RATE_PATH;
     /**
      * Returns the raw result from the find endpoint call
      *
@@ -314,6 +335,9 @@ export declare class LicensesClient extends AbstractRestfulClient {
     getConversionSku(licenseReference: string, parameters?: Parameters): Promise<GetResult<LicenseConversionSkuResult>>;
     getExistingConversionSku(licenseReference: string, parameters?: Parameters): Promise<GetResult<LicenseConversionSkuResult>>;
     getCredentials(licenseReference: string, parameters?: Parameters): Promise<GetResult<CredentialsResult>>;
+    getPricingRate(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetPricingRateResult>>;
+    setPricingRate(licenseReference: string, payload: LicensePricingRate, parameters?: Parameters): Promise<void>;
+    scheduleTasks(licenseReference: string, payload: ScheduleTasks, parameters?: Parameters): Promise<GetResult<ScheduleTasksResult>>;
     private createFilters;
     private createKeywords;
 }

package/build/licenses/licensesClient.js

@@ -14,6 +14,8 @@ const licenceHistoryResult_1 = require("./entities/history/licenceHistoryResult"
 const upgradeResult_1 = require("./entities/license/upgradeResult");
 const licenseConversionSkuResult_1 = require("./entities/license/licenseConversionSkuResult");
 const credentialsResult_1 = require("./entities/license/credentialsResult");
+const scheduleTasksResult_1 = require("./entities/schedule/scheduleTasksResult");
+const getPricingRateResult_1 = require("./entities/pricingRate/getPricingRateResult");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -184,6 +186,14 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
          * The path to retrieve license credentials
          */
         this.GET_LICENSE_CREDENTIALS = '/credentials';
+        /**
+         * The path of schedule tasks on a license
+         */
+        this.SCHEDULE_TASKS_PATH = '/scheduledTasks';
+        /**
+         * The path to get/set pricing rate on a license
+         */
+        this.PRICING_RATE_PATH = '/pricing-rate';
     }
     /**
      * Returns the raw result from the find endpoint call
@@ -343,6 +353,18 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.path = `/${licenseReference}${this.GET_LICENSE_CREDENTIALS}`;
         return new getResult_1.GetResult(credentialsResult_1.CredentialsResult, await this.get(parameters));
     }
+    async getPricingRate(licenseReference, parameters = {}) {
+        this.path = `/${licenseReference}${this.PRICING_RATE_PATH}`;
+        return new getResult_1.GetResult(getPricingRateResult_1.GetPricingRateResult, await this.get(parameters));
+    }
+    async setPricingRate(licenseReference, payload, parameters = {}) {
+        this.path = `/${licenseReference}${this.PRICING_RATE_PATH}`;
+        return await this.post(payload, parameters);
+    }
+    async scheduleTasks(licenseReference, payload, parameters = {}) {
+        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
+        return new getResult_1.GetResult(scheduleTasksResult_1.ScheduleTasksResult, await this.post(payload, parameters));
+    }
     createFilters(parameters, keyParent) {
         let appropriateParameters;
         if (typeof parameters === 'object') {

package/package.json

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