@arrowsphere/api-client 3.108.2-rc.bdj.2 → 3.109.0-rc.cpu.1

package/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.109.0] - 2024.04.15
+
+### Added
+- [License schedules tasks] Update/Get/Delete scheduled tasks
+
 ## [3.108.1] - 2024.04.12
 
 ### Fixed

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

@@ -6,9 +6,6 @@ export declare enum GetSchedulesTasksResultFields {
 export declare type GetSchedulesTasksResultData = {
     [GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS]: GetScheduleTaskResultData[];
 };
-/**
- * @deprecated Use GetScheduledTasksResult instead
- */
 export declare class GetSchedulesTasksResult extends AbstractEntity<GetSchedulesTasksResultData> {
     #private;
     constructor(dataInput: GetSchedulesTasksResultData);

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

@@ -19,9 +19,6 @@ var GetSchedulesTasksResultFields;
 (function (GetSchedulesTasksResultFields) {
     GetSchedulesTasksResultFields["COLUMN_SCHEDULES_TASKS"] = "schedulesTasks";
 })(GetSchedulesTasksResultFields = exports.GetSchedulesTasksResultFields || (exports.GetSchedulesTasksResultFields = {}));
-/**
- * @deprecated Use GetScheduledTasksResult instead
- */
 class GetSchedulesTasksResult extends abstractEntity_1.AbstractEntity {
     constructor(dataInput) {
         super(dataInput);

package/build/licenses/index.d.ts

@@ -37,7 +37,6 @@ export * from './entities/offer/priceband/priceBandPriceFindResult';
 export * from './entities/offer/priceband/saleConstraintsFindResult';
 export * from './entities/offer/priceband/identifiers/arrowsphereFindResult';
 export * from './entities/schedule/getScheduleTaskResult';
-export * from './entities/schedule/getScheduledTasksResult';
 export * from './entities/schedule/getSchedulesTasksResult';
 export * from './entities/schedule/scheduleTasksResult';
 export * from './entities/pricingRate/getPricingRateResult';

package/build/licenses/index.js

@@ -53,7 +53,6 @@ __exportStar(require("./entities/offer/priceband/priceBandPriceFindResult"), exp
 __exportStar(require("./entities/offer/priceband/saleConstraintsFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/identifiers/arrowsphereFindResult"), exports);
 __exportStar(require("./entities/schedule/getScheduleTaskResult"), exports);
-__exportStar(require("./entities/schedule/getScheduledTasksResult"), exports);
 __exportStar(require("./entities/schedule/getSchedulesTasksResult"), exports);
 __exportStar(require("./entities/schedule/scheduleTasksResult"), exports);
 __exportStar(require("./entities/pricingRate/getPricingRateResult"), exports);

package/build/licenses/licensesClient.d.ts

@@ -26,7 +26,7 @@ import { BulkBodyArgument, SpecialPriceRateActive } from './types/bulkArguments'
 import { EndCustomerOrganizationUnitFiltersParameters, EndCustomerOrganizationUnitSortParameters } from './entities/endCustomerOrganizationUnit/endCustomerOrganizationUnitFindResult';
 import { ConsumptionDailyPrediction } from '../consumption';
 import { GetSchedulesTasksResult } from './entities/schedule/getSchedulesTasksResult';
-import { GetScheduledTasksResult } from './entities/schedule/getScheduledTasksResult';
+import { GetScheduleTaskResult } from './entities/schedule/getScheduleTaskResult';
 /**
  * Parameters passable to the request for refining search.
  */
@@ -243,6 +243,7 @@ export declare type ScheduleTasks = {
     seats: number;
     executionDate: string;
 };
+export declare type ScheduledTasksRequestType = Omit<ScheduleTasks, 'executionDate'>;
 export declare type LicensePricingRate = {
     rateType: RateTypeEnum;
     rateValue: number;
@@ -396,11 +397,10 @@ export declare class LicensesClient extends AbstractRestfulClient {
     getCredentials(licenseReference: string, parameters?: Parameters): Promise<GetResult<CredentialsResult>>;
     setPricingRate(licenseReference: string, payload: LicensePricingRate, parameters?: Parameters): Promise<void>;
     scheduleTasks(licenseReference: string, payload: ScheduleTasks, parameters?: Parameters): Promise<GetResult<ScheduleTasksResult>>;
-    /**
-     * @deprecated Use getScheduledTasks instead
-     */
     getSchedulesTasks(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetSchedulesTasksResult>>;
-    getScheduledTasks(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetScheduledTasksResult>>;
+    updateScheduledTasks(licenseReference: string, scheduledTaskId: number, payload: ScheduledTasksRequestType, parameters?: Parameters): Promise<void>;
+    getScheduledTasks(licenseReference: string, scheduledTaskId: number, parameters?: Parameters): Promise<GetResult<GetScheduleTaskResult>>;
+    deleteScheduledTasks(licenseReference: string, scheduledTaskId: number, parameters?: Parameters): Promise<void>;
     getLicenseDailyPredictions(licenseReference: string, parameters?: Parameters): Promise<GetResult<ConsumptionDailyPrediction>>;
     saveSpecialdBid(licenseReference: string, payload: SaveSpecialBidInputType, parameters?: Parameters): Promise<void>;
     rewriteRateHistory(licenseReference: string, payload: RewriteRateHistoryInputType, parameters?: Parameters): Promise<void>;

package/build/licenses/licensesClient.js

@@ -20,7 +20,7 @@ const http2_1 = require("http2");
 const bulkArguments_1 = require("./types/bulkArguments");
 const consumption_1 = require("../consumption");
 const getSchedulesTasksResult_1 = require("./entities/schedule/getSchedulesTasksResult");
-const getScheduledTasksResult_1 = require("./entities/schedule/getScheduledTasksResult");
+const getScheduleTaskResult_1 = require("./entities/schedule/getScheduleTaskResult");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -440,29 +440,32 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
         return new getResult_1.GetResult(scheduleTasksResult_1.ScheduleTasksResult, await this.post(payload, parameters));
     }
-    /**
-     * @deprecated Use getScheduledTasks instead
-     */
     async getSchedulesTasks(licenseReference, parameters = {}) {
-        var _a, _b;
+        var _a;
         this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
         const response = await this.get(parameters);
-        //A workaround, the public api endpoint now is returning "scheduledTasks" instead of "schedulesTasks"
-        //@todo: remove this workaround when the xsp-web is ready
-        if (!((_a = response[getResult_1.GetResultFields.COLUMN_DATA]) === null || _a === void 0 ? void 0 : _a[getSchedulesTasksResult_1.GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS]) &&
-            ((_b = response[getResult_1.GetResultFields.COLUMN_DATA]) === null || _b === void 0 ? void 0 : _b[getScheduledTasksResult_1.GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS])) {
+        //A workaround, the public api endpoint is not returning "schedulesTasks" in the payload
+        //@todo: remove this workaround when the public api endpoint is fixed
+        if (!((_a = response[getResult_1.GetResultFields.COLUMN_DATA]) === null || _a === void 0 ? void 0 : _a[getSchedulesTasksResult_1.GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS])) {
             response[getResult_1.GetResultFields.COLUMN_DATA] = {
                 [getSchedulesTasksResult_1.GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS]: getResult_1.GetResultFields.COLUMN_DATA in response
-                    ? response[getResult_1.GetResultFields.COLUMN_DATA][getScheduledTasksResult_1.GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS]
+                    ? response[getResult_1.GetResultFields.COLUMN_DATA]
                     : [],
             };
         }
         return new getResult_1.GetResult(getSchedulesTasksResult_1.GetSchedulesTasksResult, response);
     }
-    async getScheduledTasks(licenseReference, parameters = {}) {
-        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
-        const response = await this.get(parameters);
-        return new getResult_1.GetResult(getScheduledTasksResult_1.GetScheduledTasksResult, response);
+    async updateScheduledTasks(licenseReference, scheduledTaskId, payload, parameters = {}) {
+        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
+        return await this.patch(payload, parameters);
+    }
+    async getScheduledTasks(licenseReference, scheduledTaskId, parameters = {}) {
+        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
+        return new getResult_1.GetResult(getScheduleTaskResult_1.GetScheduleTaskResult, await this.get(parameters));
+    }
+    async deleteScheduledTasks(licenseReference, scheduledTaskId, parameters = {}) {
+        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
+        return this.delete(parameters);
     }
     async getLicenseDailyPredictions(licenseReference, parameters = {}) {
         this.path = `/${licenseReference}/predictions/daily`;

package/package.json

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

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

@@ -1,14 +0,0 @@
-import { AbstractEntity } from '../../../abstractEntity';
-import { GetScheduleTaskResult, GetScheduleTaskResultData } from './getScheduleTaskResult';
-export declare enum GetScheduledTasksResultFields {
-    COLUMN_SCHEDULED_TASKS = "scheduledTasks"
-}
-export declare type GetScheduledTasksResultData = {
-    [GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS]: GetScheduleTaskResultData[];
-};
-export declare class GetScheduledTasksResult extends AbstractEntity<GetScheduledTasksResultData> {
-    #private;
-    constructor(dataInput: GetScheduledTasksResultData);
-    get scheduledTasks(): GetScheduleTaskResult[];
-    toJSON(): GetScheduledTasksResultData;
-}

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

@@ -1,39 +0,0 @@
-"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 _GetScheduledTasksResult_scheduledTasks;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetScheduledTasksResult = exports.GetScheduledTasksResultFields = void 0;
-const abstractEntity_1 = require("../../../abstractEntity");
-const getScheduleTaskResult_1 = require("./getScheduleTaskResult");
-var GetScheduledTasksResultFields;
-(function (GetScheduledTasksResultFields) {
-    GetScheduledTasksResultFields["COLUMN_SCHEDULED_TASKS"] = "scheduledTasks";
-})(GetScheduledTasksResultFields = exports.GetScheduledTasksResultFields || (exports.GetScheduledTasksResultFields = {}));
-class GetScheduledTasksResult extends abstractEntity_1.AbstractEntity {
-    constructor(dataInput) {
-        super(dataInput);
-        _GetScheduledTasksResult_scheduledTasks.set(this, void 0);
-        __classPrivateFieldSet(this, _GetScheduledTasksResult_scheduledTasks, dataInput[GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS].map((result) => new getScheduleTaskResult_1.GetScheduleTaskResult(result)), "f");
-    }
-    get scheduledTasks() {
-        return __classPrivateFieldGet(this, _GetScheduledTasksResult_scheduledTasks, "f");
-    }
-    toJSON() {
-        return {
-            [GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS]: this.scheduledTasks.map((result) => result.toJSON()),
-        };
-    }
-}
-exports.GetScheduledTasksResult = GetScheduledTasksResult;
-_GetScheduledTasksResult_scheduledTasks = new WeakMap();
-//# sourceMappingURL=getScheduledTasksResult.js.map