Added archive method

Author: markus-peltola

README.md

@@ -90,6 +90,7 @@ The following API methods have been implemented:
 - `product` Product register
 - `purchaseInvoices` Purchase invoices
 - `chartOfAccounts` Chart of Accounts
+- `archive` Archive of files
 
 ### Bookkeeping examples
 
@@ -149,7 +150,8 @@ const product = await fivaldi.products.updateProductAllFields({
 });
 
 // Update only the product fields that are given
-const product = await fivaldi.products.updateProduct({ purchaseCostPrice: 155 });
+const
+ product = await fivaldi.products.updateProduct({ purchaseCostPrice: 155 });
 
 // Create product language description (translation)
 const product = await fivaldi.products.createProductDescription(
@@ -205,6 +207,12 @@ const purchaseInvoiceComment = await fivaldi.purchaseInvoices.createPurchaseInvo
 const chartOfAccounts = await fivaldi.chartOfAccounts.getChartOfAccounts();
 ```
 
+### Archive of files example
+```ts
+// Get download url for the file with file id
+const downloadUrl = await fivaldi.archive.getFileUrl('123');
+```
+
 ## Resources
 
 - Fivaldi website: https://www.visma.fi/visma-fivaldi/
@@ -216,4 +224,5 @@ const chartOfAccounts = await fivaldi.chartOfAccounts.getChartOfAccounts();
 
 - 0.0.1 First release
 - 0.1.0 Added Chart of Accounts method and fixed error logic
-- 0.1.1 Updated dependencies
+- 0.1.1 Updated dependencies
+- 0.2.0 Added Archive of files method

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rantalainen/fivaldi-api-client",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Third party Fivaldi API client.",
   "main": "dist/index.js",
   "scripts": {

src/index.ts

@@ -1,5 +1,6 @@
 import got, { Method, OptionsOfJSONResponseBody } from 'got';
 import { IFivaldiApiClientOptions, IGetCompaniesParams, IGetCompaniesResponse } from './interfaces';
+import { ArchiveMethods } from './methods/archive.methods';
 import { BookkeepingMethods } from './methods/bookkeeping.methods';
 import { ChartOfAccountsMethods } from './methods/chart-of-accounts.methods';
 import { ProductMethods } from './methods/products.methods';
@@ -13,6 +14,7 @@ export class FivaldiApiClient {
   readonly products: ProductMethods;
   readonly purchaseInvoices: PurchaseInvoicesMethods;
   readonly chartOfAccounts: ChartOfAccountsMethods;
+  readonly archive: ArchiveMethods;
 
   constructor(options: IFivaldiApiClientOptions) {
     options.apiBaseUrl = options.apiBaseUrl || 'https://api.fivaldi.net/customer/api';
@@ -32,6 +34,7 @@ export class FivaldiApiClient {
     this.products = new ProductMethods(this);
     this.purchaseInvoices = new PurchaseInvoicesMethods(this);
     this.chartOfAccounts = new ChartOfAccountsMethods(this);
+    this.archive = new ArchiveMethods(this);
   }
 
   async request(method: Method, url: string, body?: any, params?: any): Promise<any> {
@@ -59,7 +62,8 @@ export class FivaldiApiClient {
     let response: any;
     // If there is a body, parse and return it
     if (result.body) {
-      response = JSON.parse(result.body);
+      if (typeof result.body === 'object') response = JSON.parse(result.body);
+      else response = result.body;
     } else {
       // Else just return the empty body
       response = result.body;

src/methods/archive.methods.ts

@@ -0,0 +1,13 @@
+import { FivaldiApiClient } from '../index';
+import { Methods } from '../methods';
+
+export class ArchiveMethods extends Methods {
+  constructor(apiClient: FivaldiApiClient) {
+    super(apiClient, '/archive');
+  }
+
+  /** Gets download url for a file. */
+  async getFileUrl(fileId: string): Promise<String> {
+    return await super.request('GET', `/files/${fileId}`);
+  }
+}