totalum-api-sdk 1.0.3 → 1.0.5

package/README.MD

@@ -1,3 +1,67 @@
 ## Totalum api sdk wraper
 
-This library wraps the totalum public api, so you can easy call all endpoints
+This library wraps the totalum public api, so you can easy call all endpoints.
+
+
+## Usage:
+
+```bash
+npm i totalum-api-sdk
+```
+
+We recomend you to use the api key instead of the token.
+
+```javascript
+// IN TYPESCRIPT
+
+import {AuthOptions, TotalumApiSdk} from 'totalum-api-sdk';
+
+// the auth using token
+const options: AuthOptions = {
+    token:{
+        accessToken: 'YOUR TOKEN'
+    }
+}
+
+// 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'
+    }
+}
+
+const totalumClient = new TotalumApiSdk(options);
+
+// execute some function
+
+const result = await totalumClient.getItems('your_item', {});
+```
+
+```javascript
+// IN JAVASCRIPT
+
+const totalum = require('totalum-api-sdk');
+
+// the auth using token
+const options = {
+    token:{
+        accessToken: 'YOUR TOKEN'
+    }
+}
+
+// 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'
+    }
+}
+
+const totalumClient = new totalum.TotalumApiSdk(options);
+
+const result = await totalumClient.getItems('your_item', {});
+
+```

package/index.ts

@@ -99,12 +99,13 @@ export interface AuthOptions {
     }, 
     apiKey?: {
         apiKey:string,
-        organizationId:string
+        apiKeyName:string,
+        organizationId:string,
     }
 }
 
 export class TotalumApiSdk {
-  private baseUrl= 'https://api.totalum.app/';
+  public baseUrl= 'https://api.totalum.app/';
   private authOptions: AuthOptions;
   private headers: {[key:string]: string};
 
@@ -116,13 +117,18 @@ export class TotalumApiSdk {
         }
     } else if(this.authOptions.apiKey?.apiKey && this.authOptions.apiKey?.organizationId) {
         this.headers = {
-            apiKey: this.authOptions.apiKey.apiKey,
-            organizationId: this.authOptions.apiKey.organizationId
+            'api-key': this.authOptions.apiKey.apiKey,
+            'organization-id': this.authOptions.apiKey.organizationId,
+            'api-key-name': this.authOptions.apiKey.apiKeyName
         }
     } else {
         throw new Error('Error: invalid auth options')
     }
-  } 
+  }
+
+  public changeBaseUrl(newBaseUrl:string){
+    this.baseUrl = newBaseUrl;
+  }   
 
   private getUrl(pattern: string, params?: any): string {
     let url = this.baseUrl + pattern;
@@ -152,4 +158,18 @@ export class TotalumApiSdk {
     const url = this.getUrl(endpoints.crud.createObject, {typeId: itemType});
     return axios.post(url, item, {headers: this.headers});
   }
+
+  /**
+   * 
+   * @param customMongoFilter an string with the mongo filter query
+   * @param rootTypeId an string with the id of the element that we make the aggregation query
+   * @param typeIdToGet the id of the type that we want to get
+   * @param options 
+   * @param returnCount 
+   */
+  public async customMongoFilter(customMongoFilter: string,rootTypeId:string, typeIdToGet:string, options?: {variables: any, pagination?: any, sort: any}, returnCount?:boolean){
+
+  }
+
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "totalum-api-sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Totalum sdk wraper of totalum api",
   "main": "index.js",
   "scripts": {