@emilgroup/public-api-sdk-node 1.28.0 → 1.29.0

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/public-api-sdk-node@1.28.0 --save
+npm install @emilgroup/public-api-sdk-node@1.29.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/public-api-sdk-node@1.28.0
+yarn add @emilgroup/public-api-sdk-node@1.29.0
 ```
 
 And then you can import `PublicApi`.
@@ -47,6 +47,22 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
 export EMIL_PASSWORD=XXXXXXXXXXXXXX
 ```
 
+## Base path
+
+To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
+
+```ts
+import { PublicApi, Environment } from '@emilgroup/public-api-sdk-node'
+
+const publicApi = new PublicApi();
+
+// Allows you to simply choose environment. It will usually be Environment.Production.
+publicApi.selectEnvironment(Environment.Production);
+
+// For advanced users, use the custom baseUrl of the website you need to connect to.
+publicApi.selectBasePath('https://my-custom-domain.com');
+```
+
 ## Example
 
 Here is a basic functionning example:

package/api/documents-api.ts

@@ -189,10 +189,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
          * @param {string} productCode 
          * @param {string} code 
          * @param {string} [authorization] Bearer Token
+         * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocumentUrl: async (productCode: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        downloadProductDocumentUrl: async (productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'productCode' is not null or undefined
             assertParamExists('downloadProductDocumentUrl', 'productCode', productCode)
             // verify required parameter 'code' is not null or undefined
@@ -217,6 +218,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (contentDisposition !== undefined) {
+                localVarQueryParameter['contentDisposition'] = contentDisposition;
+            }
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
@@ -480,11 +485,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
          * @param {string} productCode 
          * @param {string} code 
          * @param {string} [authorization] Bearer Token
+         * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, options);
+        async downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -584,11 +590,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
          * @param {string} productCode 
          * @param {string} code 
          * @param {string} [authorization] Bearer Token
+         * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
-            return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, options).then((request) => request(axios, basePath));
+        downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
+            return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of documents you have previously created.        The documents are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
@@ -733,6 +740,13 @@ export interface DocumentsApiDownloadProductDocumentUrlRequest {
      * @memberof DocumentsApiDownloadProductDocumentUrl
      */
     readonly authorization?: string
+
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof DocumentsApiDownloadProductDocumentUrl
+     */
+    readonly contentDisposition?: 'attachment' | 'inline'
 }
 
 /**
@@ -927,7 +941,7 @@ export class DocumentsApi extends BaseAPI {
      * @memberof DocumentsApi
      */
     public downloadProductDocumentUrl(requestParameters: DocumentsApiDownloadProductDocumentUrlRequest, options?: AxiosRequestConfig) {
-        return DocumentsApiFp(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return DocumentsApiFp(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api/documents-api.d.ts

@@ -57,10 +57,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} productCode
      * @param {string} code
      * @param {string} [authorization] Bearer Token
+     * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    downloadProductDocumentUrl: (productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    downloadProductDocumentUrl: (productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of documents you have previously created.        The documents are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List documents
@@ -139,10 +140,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {string} productCode
      * @param {string} code
      * @param {string} [authorization] Bearer Token
+     * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
+    downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
     /**
      * Returns a list of documents you have previously created.        The documents are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List documents
@@ -221,10 +223,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {string} productCode
      * @param {string} code
      * @param {string} [authorization] Bearer Token
+     * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
+    downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
     /**
      * Returns a list of documents you have previously created.        The documents are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List documents
@@ -351,6 +354,12 @@ export interface DocumentsApiDownloadProductDocumentUrlRequest {
      * @memberof DocumentsApiDownloadProductDocumentUrl
      */
     readonly authorization?: string;
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof DocumentsApiDownloadProductDocumentUrl
+     */
+    readonly contentDisposition?: 'attachment' | 'inline';
 }
 /**
  * Request parameters for listDocuments operation in DocumentsApi.

package/dist/api/documents-api.js

@@ -251,10 +251,11 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
          * @param {string} productCode
          * @param {string} code
          * @param {string} [authorization] Bearer Token
+         * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocumentUrl: function (productCode, code, authorization, options) {
+        downloadProductDocumentUrl: function (productCode, code, authorization, contentDisposition, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -283,6 +284,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
+                            if (contentDisposition !== undefined) {
+                                localVarQueryParameter['contentDisposition'] = contentDisposition;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -568,15 +572,16 @@ var DocumentsApiFp = function (configuration) {
          * @param {string} productCode
          * @param {string} code
          * @param {string} [authorization] Bearer Token
+         * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocumentUrl: function (productCode, code, authorization, options) {
+        downloadProductDocumentUrl: function (productCode, code, authorization, contentDisposition, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -708,11 +713,12 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
          * @param {string} productCode
          * @param {string} code
          * @param {string} [authorization] Bearer Token
+         * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocumentUrl: function (productCode, code, authorization, options) {
-            return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, options).then(function (request) { return request(axios, basePath); });
+        downloadProductDocumentUrl: function (productCode, code, authorization, contentDisposition, options) {
+            return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Returns a list of documents you have previously created.        The documents are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
@@ -818,7 +824,7 @@ var DocumentsApi = /** @class */ (function (_super) {
      */
     DocumentsApi.prototype.downloadProductDocumentUrl = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.DocumentsApiFp)(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentsApiFp)(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Returns a list of documents you have previously created.        The documents are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/public-api-sdk-node",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "description": "OpenAPI client for @emilgroup/public-api-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [