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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,10 +3,13 @@
3
3
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
4
4
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5
5
 
6
- ## [3.109.0] - 2024.04.15
6
+ ## [3.109.0] - 2024.04.12
7
+
8
+ ### Fixed
9
+ - [License schedules tasks] Fixes getSchedulesTasks to handle api payload data with key scheduledTasks
7
10
 
8
11
  ### Added
9
- - [License schedules tasks] Update/Get/Delete scheduled tasks
12
+ - [License schedules tasks] Added getScheduledTasks
10
13
 
11
14
  ## [3.108.1] - 2024.04.12
12
15
 
@@ -0,0 +1,14 @@
1
+ import { AbstractEntity } from '../../../abstractEntity';
2
+ import { GetScheduleTaskResult, GetScheduleTaskResultData } from './getScheduleTaskResult';
3
+ export declare enum GetScheduledTasksResultFields {
4
+ COLUMN_SCHEDULED_TASKS = "scheduledTasks"
5
+ }
6
+ export declare type GetScheduledTasksResultData = {
7
+ [GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS]: GetScheduleTaskResultData[];
8
+ };
9
+ export declare class GetScheduledTasksResult extends AbstractEntity<GetScheduledTasksResultData> {
10
+ #private;
11
+ constructor(dataInput: GetScheduledTasksResultData);
12
+ get scheduledTasks(): GetScheduleTaskResult[];
13
+ toJSON(): GetScheduledTasksResultData;
14
+ }
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
3
+ if (kind === "m") throw new TypeError("Private method is not writable");
4
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
5
+ 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");
6
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
7
+ };
8
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
9
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
10
+ 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");
11
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
12
+ };
13
+ var _GetScheduledTasksResult_scheduledTasks;
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.GetScheduledTasksResult = exports.GetScheduledTasksResultFields = void 0;
16
+ const abstractEntity_1 = require("../../../abstractEntity");
17
+ const getScheduleTaskResult_1 = require("./getScheduleTaskResult");
18
+ var GetScheduledTasksResultFields;
19
+ (function (GetScheduledTasksResultFields) {
20
+ GetScheduledTasksResultFields["COLUMN_SCHEDULED_TASKS"] = "scheduledTasks";
21
+ })(GetScheduledTasksResultFields = exports.GetScheduledTasksResultFields || (exports.GetScheduledTasksResultFields = {}));
22
+ class GetScheduledTasksResult extends abstractEntity_1.AbstractEntity {
23
+ constructor(dataInput) {
24
+ super(dataInput);
25
+ _GetScheduledTasksResult_scheduledTasks.set(this, void 0);
26
+ __classPrivateFieldSet(this, _GetScheduledTasksResult_scheduledTasks, dataInput[GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS].map((result) => new getScheduleTaskResult_1.GetScheduleTaskResult(result)), "f");
27
+ }
28
+ get scheduledTasks() {
29
+ return __classPrivateFieldGet(this, _GetScheduledTasksResult_scheduledTasks, "f");
30
+ }
31
+ toJSON() {
32
+ return {
33
+ [GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS]: this.scheduledTasks.map((result) => result.toJSON()),
34
+ };
35
+ }
36
+ }
37
+ exports.GetScheduledTasksResult = GetScheduledTasksResult;
38
+ _GetScheduledTasksResult_scheduledTasks = new WeakMap();
39
+ //# sourceMappingURL=getScheduledTasksResult.js.map
@@ -6,6 +6,9 @@ export declare enum GetSchedulesTasksResultFields {
6
6
  export declare type GetSchedulesTasksResultData = {
7
7
  [GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS]: GetScheduleTaskResultData[];
8
8
  };
9
+ /**
10
+ * @deprecated Use GetScheduledTasksResult instead
11
+ */
9
12
  export declare class GetSchedulesTasksResult extends AbstractEntity<GetSchedulesTasksResultData> {
10
13
  #private;
11
14
  constructor(dataInput: GetSchedulesTasksResultData);
@@ -19,6 +19,9 @@ var GetSchedulesTasksResultFields;
19
19
  (function (GetSchedulesTasksResultFields) {
20
20
  GetSchedulesTasksResultFields["COLUMN_SCHEDULES_TASKS"] = "schedulesTasks";
21
21
  })(GetSchedulesTasksResultFields = exports.GetSchedulesTasksResultFields || (exports.GetSchedulesTasksResultFields = {}));
22
+ /**
23
+ * @deprecated Use GetScheduledTasksResult instead
24
+ */
22
25
  class GetSchedulesTasksResult extends abstractEntity_1.AbstractEntity {
23
26
  constructor(dataInput) {
24
27
  super(dataInput);
@@ -37,6 +37,7 @@ export * from './entities/offer/priceband/priceBandPriceFindResult';
37
37
  export * from './entities/offer/priceband/saleConstraintsFindResult';
38
38
  export * from './entities/offer/priceband/identifiers/arrowsphereFindResult';
39
39
  export * from './entities/schedule/getScheduleTaskResult';
40
+ export * from './entities/schedule/getScheduledTasksResult';
40
41
  export * from './entities/schedule/getSchedulesTasksResult';
41
42
  export * from './entities/schedule/scheduleTasksResult';
42
43
  export * from './entities/pricingRate/getPricingRateResult';
@@ -53,6 +53,7 @@ __exportStar(require("./entities/offer/priceband/priceBandPriceFindResult"), exp
53
53
  __exportStar(require("./entities/offer/priceband/saleConstraintsFindResult"), exports);
54
54
  __exportStar(require("./entities/offer/priceband/identifiers/arrowsphereFindResult"), exports);
55
55
  __exportStar(require("./entities/schedule/getScheduleTaskResult"), exports);
56
+ __exportStar(require("./entities/schedule/getScheduledTasksResult"), exports);
56
57
  __exportStar(require("./entities/schedule/getSchedulesTasksResult"), exports);
57
58
  __exportStar(require("./entities/schedule/scheduleTasksResult"), exports);
58
59
  __exportStar(require("./entities/pricingRate/getPricingRateResult"), exports);
@@ -26,7 +26,7 @@ import { BulkBodyArgument, SpecialPriceRateActive } from './types/bulkArguments'
26
26
  import { EndCustomerOrganizationUnitFiltersParameters, EndCustomerOrganizationUnitSortParameters } from './entities/endCustomerOrganizationUnit/endCustomerOrganizationUnitFindResult';
27
27
  import { ConsumptionDailyPrediction } from '../consumption';
28
28
  import { GetSchedulesTasksResult } from './entities/schedule/getSchedulesTasksResult';
29
- import { GetScheduleTaskResult } from './entities/schedule/getScheduleTaskResult';
29
+ import { GetScheduledTasksResult } from './entities/schedule/getScheduledTasksResult';
30
30
  /**
31
31
  * Parameters passable to the request for refining search.
32
32
  */
@@ -243,7 +243,6 @@ export declare type ScheduleTasks = {
243
243
  seats: number;
244
244
  executionDate: string;
245
245
  };
246
- export declare type ScheduledTasksRequestType = Omit<ScheduleTasks, 'executionDate'>;
247
246
  export declare type LicensePricingRate = {
248
247
  rateType: RateTypeEnum;
249
248
  rateValue: number;
@@ -397,10 +396,11 @@ export declare class LicensesClient extends AbstractRestfulClient {
397
396
  getCredentials(licenseReference: string, parameters?: Parameters): Promise<GetResult<CredentialsResult>>;
398
397
  setPricingRate(licenseReference: string, payload: LicensePricingRate, parameters?: Parameters): Promise<void>;
399
398
  scheduleTasks(licenseReference: string, payload: ScheduleTasks, parameters?: Parameters): Promise<GetResult<ScheduleTasksResult>>;
399
+ /**
400
+ * @deprecated Use getScheduledTasks instead
401
+ */
400
402
  getSchedulesTasks(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetSchedulesTasksResult>>;
401
- updateScheduledTasks(licenseReference: string, scheduledTaskId: number, payload: ScheduledTasksRequestType, parameters?: Parameters): Promise<void>;
402
- getScheduledTasks(licenseReference: string, scheduledTaskId: number, parameters?: Parameters): Promise<GetResult<GetScheduleTaskResult>>;
403
- deleteScheduledTasks(licenseReference: string, scheduledTaskId: number, parameters?: Parameters): Promise<void>;
403
+ getScheduledTasks(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetScheduledTasksResult>>;
404
404
  getLicenseDailyPredictions(licenseReference: string, parameters?: Parameters): Promise<GetResult<ConsumptionDailyPrediction>>;
405
405
  saveSpecialdBid(licenseReference: string, payload: SaveSpecialBidInputType, parameters?: Parameters): Promise<void>;
406
406
  rewriteRateHistory(licenseReference: string, payload: RewriteRateHistoryInputType, parameters?: Parameters): Promise<void>;
@@ -20,7 +20,7 @@ const http2_1 = require("http2");
20
20
  const bulkArguments_1 = require("./types/bulkArguments");
21
21
  const consumption_1 = require("../consumption");
22
22
  const getSchedulesTasksResult_1 = require("./entities/schedule/getSchedulesTasksResult");
23
- const getScheduleTaskResult_1 = require("./entities/schedule/getScheduleTaskResult");
23
+ const getScheduledTasksResult_1 = require("./entities/schedule/getScheduledTasksResult");
24
24
  /**
25
25
  * Parameters passable to the request for refining search.
26
26
  */
@@ -440,32 +440,29 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
440
440
  this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
441
441
  return new getResult_1.GetResult(scheduleTasksResult_1.ScheduleTasksResult, await this.post(payload, parameters));
442
442
  }
443
+ /**
444
+ * @deprecated Use getScheduledTasks instead
445
+ */
443
446
  async getSchedulesTasks(licenseReference, parameters = {}) {
444
- var _a;
447
+ var _a, _b;
445
448
  this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
446
449
  const response = await this.get(parameters);
447
- //A workaround, the public api endpoint is not returning "schedulesTasks" in the payload
448
- //@todo: remove this workaround when the public api endpoint is fixed
449
- if (!((_a = response[getResult_1.GetResultFields.COLUMN_DATA]) === null || _a === void 0 ? void 0 : _a[getSchedulesTasksResult_1.GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS])) {
450
+ //A workaround, the public api endpoint now is returning "scheduledTasks" instead of "schedulesTasks"
451
+ //@todo: remove this workaround when the xsp-web is ready
452
+ if (!((_a = response[getResult_1.GetResultFields.COLUMN_DATA]) === null || _a === void 0 ? void 0 : _a[getSchedulesTasksResult_1.GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS]) &&
453
+ ((_b = response[getResult_1.GetResultFields.COLUMN_DATA]) === null || _b === void 0 ? void 0 : _b[getScheduledTasksResult_1.GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS])) {
450
454
  response[getResult_1.GetResultFields.COLUMN_DATA] = {
451
455
  [getSchedulesTasksResult_1.GetSchedulesTasksResultFields.COLUMN_SCHEDULES_TASKS]: getResult_1.GetResultFields.COLUMN_DATA in response
452
- ? response[getResult_1.GetResultFields.COLUMN_DATA]
456
+ ? response[getResult_1.GetResultFields.COLUMN_DATA][getScheduledTasksResult_1.GetScheduledTasksResultFields.COLUMN_SCHEDULED_TASKS]
453
457
  : [],
454
458
  };
455
459
  }
456
460
  return new getResult_1.GetResult(getSchedulesTasksResult_1.GetSchedulesTasksResult, response);
457
461
  }
458
- async updateScheduledTasks(licenseReference, scheduledTaskId, payload, parameters = {}) {
459
- this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
460
- return await this.patch(payload, parameters);
461
- }
462
- async getScheduledTasks(licenseReference, scheduledTaskId, parameters = {}) {
463
- this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
464
- return new getResult_1.GetResult(getScheduleTaskResult_1.GetScheduleTaskResult, await this.get(parameters));
465
- }
466
- async deleteScheduledTasks(licenseReference, scheduledTaskId, parameters = {}) {
467
- this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
468
- return this.delete(parameters);
462
+ async getScheduledTasks(licenseReference, parameters = {}) {
463
+ this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
464
+ const response = await this.get(parameters);
465
+ return new getResult_1.GetResult(getScheduledTasksResult_1.GetScheduledTasksResult, response);
469
466
  }
470
467
  async getLicenseDailyPredictions(licenseReference, parameters = {}) {
471
468
  this.path = `/${licenseReference}/predictions/daily`;
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
6
6
  },
7
- "version": "3.109.0-rc.cpu.1",
7
+ "version": "3.109.0",
8
8
  "description": "Node.js client for ArrowSphere's public API",
9
9
  "main": "build/index.js",
10
10
  "types": "build/index.d.ts",