@arrowsphere/api-client 3.24.0-rc.4 → 3.24.0-rc.6

package/build/abstractClient.d.ts

@@ -4,7 +4,6 @@ import { AxiosInstance, AxiosResponse } from 'axios';
  */
 export declare enum ParameterKeys {
     API_KEY = "apiKey",
-    EXTRA_INFORMATION = "extraInformation",
     HEADERS = "headers",
     ORDER_BY = "order_by",
     PAGE = "page",
@@ -13,9 +12,11 @@ export declare enum ParameterKeys {
     SORT_BY = "sort_by",
     URL = "url"
 }
+export declare enum ExtraInformationFields {
+    COLUMN_EXTRA_INFORMATION = "extraInformation"
+}
 export declare type Parameters = Record<string, string | string[] | number | number[] | boolean | null | undefined>;
 export declare type Headers = Record<string, string>;
-export declare type ExtraInformation = Record<string, unknown> | undefined;
 export declare type Payload = Record<string, unknown>;
 export declare type Options = {
     isAdmin?: boolean;
@@ -24,8 +25,8 @@ export declare type ConfigurationsClient = {
     [ParameterKeys.API_KEY]?: string;
     [ParameterKeys.URL]?: string;
     [ParameterKeys.HEADERS]?: Headers;
-    [ParameterKeys.EXTRA_INFORMATION]?: ExtraInformation;
 };
+export declare type ExtraInformationType = Record<string, unknown>;
 export declare abstract class AbstractClient {
     /**
      * Base path for HTTP calls
@@ -63,10 +64,6 @@ export declare abstract class AbstractClient {
      * Defines header information for axios call
      */
     protected headers: Headers;
-    /**
-     * Defines extra information in payload
-     */
-    protected extraInformation: Record<string, unknown>;
     /**
      * AbstractClient constructor.
      * @returns AbstractClient
@@ -107,7 +104,6 @@ export declare abstract class AbstractClient {
      * @returns AbstractClient
      */
     setHeaders(headers: Record<string, string>): this;
-    setExtraInformation(extraInformation: ExtraInformation): this;
     /**
      * Sends a GET request and returns the response
      * @param parameters - Query parameters to send
@@ -176,5 +172,4 @@ export declare abstract class AbstractClient {
      * @returns {@link Parameters}
      */
     private generatePagination;
-    private generatePayload;
 }

package/build/abstractClient.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractClient = exports.ParameterKeys = void 0;
+exports.AbstractClient = exports.ExtraInformationFields = exports.ParameterKeys = void 0;
 const exception_1 = require("./exception");
 const querystring_1 = __importDefault(require("querystring"));
 const url_1 = require("url");
@@ -15,7 +15,6 @@ const axiosSingleton_1 = require("./axiosSingleton");
 var ParameterKeys;
 (function (ParameterKeys) {
     ParameterKeys["API_KEY"] = "apiKey";
-    ParameterKeys["EXTRA_INFORMATION"] = "extraInformation";
     ParameterKeys["HEADERS"] = "headers";
     ParameterKeys["ORDER_BY"] = "order_by";
     ParameterKeys["PAGE"] = "page";
@@ -24,13 +23,17 @@ var ParameterKeys;
     ParameterKeys["SORT_BY"] = "sort_by";
     ParameterKeys["URL"] = "url";
 })(ParameterKeys = exports.ParameterKeys || (exports.ParameterKeys = {}));
+var ExtraInformationFields;
+(function (ExtraInformationFields) {
+    ExtraInformationFields["COLUMN_EXTRA_INFORMATION"] = "extraInformation";
+})(ExtraInformationFields = exports.ExtraInformationFields || (exports.ExtraInformationFields = {}));
 class AbstractClient {
     /**
      * AbstractClient constructor.
      * @returns AbstractClient
      */
     constructor(configuration) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         /**
          * Base path for HTTP calls
          */
@@ -63,15 +66,10 @@ class AbstractClient {
          * Defines header information for axios call
          */
         this.headers = {};
-        /**
-         * Defines extra information in payload
-         */
-        this.extraInformation = {};
         this.client = axiosSingleton_1.AxiosSingleton.getInstance();
         this.setApiKey((_a = configuration === null || configuration === void 0 ? void 0 : configuration[ParameterKeys.API_KEY]) !== null && _a !== void 0 ? _a : '');
         this.setUrl((_b = configuration === null || configuration === void 0 ? void 0 : configuration[ParameterKeys.URL]) !== null && _b !== void 0 ? _b : '');
         this.setHeaders((_c = configuration === null || configuration === void 0 ? void 0 : configuration[ParameterKeys.HEADERS]) !== null && _c !== void 0 ? _c : {});
-        this.setExtraInformation((_d = configuration === null || configuration === void 0 ? void 0 : configuration[ParameterKeys.EXTRA_INFORMATION]) !== null && _d !== void 0 ? _d : undefined);
     }
     /**
      * Sets the Client ArrowSphere API key
@@ -125,12 +123,6 @@ class AbstractClient {
         this.headers = headers;
         return this;
     }
-    setExtraInformation(extraInformation) {
-        this.extraInformation = extraInformation
-            ? { extraInformation: extraInformation }
-            : {};
-        return this;
-    }
     /**
      * Sends a GET request and returns the response
      * @param parameters - Query parameters to send
@@ -180,7 +172,7 @@ class AbstractClient {
      * @param options - Options to send
      */
     async post(payload = {}, parameters = {}, headers = {}, options = {}) {
-        const response = await this.client.post(this.generateUrl(parameters, options), this.generatePayload(payload), {
+        const response = await this.client.post(this.generateUrl(parameters, options), payload, {
             headers: this.prepareHeaders(headers),
         });
         return this.getResponse(response);
@@ -194,7 +186,7 @@ class AbstractClient {
      * @returns Promise\<void\>
      */
     async put(payload = {}, parameters = {}, headers = {}, options = {}) {
-        const response = await this.client.put(this.generateUrl(parameters, options), this.generatePayload(payload), {
+        const response = await this.client.put(this.generateUrl(parameters, options), payload, {
             headers: this.prepareHeaders(headers),
         });
         return this.getResponse(response);
@@ -260,12 +252,6 @@ class AbstractClient {
         }
         return params;
     }
-    generatePayload(payload) {
-        return {
-            ...payload,
-            ...this.extraInformation,
-        };
-    }
 }
 exports.AbstractClient = AbstractClient;
 //# sourceMappingURL=abstractClient.js.map

package/build/licenses/licensesClient.d.ts

@@ -1,7 +1,7 @@
 /**
  * Class LicensesClient
  */
-import { AbstractClient, Parameters } from '../abstractClient';
+import { AbstractClient, ExtraInformationFields, ExtraInformationType, Parameters } from '../abstractClient';
 import { FindConfig, FindData, FindResult } from './entities/findResult';
 import { ConfigFindResult, ConfigFindResultData, ConfigFindResultDataKeywords, ConfigFindResultDataSortParameters } from './entities/license/configFindResult';
 import { LicenceFindDataFiltersParameters, LicenceFindDataKeywords, LicenceFindDataSortParameters } from './entities/license/licenseFindResult';
@@ -190,9 +190,26 @@ export declare type LicenseFindRawPayload = {
 };
 export declare type UpdateSeatsData = {
     [LicenseGetFields.COLUMN_SEATS]: number;
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
 };
 export declare type PutFriendlyName = {
     [LicenseGetFields.COLUMN_FRIENDLY_NAME]: string;
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
+};
+export declare type PutReactivate = {
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
+};
+export declare type PutSuspend = {
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
+};
+export declare type PutCancel = {
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
+};
+export declare type PutCancelAutoRenew = {
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
+};
+export declare type PutReactivateAutoRenew = {
+    [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: ExtraInformationType;
 };
 export declare class LicensesClient extends AbstractClient {
     /**
@@ -266,11 +283,11 @@ export declare class LicensesClient extends AbstractClient {
     updateConfig(reference: string, config: ConfigFindResult): Promise<ConfigFindResult>;
     getLicense(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetLicenseResult>>;
     updateSeats(licenseReference: string, putData: UpdateSeatsData, parameters?: Parameters): Promise<void>;
-    suspendLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
-    reactivateLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
-    cancelLicense(licenseReference: string, parameters?: Parameters): Promise<void>;
+    suspendLicense(licenseReference: string, payload?: PutSuspend, parameters?: Parameters): Promise<void>;
+    reactivateLicense(licenseReference: string, payload?: PutReactivate, parameters?: Parameters): Promise<void>;
+    cancelLicense(licenseReference: string, payload?: PutCancel, parameters?: Parameters): Promise<void>;
     updateFriendlyName(licenseReference: string, putData: PutFriendlyName, parameters?: Parameters): Promise<void>;
     getHistory(licenseReference: string, parameters?: Parameters): Promise<GetResult<LicenceHistoryResult>>;
-    cancelAutoRenew(licenseReference: string, parameters?: Parameters): Promise<void>;
-    reactivateAutoRenew(licenseReference: string, parameters?: Parameters): Promise<void>;
+    cancelAutoRenew(licenseReference: string, payload?: PutCancelAutoRenew, parameters?: Parameters): Promise<void>;
+    reactivateAutoRenew(licenseReference: string, payload?: PutReactivateAutoRenew, parameters?: Parameters): Promise<void>;
 }

package/build/licenses/licensesClient.js

@@ -274,17 +274,17 @@ class LicensesClient extends abstractClient_1.AbstractClient {
         this.path = licenseReference + this.SEATS_PATH;
         return this.put(putData, parameters);
     }
-    suspendLicense(licenseReference, parameters = {}) {
+    suspendLicense(licenseReference, payload, parameters = {}) {
         this.path = licenseReference + this.SUSPEND_PATH;
-        return this.put(undefined, parameters);
+        return this.put(payload, parameters);
     }
-    reactivateLicense(licenseReference, parameters = {}) {
+    reactivateLicense(licenseReference, payload, parameters = {}) {
         this.path = licenseReference + this.REACTIVATE_PATH;
-        return this.put(undefined, parameters);
+        return this.put(payload, parameters);
     }
-    cancelLicense(licenseReference, parameters = {}) {
+    cancelLicense(licenseReference, payload, parameters = {}) {
         this.path = licenseReference + this.CANCEL_PATH;
-        return this.put(undefined, parameters);
+        return this.put(payload, parameters);
     }
     async updateFriendlyName(licenseReference, putData, parameters = {}) {
         this.path = licenseReference + this.UPDATE_FRIENDLYNAME_PATH;
@@ -294,13 +294,13 @@ class LicensesClient extends abstractClient_1.AbstractClient {
         this.path = licenseReference + this.GET_LICENSE_HISTORY_PATH;
         return new getResult_1.GetResult(licenceHistoryResult_1.LicenceHistoryResult, await this.get(parameters));
     }
-    async cancelAutoRenew(licenseReference, parameters = {}) {
+    async cancelAutoRenew(licenseReference, payload, parameters = {}) {
         this.path = licenseReference + this.CANCEL_AUTO_RENEW_PATH;
-        return await this.put(undefined, parameters);
+        return await this.put(payload, parameters);
     }
-    async reactivateAutoRenew(licenseReference, parameters = {}) {
+    async reactivateAutoRenew(licenseReference, payload, parameters = {}) {
         this.path = licenseReference + this.REACTIVATE_AUTO_RENEW_PATH;
-        return await this.put(undefined, parameters);
+        return await this.put(payload, parameters);
     }
 }
 exports.LicensesClient = LicensesClient;

package/package.json

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