@arrowsphere/api-client 3.389.0 → 3.392.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,6 +3,22 @@
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.392.0] - 2026.08.14
7
+ ### Added
8
+ - [licenses] Add filters `rates` support to the `find` endpoint's
9
+
10
+ ## [3.391.0] - 2026.08.13
11
+ ### Added
12
+ - [licenses] Add `getPriceRatesHistory` endpoint to retrieving historical price rate data
13
+ - [licenses] Add `getPriceRatesScheduled` endpoint to retrieving scheduled price rate data
14
+
15
+ ## [3.390.0] - 2026.08.12
16
+ ### Added
17
+ - [graphql-api] Add `programName` and `vendorName` fields to `PartnerCatalogItemType`
18
+
19
+ ### Fixed
20
+ - [graphql-api] Fix `SoftwareProductType.id` type from `string` to `number`
21
+
6
22
  ## [3.389.0] - 2026.08.10
7
23
  ### Added
8
24
  - [catalog] Add `offer` field of type `OfferLightType` to `PriceBandType`
@@ -4,6 +4,8 @@ import { SoftwareProductType } from './softwareProduct';
4
4
  import { SubscriptionType } from './subscription';
5
5
  export declare type PartnerCatalogItemType = {
6
6
  id?: number;
7
+ programName?: string;
8
+ vendorName?: string;
7
9
  sid?: number;
8
10
  sellPrice?: number;
9
11
  price?: number;
@@ -2,7 +2,7 @@ import { CurrencyType } from './currency';
2
2
  import { ProgramLevelType } from './program';
3
3
  import { WorkgroupType } from './workgroup';
4
4
  export declare type SoftwareProductType = {
5
- id?: string;
5
+ id?: number;
6
6
  arrowSku?: string;
7
7
  sku?: string;
8
8
  name?: string;
@@ -0,0 +1,45 @@
1
+ import { DataKeywords, FiltersParameters, SortParameters } from '../../licensesClient';
2
+ export declare enum RateFindResultFields {
3
+ COLUMN_TYPE = "type",
4
+ COLUMN_RATE = "rate",
5
+ COLUMN_LAST_UPDATE = "lastUpdate"
6
+ }
7
+ export declare type RateFindResultDataFiltersParameters = {
8
+ [RateFindResultFields.COLUMN_TYPE]?: FiltersParameters;
9
+ [RateFindResultFields.COLUMN_RATE]?: FiltersParameters;
10
+ [RateFindResultFields.COLUMN_LAST_UPDATE]?: FiltersParameters;
11
+ };
12
+ export declare type RateFindResultDataKeywords = {
13
+ [RateFindResultFields.COLUMN_TYPE]?: DataKeywords;
14
+ [RateFindResultFields.COLUMN_RATE]?: DataKeywords;
15
+ [RateFindResultFields.COLUMN_LAST_UPDATE]?: DataKeywords;
16
+ };
17
+ export declare enum RatesFindResultFields {
18
+ COLUMN_ARROW_BUY_RATE = "arrowBuyRate",
19
+ COLUMN_ARROW_SELL_RATE = "arrowSellRate",
20
+ COLUMN_MSP_SELL_RATE = "mspSellRate",
21
+ COLUMN_MSP_OFFER_RATE = "mspOfferRate"
22
+ }
23
+ export declare type RatesFiltersParameters = {
24
+ [RatesFindResultFields.COLUMN_ARROW_BUY_RATE]?: RateFindResultDataFiltersParameters;
25
+ [RatesFindResultFields.COLUMN_ARROW_SELL_RATE]?: RateFindResultDataFiltersParameters;
26
+ [RatesFindResultFields.COLUMN_MSP_SELL_RATE]?: RateFindResultDataFiltersParameters;
27
+ [RatesFindResultFields.COLUMN_MSP_OFFER_RATE]?: RateFindResultDataFiltersParameters;
28
+ };
29
+ export declare type RatesDataKeywords = {
30
+ [RatesFindResultFields.COLUMN_ARROW_BUY_RATE]?: RateFindResultDataKeywords;
31
+ [RatesFindResultFields.COLUMN_ARROW_SELL_RATE]?: RateFindResultDataKeywords;
32
+ [RatesFindResultFields.COLUMN_MSP_SELL_RATE]?: RateFindResultDataKeywords;
33
+ [RatesFindResultFields.COLUMN_MSP_OFFER_RATE]?: RateFindResultDataKeywords;
34
+ };
35
+ export declare type RateFindResultDataSortParameters = {
36
+ [RateFindResultFields.COLUMN_TYPE]?: SortParameters;
37
+ [RateFindResultFields.COLUMN_RATE]?: SortParameters;
38
+ [RateFindResultFields.COLUMN_LAST_UPDATE]?: SortParameters;
39
+ };
40
+ export declare type RatesSortParameters = {
41
+ [RatesFindResultFields.COLUMN_MSP_SELL_RATE]?: RateFindResultDataSortParameters;
42
+ [RatesFindResultFields.COLUMN_MSP_OFFER_RATE]?: RateFindResultDataSortParameters;
43
+ [RatesFindResultFields.COLUMN_ARROW_BUY_RATE]?: RateFindResultDataSortParameters;
44
+ [RatesFindResultFields.COLUMN_ARROW_SELL_RATE]?: RateFindResultDataSortParameters;
45
+ };
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RatesFindResultFields = exports.RateFindResultFields = void 0;
4
+ var RateFindResultFields;
5
+ (function (RateFindResultFields) {
6
+ RateFindResultFields["COLUMN_TYPE"] = "type";
7
+ RateFindResultFields["COLUMN_RATE"] = "rate";
8
+ RateFindResultFields["COLUMN_LAST_UPDATE"] = "lastUpdate";
9
+ })(RateFindResultFields = exports.RateFindResultFields || (exports.RateFindResultFields = {}));
10
+ var RatesFindResultFields;
11
+ (function (RatesFindResultFields) {
12
+ RatesFindResultFields["COLUMN_ARROW_BUY_RATE"] = "arrowBuyRate";
13
+ RatesFindResultFields["COLUMN_ARROW_SELL_RATE"] = "arrowSellRate";
14
+ RatesFindResultFields["COLUMN_MSP_SELL_RATE"] = "mspSellRate";
15
+ RatesFindResultFields["COLUMN_MSP_OFFER_RATE"] = "mspOfferRate";
16
+ })(RatesFindResultFields = exports.RatesFindResultFields || (exports.RatesFindResultFields = {}));
17
+ //# sourceMappingURL=rateFindResult.js.map
@@ -50,4 +50,5 @@ export * from './licenseRequestClient';
50
50
  export * from './licensesClient';
51
51
  export * from './licensesEventClient';
52
52
  export * from './types/bulkArguments';
53
+ export * from './types/pricingRate';
53
54
  export * from './entities/license/dynamicMappingResult';
@@ -66,5 +66,6 @@ __exportStar(require("./licenseRequestClient"), exports);
66
66
  __exportStar(require("./licensesClient"), exports);
67
67
  __exportStar(require("./licensesEventClient"), exports);
68
68
  __exportStar(require("./types/bulkArguments"), exports);
69
+ __exportStar(require("./types/pricingRate"), exports);
69
70
  __exportStar(require("./entities/license/dynamicMappingResult"), exports);
70
71
  //# sourceMappingURL=index.js.map
@@ -24,6 +24,8 @@ import { CompanyTypeEnum, RateTypeEnum } from './entities/pricingRate/getPricing
24
24
  import { PartialResponse } from '../partialResponse';
25
25
  import { BulkBodyArgument, SpecialPriceRateActive } from './types/bulkArguments';
26
26
  import { EndCustomerOrganisationUnitDataKeywords, EndCustomerOrganizationUnitFiltersParameters, EndCustomerOrganizationUnitSortParameters } from './entities/endCustomerOrganizationUnit/endCustomerOrganizationUnitFindResult';
27
+ import { RatesDataKeywords, RatesFiltersParameters, RatesSortParameters } from './entities/rates/rateFindResult';
28
+ import { GetLicensePricingRateParameters, GetLicensePricingRateResponse } from './types/pricingRate';
27
29
  import { ConsumptionDailyPrediction } from '../consumption';
28
30
  import { GetScheduledTasksResult } from './entities/schedule/getScheduledTasksResult';
29
31
  import { GetScheduleTaskResult } from './entities/schedule/getScheduleTaskResult';
@@ -138,20 +140,21 @@ export declare enum LicenseFindParameters {
138
140
  */
139
141
  FILTERS_LTE = "lte"
140
142
  }
141
- export declare type BaseParameters<LicenseType, OfferType, endCustomerOrganizationUnitType> = {
143
+ export declare type BaseParameters<LicenseType, OfferType, endCustomerOrganizationUnitType, RatesType> = {
142
144
  license?: LicenseType;
143
145
  offer?: OfferType;
144
146
  endCustomerOrganizationUnit?: endCustomerOrganizationUnitType;
147
+ rates?: RatesType;
145
148
  };
146
149
  export declare type AttachFileToLicenseParameters = {
147
150
  name: string;
148
151
  fileEncoded: string;
149
152
  };
150
- export declare type LicenseSortParameters = BaseParameters<LicenceFindDataSortParameters, OfferFindResultDataSortParameters, EndCustomerOrganizationUnitSortParameters>;
153
+ export declare type LicenseSortParameters = BaseParameters<LicenceFindDataSortParameters, OfferFindResultDataSortParameters, EndCustomerOrganizationUnitSortParameters, RatesSortParameters>;
151
154
  export declare type LicenseCompareParameters = {
152
155
  [field: string]: unknown;
153
156
  };
154
- export declare type LicenseFiltersParameters = BaseParameters<LicenceFindDataFiltersParameters, OfferFindResultDataFiltersParameters, EndCustomerOrganizationUnitFiltersParameters>;
157
+ export declare type LicenseFiltersParameters = BaseParameters<LicenceFindDataFiltersParameters, OfferFindResultDataFiltersParameters, EndCustomerOrganizationUnitFiltersParameters, RatesFiltersParameters>;
155
158
  /**
156
159
  * List of keywords to search with.
157
160
  */
@@ -166,6 +169,7 @@ export declare type LicenseKeywordsParameters = {
166
169
  license?: LicenceFindDataKeywords;
167
170
  offer?: OfferFindResultDataKeywords;
168
171
  endCustomerOrganizationUnit?: EndCustomerOrganisationUnitDataKeywords;
172
+ rates?: RatesDataKeywords;
169
173
  };
170
174
  export declare type LicenseRawKeywordsParametersLicence = {
171
175
  [field: string]: DataKeywords | ActiveSeatsFindResultDataKeywords | ConfigFindResultDataKeywords | WarningFindResultDataKeywords | PriceFindResultDataKeywords | SecurityFindResultDataKeywords | undefined;
@@ -391,6 +395,14 @@ export declare class LicensesClient extends AbstractRestfulClient {
391
395
  * The path to get/set pricing rate on a license
392
396
  */
393
397
  private PRICING_RATE_PATH;
398
+ /**
399
+ * The path to get the pricing rate history on a license
400
+ */
401
+ private PRICING_RATE_HISTORY_PATH;
402
+ /**
403
+ * The path to get the pricing rate scheduled on a license
404
+ */
405
+ private PRICING_RATE_SCHEDULED_PATH;
394
406
  /**
395
407
  * The path to apply bulk action on license(s)
396
408
  */
@@ -449,6 +461,8 @@ export declare class LicensesClient extends AbstractRestfulClient {
449
461
  getExistingConversionSku(licenseReference: string, parameters?: Parameters): Promise<GetResult<LicenseConversionSkuResult>>;
450
462
  getCredentials(licenseReference: string, parameters?: Parameters): Promise<GetResult<CredentialsResult>>;
451
463
  setPricingRate(licenseReference: string, payload: LicensePricingRate, parameters?: Parameters): Promise<void>;
464
+ getPriceRatesHistory(licenseReference: string, params?: GetLicensePricingRateParameters): Promise<GetLicensePricingRateResponse>;
465
+ getPriceRatesScheduled(licenseReference: string, params?: GetLicensePricingRateParameters): Promise<GetLicensePricingRateResponse>;
452
466
  scheduleTasks(licenseReference: string, payload: ScheduleTasks, parameters?: Parameters): Promise<GetResult<ScheduleTasksResult>>;
453
467
  updateScheduledTask(licenseReference: string, scheduledTaskId: number, payload: UpdateScheduledTaskRequestType, parameters?: Parameters): Promise<void>;
454
468
  getScheduledTask(licenseReference: string, scheduledTaskId: number, parameters?: Parameters): Promise<GetResult<GetScheduleTaskResult>>;
@@ -242,6 +242,14 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
242
242
  * The path to get/set pricing rate on a license
243
243
  */
244
244
  this.PRICING_RATE_PATH = '/pricing-rate';
245
+ /**
246
+ * The path to get the pricing rate history on a license
247
+ */
248
+ this.PRICING_RATE_HISTORY_PATH = '/pricing-rate/history';
249
+ /**
250
+ * The path to get the pricing rate scheduled on a license
251
+ */
252
+ this.PRICING_RATE_SCHEDULED_PATH = '/pricing-rate/scheduled';
245
253
  /**
246
254
  * The path to apply bulk action on license(s)
247
255
  */
@@ -304,6 +312,7 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
304
312
  ...this.createFilters(postData.filters, 'license'),
305
313
  ...this.createFilters(postData.filters, 'offer'),
306
314
  ...this.createFilters(postData.filters, 'endCustomerOrganizationUnit'),
315
+ ...this.createFilters(postData.filters, 'rates'),
307
316
  };
308
317
  }
309
318
  if (postData.exclusionFilters) {
@@ -312,6 +321,7 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
312
321
  ...this.createFilters(postData.exclusionFilters, 'license'),
313
322
  ...this.createFilters(postData.exclusionFilters, 'offer'),
314
323
  ...this.createFilters(postData.exclusionFilters, 'endCustomerOrganizationUnit'),
324
+ ...this.createFilters(postData.exclusionFilters, 'rates'),
315
325
  };
316
326
  }
317
327
  if (postData.sort) {
@@ -320,6 +330,7 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
320
330
  ...this.createFilters(postData.sort, 'license'),
321
331
  ...this.createFilters(postData.sort, 'offer'),
322
332
  ...this.createFilters(postData.sort, 'endCustomerOrganizationUnit'),
333
+ ...this.createFilters(postData.sort, 'rates'),
323
334
  };
324
335
  }
325
336
  const response = await this.findRaw(rawLicensePayload, parameters);
@@ -508,6 +519,14 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
508
519
  this.path = `/${licenseReference}${this.PRICING_RATE_PATH}`;
509
520
  return await this.post(payload, parameters);
510
521
  }
522
+ async getPriceRatesHistory(licenseReference, params = {}) {
523
+ this.path = `/${licenseReference}${this.PRICING_RATE_HISTORY_PATH}`;
524
+ return this.get(params);
525
+ }
526
+ async getPriceRatesScheduled(licenseReference, params = {}) {
527
+ this.path = `/${licenseReference}${this.PRICING_RATE_SCHEDULED_PATH}`;
528
+ return this.get(params);
529
+ }
511
530
  async scheduleTasks(licenseReference, payload, parameters = {}) {
512
531
  this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
513
532
  return new getResult_1.GetResult(scheduleTasksResult_1.ScheduleTasksResult, await this.post(payload, parameters));
@@ -0,0 +1,20 @@
1
+ export declare type GetLicensePricingRateParameters = {
2
+ continuationToken?: string;
3
+ perPage?: number;
4
+ };
5
+ export declare type LicensePricingRateItem = {
6
+ rateType: string;
7
+ value: string;
8
+ changeRequestDate: string;
9
+ effectiveDate: string;
10
+ source: string;
11
+ };
12
+ export declare type LicensePricingRatePagination = {
13
+ perPage: number;
14
+ continuationToken: string | null;
15
+ };
16
+ export declare type GetLicensePricingRateResponse = {
17
+ status: number;
18
+ data: LicensePricingRateItem[];
19
+ pagination: LicensePricingRatePagination;
20
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=pricingRate.js.map
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.389.0",
7
+ "version": "3.392.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",