totalum-api-sdk 2.0.9 → 2.0.11

package/README.MD

@@ -9,59 +9,83 @@ This library wraps the totalum public api, so you can easy call all endpoints.
 npm i totalum-api-sdk
 ```
 
-We recomend you to use the api key instead of the token.
 
-```javascript
+# Usage of TotalumApiSdk
+
+Totalum allows you to use the SDK to perform actions such as creating users, creating items, creating pdfs, etc.
+
+Basically the Totalum sdk is a wrapper of the Totalum api, so if you want you can use the api directly if you prefer.
+
+
+## Authentication
+
+You can choose to use one of the two authentication methods offered by Totalum Sdk:
+
+- **Token**: You can use an access token to authenticate. This token can be obtained from the localStorage of your browser from the web https://web.totalum.app
+
+- **ApiKey**: (RECOMMENDED OPTION) You can use an ApiKey to authenticate. This ApiKey can be obtained in the **Api Keys** section of the **Configuration** section of Totalum.
+
+**In Typescript:**
+
+```typescript
+
 // IN TYPESCRIPT
 
 import {AuthOptions, TotalumApiSdk} from 'totalum-api-sdk';
 
+// CHOISE FROM USE accessToken OR apiKey (API KEY IS RECOMMENDED)
+
 // the auth using token
 const options: AuthOptions = {
     token:{
-        accessToken: 'YOUR TOKEN'
+        accessToken: 'YOUR TOKEN' // get it from totalum project web localStorage
     }
 }
 
 // the auth using api key
 const options: AuthOptions = {
     apiKey:{
-        'api-key': 'your_api_key',
-        'api-key-name': 'your_api_key_name',
-        'organization-id': 'your_organization_id'
+        'api-key': 'your_api_key', //the api key secret that is shown only once
+        'api-key-name': 'your_api_key_name', // the name of the api key that you can see in the api keys section
+        'organization-id': 'your_organization_id' // your project name (project id) Get it from Configuration -> Información Proyecto -> Nombre del proyecto (project id)
     }
 }
 
 const totalumClient = new TotalumApiSdk(options);
 
-// execute some function
-
+// execute some TotalumApiSdk function
 const result = await totalumClient.crud.getItems('your_item', {});
+    
 ```
 
+**In Javascript:**
+
 ```javascript
 // IN JAVASCRIPT
 
 const totalum = require('totalum-api-sdk');
 
+// CHOICE FROM USE accessToken OR apiKey (API KEY IS RECOMMENDED)
+
 // the auth using token
 const options = {
     token:{
-        accessToken: 'YOUR TOKEN'
+        accessToken: 'YOUR TOKEN' // get it from totalum project web localStorage
     }
 }
 
 // the auth using api key
 const options: AuthOptions = {
     apiKey:{
-        'api-key': 'your_api_key',
-        'api-key-name': 'your_api_key_name',
-        'organization-id': 'your_organization_id'
+        'api-key': 'your_api_key', //the api key secret that is shown only once
+        'api-key-name': 'your_api_key_name', // the name of the api key that you can see in the api keys section
+        'organization-id': 'your_organization_id' // your project name (project id) Get it from Configuration -> Información Proyecto -> Nombre del proyecto (project id)
     }
 }
 
 const totalumClient = new totalum.TotalumApiSdk(options);
 
+// execute some TotalumApiSdk function
 const result = await totalumClient.crud.getItems('your_item', {});
-
+        
 ```

package/dist/common/interfaces.d.ts

@@ -103,7 +103,7 @@ export interface StructureLevels {
 }
 export interface FilterSearchQueryI {
     filter?: FiltersArrayI;
-    sort?: ISearchQuerySort[];
+    sort?: ISearchQuerySort;
     pagination?: {
         limit?: number;
         page?: number;

package/dist/services/FilesService.d.ts

@@ -3,7 +3,15 @@ export declare class FilesService {
     private baseUrl;
     constructor(baseUrl: string, headers: any);
     uploadFile(fileFormData: any): Promise<import("axios").AxiosResponse<any, any>>;
-    getDownloadUrl(fileName: string): Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     *
+     * @param fileName
+     * @param options options.expirationTime - is the time in milliseconds that the signed URL should be valid for. The default is 128 hours
+     * @returns
+     */
+    getDownloadUrl(fileName: string, options: {
+        expirationTime: number;
+    }): Promise<import("axios").AxiosResponse<any, any>>;
     generatePdfByTemplate(id: string, variables: {
         [variableName: string]: any;
     }, name: string): Promise<import("axios").AxiosResponse<any, any>>;

package/dist/services/FilesService.js

@@ -27,10 +27,16 @@ class FilesService {
             return axios_1.default.post(url, fileFormData, { headers: this.headers });
         });
     }
-    getDownloadUrl(fileName) {
+    /**
+     *
+     * @param fileName
+     * @param options options.expirationTime - is the time in milliseconds that the signed URL should be valid for. The default is 128 hours
+     * @returns
+     */
+    getDownloadUrl(fileName, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = utils_1.UtilsService.getUrl(this.baseUrl, endpoints_1.endpoints.files.getDownloadUrl, { fileName });
-            return axios_1.default.get(url, { headers: this.headers });
+            return axios_1.default.get(url, { headers: this.headers, params: options });
         });
     }
     generatePdfByTemplate(id, variables, name) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "totalum-api-sdk",
-  "version": "2.0.9",
-  "description": "Totalum sdk wraper of totalum api",
+  "version": "2.0.11",
+  "description": "Totalum sdk wrapper and utils of totalum api",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": ["dist"],