@arrowsphere/api-client 1.0.1 → 2.0.1

package/CHANGELOG.md

@@ -3,13 +3,81 @@
 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).
 
-## [1.0.1] - 2021-06-21
+## [2.0.1] - 2022-01-19
+
+### Changed
+
+- Fixed type `SortParameters` and `FiltersParameters`
+
+## [2.0.0] - 2022-01-06
+
+### Changed
+
+- bad prettier library configuration, adding semicolon in file needed
+- Update Offer object and Licence object
+
+#### License
+- Add more objects to define a license:
+  - Add object Warning as "warnings" field:
+    - key
+    - message
+  - Add object Config as "configs" field :
+    - name
+    - scope
+    - state
+  - Update field active_seat, it's now an object of type ActiveSeatsData:
+    - ActiveSeatsData:
+      - lastUpdate
+      - number
+  - Update field price, it's now an object of type PriceData
+    - PriceData:
+      - priceBandArrowsphereSku
+      - buy_price
+      - sell_price
+      - list_price
+      - currency
+#### Offer
+- Add more objects to define an offer:
+  - Add field "classification"
+  - Add field "isEnabled"
+  - Add field "lastUpdate"
+  - Add field "name"
+  - Add field "arrowSubCategories"
+  - Add object ActionFlags as "actionFlags" field:
+    - ActionFlagsData:
+      - isAutoRenew
+      - isManualProvisioning
+      - renewalSku
+  - Add object PriceBand as "priceBand" field:
+    - PriceBandData:
+      - actionFlags
+      - billing
+      - currency
+      - isEnabled
+      - marketplace
+      - prices
+      - saleConstraints
+      - identifiers
+
+## [1.0.3] - 2021-06-21
+
+### Changed
+
+- Fixed sort key for licenses v2
+
+## [1.0.2] - 2021-06-21 - BROKEN
+
+### Changed
+
+- Fixed filters for licenses v2
+
+## [1.0.1] - 2021-06-21 - BROKEN
 
 ### Changed
 
 - Fixed keywords for licenses v2
 
-## [1.0.0] - 2021-06-18
+## [1.0.0] - 2021-06-18 - BROKEN
 
 ### Changed
 

package/UPGRADING.md

@@ -0,0 +1,43 @@
+# Upgrade guide
+
+## 1.0.3 to 2.0.0
+
+### Changes to the licences client
+
+The object `LicensesClient` now has more information. Object `LicenseOfferFindResult` has been removed,
+it's replaced by `OfferFindResult` with new fields, and object `AbstractLicense` extends `LicenseFindResult` 
+has more fields.
+
+- `LicenseFindResultFields.ACTIVE_SEATS_LAST_UPDATE` has been renamed to `ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE`.
+- `LicenseFindResultFields.ACTIVE_SEATS_NUMBER` has been renamed to `ActiveSeatsFindResultFields.COLUMN_NUMBER`
+- `LicenseFindResultFields.PRICE_BUY_PRICE` has been renamed to `PriceFindResultFields.COLUMN_BUY_PRICE`
+- `LicenseFindResultFields.PRICE_LIST_PRICE` has been renamed to `PriceFindResultFields.COLUMN_LIST_PRICE`
+- `LicenseFindResultFields.PRICE_CURRENCY` has been renamed to `PriceFindResultFields.COLUMN_CURRENCY`
+
+- `LicenseOfferFields` has been renamed to `OfferFindResultFields`
+- `LicenseOfferFields.COLUMN_IS_AUTO_RENEW` has been renamed to `ActionFlagsFindResultFields.COLUMN_IS_AUTO_RENEW`
+- `LicenseOfferFields.COLUMN_IS_MANUAL_PROVISIONING` has been renamed to `ActionFlagsFindResultFields.COLUMN_MANUAL_PROVISIONING`
+- `LicenseOfferFields.COLUMN_ACTION_FLAGS` has been renamed to `PriceBandFindResultFields.COLUMN_ACTION_FLAGS`
+- `LicenseOfferFields.COLUMN_CAN_BE_CANCELLED` has been renamed to `PriceBandActionFlagsFindResultFields.COLUMN_CAN_BE_CANCELLED`
+- `LicenseOfferFields.COLUMN_CAN_BE_REACTIVATED` has been renamed to `PriceBandActionFlagsFindResultFields.COLUMN_CAN_BE_REACTIVATED`
+- `LicenseOfferFields.COLUMN_CAN_BE_SUSPENDED` has been renamed to `PriceBandActionFlagsFindResultFields.COLUMN_CAN_BE_SUSPENDED`
+- `LicenseOfferFields.COLUMN_CAN_DECREASE_SEATS` has been renamed to `PriceBandActionFlagsFindResultFields.COLUMN_CAN_DECREASE_SEATS`
+- `LicenseOfferFields.COLUMN_CAN_INCREASE_SEATS` has been renamed to `PriceBandActionFlagsFindResultFields.COLUMN_CAN_INCREASE_SEATS`
+- `LicenseOfferFields.COLUMN_MARKETPLACE` has been renamed to `PriceBandFindResultFields.COLUMN_MARKETPLACE`
+- `LicenseOfferFields.COLUMN_IS_ENABLED` has been renamed to `PriceBandFindResultFields.COLUMN_IS_ENABLED`
+- `LicenseOfferFields.COLUMN_CURRENCY` has been renamed to `PriceBandFindResultFields.COLUMN_CURRENCY`
+- `LicenseOfferFields.COLUMN_PRICES` has been renamed to `PriceBandFindResultFields.COLUMN_PRICES`
+- `LicenseOfferFields.COLUMN_PUBLIC` has been renamed to `PriceBandPriceFindResultFields.COLUMN_PUBLIC`
+- `LicenseOfferFields.COLUMN_BUY` has been renamed to `PriceBandPriceFindResultFields.COLUMN_BUY`
+- `LicenseOfferFields.COLUMN_SELL` has been renamed to `PriceBandPriceFindResultFields.COLUMN_SELL`
+- `LicenseOfferFields.COLUMN_BILLING` has been renamed to `PriceBandFindResultFields.COLUMN_BILLING`
+- `LicenseOfferFields.COLUMN_TERM` has been renamed to `BillingFindResultFields.COLUMN_TERM`
+- `LicenseOfferFields.COLUMN_TYPE` has been renamed to `BillingFindResultFields.COLUMN_TYPE`
+- `LicenseOfferFields.COLUMN_CYCLE` has been renamed to `BillingFindResultFields.COLUMN_CYCLE`
+
+Different types have been replaced :
+
+ - `LicenseOfferFindResultData` becomes `OfferFindResultData`
+ - `LicenseDataKeywords` becomes `DataKeywords`
+ - `LicenseRawKeywordsParameters` becomes `LicenseRawKeywordsParametersLicence` and `LicenseRawKeywordsParametersOffer`
+ - `LicenseRawSortParameters` becomes `LicenseRawSortParametersLicense` and `LicenseRawSortParametersOffer`

package/build/licenses/entities/filterFindResult.d.ts

@@ -1,10 +1,10 @@
 import { AbstractEntity } from '../../abstractEntity';
-import { LicenseFields } from './license/abstractLicense';
+import { LicenseFindResultFields } from './license/licenseFindResult';
 /**
  * Filter data values
  */
 export declare type FilterFindResultDataValues = {
-    [field in LicenseFields]?: unknown;
+    [field in LicenseFindResultFields]?: unknown;
 };
 /**
  * Filter data

package/build/licenses/entities/findResult.d.ts

@@ -1,9 +1,9 @@
-import { AbstractEntity } from '../../abstractEntity';
-import { LicenseFindRawPayload, LicensesClient } from '../licensesClient';
-import { Parameters } from '../../abstractClient';
 import { LicenseFindResultData } from './license/licenseFindResult';
 import { FilterFindResultData } from './filterFindResult';
-import { LicenseOfferFindResultData } from './offer/licenseOfferFindResult';
+import { AbstractEntity } from '../../abstractEntity';
+import { LicensesClient, LicenseFindRawPayload } from '../licensesClient';
+import { OfferFindResultData } from './offer/offerFindResult';
+import { Parameters } from '../../abstractClient';
 export declare type FindData = {
     pagination: {
         currentPage: number;
@@ -12,19 +12,27 @@ export declare type FindData = {
     };
     results: Array<{
         license: LicenseFindResultData;
-        offer?: LicenseOfferFindResultData;
+        offer?: OfferFindResultData;
     }>;
     filters: Array<FilterFindResultData>;
 };
 export declare type FindResultData = {
     results: AsyncGenerator<{
         license: LicenseFindResultData;
-        offer?: LicenseOfferFindResultData;
+        offer?: OfferFindResultData;
     }, void, undefined>;
     filters: FilterFindResultData[];
     totalPage: number;
     nbResults: number;
 };
+export declare type FindConfig = {
+    status: number;
+    data: Array<{
+        name: string;
+        scope: string;
+        state: string;
+    }>;
+};
 export declare class FindResult extends AbstractEntity<FindData> {
     #private;
     /**
@@ -42,7 +50,7 @@ export declare class FindResult extends AbstractEntity<FindData> {
      */
     getResultsForCurrentPage(): Generator<{
         license: LicenseFindResultData;
-        offer?: LicenseOfferFindResultData;
+        offer?: OfferFindResultData;
     }, void, undefined>;
     /**
      * Gets all the licenses from the result, page per page.
@@ -51,11 +59,11 @@ export declare class FindResult extends AbstractEntity<FindData> {
      */
     getResults(): AsyncGenerator<{
         license: LicenseFindResultData;
-        offer?: LicenseOfferFindResultData;
+        offer?: OfferFindResultData;
     }, void, undefined>;
     get results(): AsyncGenerator<{
         license: LicenseFindResultData;
-        offer?: LicenseOfferFindResultData;
+        offer?: OfferFindResultData;
     }, void, undefined>;
     get filters(): Array<FilterFindResultData>;
     get nbResults(): number;

package/build/licenses/entities/findResult.js

@@ -15,10 +15,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _results, _filters, _client, _postData, _parameters, _currentPage, _totalPage, _nbResults;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FindResult = void 0;
-const abstractEntity_1 = require("../../abstractEntity");
 const licenseFindResult_1 = require("./license/licenseFindResult");
 const filterFindResult_1 = require("./filterFindResult");
-const licenseOfferFindResult_1 = require("./offer/licenseOfferFindResult");
+const abstractEntity_1 = require("../../abstractEntity");
+const offerFindResult_1 = require("./offer/offerFindResult");
 class FindResult extends abstractEntity_1.AbstractEntity {
     /**
      * FindResult constructor. Uses the client and request data to go through the pages.
@@ -47,7 +47,7 @@ class FindResult extends abstractEntity_1.AbstractEntity {
         __classPrivateFieldSet(this, _results, data.results.map((result) => ({
             license: new licenseFindResult_1.LicenseFindResult(result.license).toJSON(),
             offer: result.offer
-                ? new licenseOfferFindResult_1.LicenseOfferFindResult(result.offer).toJSON()
+                ? new offerFindResult_1.OfferFindResult(result.offer).toJSON()
                 : undefined,
         })));
         __classPrivateFieldSet(this, _filters, data.filters.map((filter) => new filterFindResult_1.FilterFindResult(filter).toJSON()));
@@ -81,7 +81,7 @@ class FindResult extends abstractEntity_1.AbstractEntity {
                 yield {
                     license: new licenseFindResult_1.LicenseFindResult(result.license).toJSON(),
                     offer: result.offer
-                        ? new licenseOfferFindResult_1.LicenseOfferFindResult(result.offer).toJSON()
+                        ? new offerFindResult_1.OfferFindResult(result.offer).toJSON()
                         : undefined,
                 };
             }

package/build/licenses/entities/license/activeSeatsFindResult.d.ts

@@ -0,0 +1,29 @@
+import { DataKeywords, FiltersParameters, SortParameters } from '../../licensesClient';
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum ActiveSeatsFindResultFields {
+    COLUMN_LAST_UPDATE = "lastUpdate",
+    COLUMN_NUMBER = "number"
+}
+export declare type ActiveSeatsFindresultData = {
+    [ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE]?: string | null;
+    [ActiveSeatsFindResultFields.COLUMN_NUMBER]?: number | null;
+};
+export declare type ActiveSeatsFindResultDataKeywords = {
+    [ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE]?: DataKeywords;
+    [ActiveSeatsFindResultFields.COLUMN_NUMBER]?: DataKeywords;
+};
+export declare type ActiveSeatsFindResultDataSortParameters = {
+    [ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE]?: SortParameters;
+    [ActiveSeatsFindResultFields.COLUMN_NUMBER]?: SortParameters;
+};
+export declare type ActiveSeatsFindResultDataFiltersParameters = {
+    [ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE]?: FiltersParameters;
+    [ActiveSeatsFindResultFields.COLUMN_NUMBER]?: FiltersParameters;
+};
+export declare class ActiveSeatsFindResult extends AbstractEntity<ActiveSeatsFindresultData> {
+    #private;
+    constructor(data: ActiveSeatsFindresultData);
+    get lastUpdate(): string | null | undefined;
+    get number(): number | null | undefined;
+    toJSON(): ActiveSeatsFindresultData;
+}

package/build/licenses/entities/license/activeSeatsFindResult.js

@@ -0,0 +1,47 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _lastUpdate, _number;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActiveSeatsFindResult = exports.ActiveSeatsFindResultFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var ActiveSeatsFindResultFields;
+(function (ActiveSeatsFindResultFields) {
+    ActiveSeatsFindResultFields["COLUMN_LAST_UPDATE"] = "lastUpdate";
+    ActiveSeatsFindResultFields["COLUMN_NUMBER"] = "number";
+})(ActiveSeatsFindResultFields = exports.ActiveSeatsFindResultFields || (exports.ActiveSeatsFindResultFields = {}));
+class ActiveSeatsFindResult extends abstractEntity_1.AbstractEntity {
+    constructor(data) {
+        super(data);
+        _lastUpdate.set(this, void 0);
+        _number.set(this, void 0);
+        __classPrivateFieldSet(this, _lastUpdate, data[ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE]);
+        __classPrivateFieldSet(this, _number, data[ActiveSeatsFindResultFields.COLUMN_NUMBER]);
+    }
+    get lastUpdate() {
+        return __classPrivateFieldGet(this, _lastUpdate);
+    }
+    get number() {
+        return __classPrivateFieldGet(this, _number);
+    }
+    toJSON() {
+        return {
+            [ActiveSeatsFindResultFields.COLUMN_LAST_UPDATE]: this.lastUpdate,
+            [ActiveSeatsFindResultFields.COLUMN_NUMBER]: this.number,
+        };
+    }
+}
+exports.ActiveSeatsFindResult = ActiveSeatsFindResult;
+_lastUpdate = new WeakMap(), _number = new WeakMap();
+//# sourceMappingURL=activeSeatsFindResult.js.map

package/build/licenses/entities/license/configFindResult.d.ts

@@ -0,0 +1,37 @@
+import { DataKeywords, FiltersParameters, SortParameters } from '../../licensesClient';
+import { AbstractEntity } from '../../../abstractEntity';
+import { Rules } from 'validatorjs';
+export declare enum ConfigFindResultFields {
+    COLUMN_NAME = "name",
+    COLUMN_SCOPE = "scope",
+    COLUMN_STATE = "state"
+}
+export declare type ConfigFindResultData = {
+    [ConfigFindResultFields.COLUMN_NAME]: string | undefined;
+    [ConfigFindResultFields.COLUMN_SCOPE]: string | undefined;
+    [ConfigFindResultFields.COLUMN_STATE]: string | undefined;
+};
+export declare type ConfigFindResultDataKeywords = {
+    [ConfigFindResultFields.COLUMN_NAME]?: DataKeywords;
+    [ConfigFindResultFields.COLUMN_SCOPE]?: DataKeywords;
+    [ConfigFindResultFields.COLUMN_STATE]?: DataKeywords;
+};
+export declare type ConfigFindResultDataSortParameters = {
+    [ConfigFindResultFields.COLUMN_NAME]?: SortParameters;
+    [ConfigFindResultFields.COLUMN_SCOPE]?: SortParameters;
+    [ConfigFindResultFields.COLUMN_STATE]?: SortParameters;
+};
+export declare type ConfigFindResultDataFiltersParameters = {
+    [ConfigFindResultFields.COLUMN_NAME]?: FiltersParameters;
+    [ConfigFindResultFields.COLUMN_SCOPE]?: FiltersParameters;
+    [ConfigFindResultFields.COLUMN_STATE]?: FiltersParameters;
+};
+export declare class ConfigFindResult extends AbstractEntity<ConfigFindResultData> {
+    #private;
+    protected VALIDATION_RULES: Rules;
+    constructor(data: ConfigFindResultData);
+    get name(): string | undefined;
+    get scope(): string | undefined;
+    get state(): string | undefined;
+    toJSON(): ConfigFindResultData;
+}

package/build/licenses/entities/license/configFindResult.js

@@ -0,0 +1,59 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _name, _scope, _state;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigFindResult = exports.ConfigFindResultFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var ConfigFindResultFields;
+(function (ConfigFindResultFields) {
+    ConfigFindResultFields["COLUMN_NAME"] = "name";
+    ConfigFindResultFields["COLUMN_SCOPE"] = "scope";
+    ConfigFindResultFields["COLUMN_STATE"] = "state";
+})(ConfigFindResultFields = exports.ConfigFindResultFields || (exports.ConfigFindResultFields = {}));
+class ConfigFindResult extends abstractEntity_1.AbstractEntity {
+    constructor(data) {
+        super(data);
+        this.VALIDATION_RULES = {
+            [ConfigFindResultFields.COLUMN_NAME]: 'required|string',
+            [ConfigFindResultFields.COLUMN_SCOPE]: 'required|string',
+            [ConfigFindResultFields.COLUMN_STATE]: 'required|string',
+        };
+        _name.set(this, void 0);
+        _scope.set(this, void 0);
+        _state.set(this, void 0);
+        __classPrivateFieldSet(this, _name, data[ConfigFindResultFields.COLUMN_NAME]);
+        __classPrivateFieldSet(this, _scope, data[ConfigFindResultFields.COLUMN_SCOPE]);
+        __classPrivateFieldSet(this, _state, data[ConfigFindResultFields.COLUMN_STATE]);
+    }
+    get name() {
+        return __classPrivateFieldGet(this, _name);
+    }
+    get scope() {
+        return __classPrivateFieldGet(this, _scope);
+    }
+    get state() {
+        return __classPrivateFieldGet(this, _state);
+    }
+    toJSON() {
+        return {
+            [ConfigFindResultFields.COLUMN_NAME]: this.name,
+            [ConfigFindResultFields.COLUMN_SCOPE]: this.scope,
+            [ConfigFindResultFields.COLUMN_STATE]: this.state,
+        };
+    }
+}
+exports.ConfigFindResult = ConfigFindResult;
+_name = new WeakMap(), _scope = new WeakMap(), _state = new WeakMap();
+//# sourceMappingURL=configFindResult.js.map