@arrowsphere/api-client 3.112.0 → 3.113.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.113.0] - 2024.04.24
+
+### Added
+- [License Bulk actions] allow REST clients to post a file with form/multipart
+- [License Bulk actions] send file to upload changes
+
 ## [3.112.0] - 2024.04.24
 
 ### Added
@@ -67,7 +73,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [customer/contact] add organization object in customer contact payload
 
 ### Updated
-- Add sommes configs for IDE
+- Add some configs for IDE
 
 ## [3.101.0] - 2024.03.19
 

package/build/abstractRestfulClient.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="node" />
 import { AxiosInstance, AxiosResponse } from 'axios';
 import { AbstractHttpClient, Headers } from './AbstractHttpClient';
+import { File } from 'node:buffer';
 /**
  * Lists of available query parameters for the API call
  */
@@ -26,7 +28,15 @@ export declare type ParametersWithPaginationType = (Parameters & {
     [ParameterKeys.PER_PAGE_CAMEL]?: number;
 });
 export declare type Parameters = Record<string, string | string[] | number | number[] | boolean | null | undefined>;
+export declare enum FileUploadKeys {
+    Fields = "fields",
+    File = "file"
+}
 export declare type Payload = Record<string, unknown> | Array<Payload>;
+export interface PayloadWithFile {
+    [FileUploadKeys.Fields]?: Record<string, unknown>;
+    [FileUploadKeys.File]?: File;
+}
 export declare type Options = {
     isAdmin?: boolean;
     returnAxiosData?: boolean;
@@ -145,7 +155,7 @@ export declare abstract class AbstractRestfulClient extends AbstractHttpClient {
      */
     private prepareHeaders;
     /**
-     * Sends a POST request and returns the response
+     * Sends a POST request including file with header form/multipart and returns the response
      * @returns Promise\<AxiosResponse['data']\>
      * @param payload - Payload to be sent in the POST body
      * @param parameters - Query parameters to be sent in the request
@@ -153,6 +163,15 @@ export declare abstract class AbstractRestfulClient extends AbstractHttpClient {
      * @param options - Options to send
      */
     protected post(payload?: Payload, parameters?: Parameters, headers?: Headers, options?: Options): Promise<AxiosResponse['data']>;
+    /**
+     * Sends a POST request and returns the response
+     * @returns Promise\<AxiosResponse['data']\>
+     * @param payload - Payload to be sent in the POST body
+     * @param parameters - Query parameters to be sent in the request
+     * @param headers - Headers to be sent in the request
+     * @param options - Options to send
+     */
+    protected postFile(payload: PayloadWithFile, parameters?: Parameters, headers?: Headers, options?: Options): Promise<AxiosResponse['data']>;
     /**
      * Sends a PUT request
      * @param payload - Payload to be sent in the POST body

package/build/abstractRestfulClient.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.AbstractRestfulClient = exports.ExtraInformationFields = exports.ParameterKeys = void 0;
+exports.AbstractRestfulClient = exports.FileUploadKeys = exports.ExtraInformationFields = exports.ParameterKeys = void 0;
 const exception_1 = require("./exception");
 const querystring_1 = __importDefault(require("querystring"));
 const path_1 = __importDefault(require("path"));
@@ -29,6 +29,11 @@ var ExtraInformationFields;
 (function (ExtraInformationFields) {
     ExtraInformationFields["COLUMN_EXTRA_INFORMATION"] = "extraInformation";
 })(ExtraInformationFields = exports.ExtraInformationFields || (exports.ExtraInformationFields = {}));
+var FileUploadKeys;
+(function (FileUploadKeys) {
+    FileUploadKeys["Fields"] = "fields";
+    FileUploadKeys["File"] = "file";
+})(FileUploadKeys = exports.FileUploadKeys || (exports.FileUploadKeys = {}));
 class AbstractRestfulClient extends AbstractHttpClient_1.AbstractHttpClient {
     /**
      * AbstractClient constructor.
@@ -161,7 +166,7 @@ class AbstractRestfulClient extends AbstractHttpClient_1.AbstractHttpClient {
         };
     }
     /**
-     * Sends a POST request and returns the response
+     * Sends a POST request including file with header form/multipart and returns the response
      * @returns Promise\<AxiosResponse['data']\>
      * @param payload - Payload to be sent in the POST body
      * @param parameters - Query parameters to be sent in the request
@@ -191,6 +196,49 @@ class AbstractRestfulClient extends AbstractHttpClient_1.AbstractHttpClient {
             throw error;
         }
     }
+    /**
+     * Sends a POST request and returns the response
+     * @returns Promise\<AxiosResponse['data']\>
+     * @param payload - Payload to be sent in the POST body
+     * @param parameters - Query parameters to be sent in the request
+     * @param headers - Headers to be sent in the request
+     * @param options - Options to send
+     */
+    async postFile(payload, parameters = {}, headers = {}, options = {}) {
+        var _a;
+        if (!payload[FileUploadKeys.File]) {
+            throw new Error('File upload required');
+        }
+        // will force axios to append header 'multipart/form-data' and will attach a boundary automatically
+        headers['Content-Type'] = undefined;
+        const url = this.generateUrl(parameters, options);
+        const config = {
+            headers: this.prepareHeaders(headers),
+        };
+        const formData = new FormData();
+        formData.append(FileUploadKeys.File, payload[FileUploadKeys.File]);
+        for (const [key, value] of Object.entries((_a = payload[FileUploadKeys.Fields]) !== null && _a !== void 0 ? _a : {})) {
+            console.log(`${key}: ${value}`);
+            formData.set(key, value);
+        }
+        try {
+            const response = await this.client.post(url, formData, config);
+            return this.getResponse(response, options);
+        }
+        catch (error) {
+            if (error instanceof exception_1.PublicApiClientException) {
+                const { mustRetry } = await this.handleError(error);
+                if (mustRetry) {
+                    const config = {
+                        headers: this.prepareHeaders(headers),
+                    };
+                    const response = await this.client.post(url, payload, config);
+                    return this.getResponse(response, options);
+                }
+            }
+            throw error;
+        }
+    }
     /**
      * Sends a PUT request
      * @param payload - Payload to be sent in the POST body

package/build/licenses/licensesClient.js

@@ -335,13 +335,13 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
             };
             postData = postSetRateData;
         }
-        /*else if (bulkData.actionType == ActionTypes.UPLOAD_CHANGES) {
-          const postUploadChangesData: BulkUploadChangesBody = {
-            ...postData,
-            [BulkBodyFields.FILE]: bulkData.file,
-          };
-          postData = postUploadChangesData;
-        }*/
+        else if (bulkData.actionType == bulkArguments_1.ActionTypes.UPLOAD_CHANGES) {
+            const payload = {
+                [abstractRestfulClient_1.FileUploadKeys.Fields]: postData,
+                [abstractRestfulClient_1.FileUploadKeys.File]: bulkData[bulkArguments_1.BulkBodyFields.FILE],
+            };
+            return await this.postFile(payload);
+        }
         return await this.post(postData);
     }
     async updateConfig(reference, config) {

package/build/licenses/types/bulkArguments.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import type { Except } from 'type-fest';
+import { File } from 'node:buffer';
 export declare enum ActionTypes {
     SET_RATE = "setRate",
     AUTO_RENEW = "autoRenew",
@@ -37,7 +39,8 @@ export declare type BulkBodyArgument = {
     [BulkBodyFields.SPECIAL_PRICE_RATE_TYPE]?: SpecialPriceRateTypes;
     [BulkBodyFields.SPECIAL_PRICE_RATE_VALUE]?: string;
     [BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE]?: SpecialRateEffectiveApplicationDate;
+    [BulkBodyFields.FILE]?: File;
 };
 export declare type BulkAutoRenewBody = Except<BulkBodyArgument, BulkBodyFields.SPECIAL_PRICE_RATE_TYPE & BulkBodyFields.SPECIAL_PRICE_RATE_VALUE & BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE & BulkBodyFields.FILE>;
 export declare type BulkSetRateBody = Except<BulkBodyArgument, BulkBodyFields.AUTO_RENEW_STATUS & BulkBodyFields.FILE>;
-export declare type BulkUploadChangesBody = Except<BulkBodyArgument, BulkBodyFields.AUTO_RENEW_STATUS & BulkBodyFields.SPECIAL_PRICE_RATE_TYPE & BulkBodyFields.SPECIAL_PRICE_RATE_VALUE & BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE>;
+export declare type BulkUploadChangesBody = Except<BulkBodyArgument, BulkBodyFields.AUTO_RENEW_STATUS & BulkBodyFields.FILE & BulkBodyFields.SPECIAL_PRICE_RATE_TYPE & BulkBodyFields.SPECIAL_PRICE_RATE_VALUE & BulkBodyFields.SPECIAL_RATE_EFFECTIVE_APPLICATION_DATE>;

package/package.json

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