@chift/chift-nodejs 1.0.7 → 1.0.8

package/dist/test/modules/accounting.test.js

@@ -552,3 +552,31 @@ let miscOperations;
     (0, globals_1.expect)(financialEntry).toBeTruthy();
     (0, globals_1.expect)(financialEntry).toHaveProperty('journal_id', journal.id);
 }));
+let folders = [];
+(0, globals_1.test)('getFolders', () => __awaiter(void 0, void 0, void 0, function* () {
+    folders = yield consumer.accounting.getFolders();
+    (0, globals_1.expect)(folders).toBeInstanceOf(Array);
+    (0, globals_1.expect)(folders.length).toBeGreaterThan(0);
+    (0, globals_1.expect)(folders[0]).toHaveProperty('id', globals_1.expect.any(String));
+    (0, globals_1.expect)(folders[0]).toHaveProperty('name', globals_1.expect.any(String));
+}));
+globals_1.test.skip('getAttachments', () => __awaiter(void 0, void 0, void 0, function* () {
+    const attachments = yield consumer.accounting.getAttachments({
+        // TODO: Add documentId from test account
+        documentId: '',
+        type: 'invoice',
+    });
+    (0, globals_1.expect)(attachments).toBeInstanceOf(Array);
+    (0, globals_1.expect)(attachments.length).toBeGreaterThan(0);
+    (0, globals_1.expect)(attachments[0]).toHaveProperty('id', globals_1.expect.any(String));
+    (0, globals_1.expect)(attachments[0]).toHaveProperty('base64_string', globals_1.expect.any(String));
+}));
+globals_1.test.skip('matchEntries', () => __awaiter(void 0, void 0, void 0, function* () {
+    const match = yield consumer.accounting.matchEntries({
+        // TODO: Change params with test account values
+        entries: [],
+        partner_id: '',
+    });
+    (0, globals_1.expect)(match).toHaveProperty('matching_number', globals_1.expect.any(String));
+    (0, globals_1.expect)(match).toHaveProperty('balance', globals_1.expect.any(Number));
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chift/chift-nodejs",
-    "version": "1.0.7",
+    "version": "1.0.8",
     "description": "The Chift NodeJS library provides convenient access to the Chift API from applications written in the NodeJS language (Javascript/Typescript).",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",

package/src/modules/accounting.ts

@@ -37,14 +37,20 @@ type getOutstandingsParams = Omit<
 >;
 
 const accountingFactory = {
-    getAnalyticPlans(): RequestData<components['schemas']['AnalyticPlanItem'][]> {
+    getAnalyticPlans(
+        params: operations['accounting_get_analytic_plans']['parameters']['query']
+    ): RequestData<components['schemas']['AnalyticPlanItem'][]> {
         return {
+            params,
             method: 'get',
             url: '/consumers/{consumer_id}/accounting/analytic-plans',
         };
     },
-    getClients(): RequestData<components['schemas']['ClientItemOut'][]> {
+    getClients(
+        params: operations['accounting_get_clients']['parameters']['query']
+    ): RequestData<components['schemas']['ClientItemOut'][]> {
         return {
+            params,
             method: 'get',
             url: '/consumers/{consumer_id}/accounting/clients',
         };
@@ -54,30 +60,39 @@ const accountingFactory = {
         params: operations['accounting_create_client']['parameters']['query']
     ): RequestData<components['schemas']['ClientItemOut']> {
         return {
+            params,
             method: 'post',
             url: '/consumers/{consumer_id}/accounting/clients',
             body: client,
-            params: params,
         };
     },
-    getClient(clientId: string): RequestData<components['schemas']['ClientItemOut']> {
+    getClient(
+        clientId: string,
+        params: operations['accounting_get_client']['parameters']['query']
+    ): RequestData<components['schemas']['ClientItemOut']> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/clients/${clientId}`,
         };
     },
     updateClient(
         clientId: string,
-        client: components['schemas']['ClientItemUpdate']
+        client: components['schemas']['ClientItemUpdate'],
+        params: operations['accounting_update_client']['parameters']['query']
     ): RequestData<components['schemas']['ClientItemOut']> {
         return {
+            params,
             method: 'patch',
             url: `/consumers/{consumer_id}/accounting/clients/${clientId}`,
             body: client,
         };
     },
-    getSuppliers(): RequestData<components['schemas']['SupplierItemOut'][]> {
+    getSuppliers(
+        params: operations['accounting_get_suppliers']['parameters']['query']
+    ): RequestData<components['schemas']['SupplierItemOut'][]> {
         return {
+            params,
             method: 'get',
             url: '/consumers/{consumer_id}/accounting/suppliers',
         };
@@ -87,23 +102,29 @@ const accountingFactory = {
         params: operations['accounting_create_supplier']['parameters']['query']
     ): RequestData<components['schemas']['SupplierItemOut']> {
         return {
+            params,
             method: 'post',
             url: '/consumers/{consumer_id}/accounting/suppliers',
             body: supplier,
-            params: params,
         };
     },
-    getSupplier(supplierId: string): RequestData<components['schemas']['SupplierItemOut']> {
+    getSupplier(
+        supplierId: string,
+        params: operations['accounting_get_supplier']['parameters']['query']
+    ): RequestData<components['schemas']['SupplierItemOut']> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/suppliers/${supplierId}`,
         };
     },
     updateSupplier(
         supplierId: string,
-        supplier: components['schemas']['SupplierItemUpdate']
+        supplier: components['schemas']['SupplierItemUpdate'],
+        params: operations['accounting_update_supplier']['parameters']['query']
     ): RequestData<components['schemas']['SupplierItemOut']> {
         return {
+            params,
             method: 'patch',
             url: `/consumers/{consumer_id}/accounting/suppliers/${supplierId}`,
             body: supplier,
@@ -172,43 +193,54 @@ const accountingFactory = {
         };
     },
     createAnalyticAccount(
-        analyticAccount: components['schemas']['AnalyticAccountItemIn']
+        analyticAccount: components['schemas']['AnalyticAccountItemIn'],
+        params: operations['accounting_create_analytic_account']['parameters']['query']
     ): RequestData<components['schemas']['AnalyticAccountItemOut']> {
         return {
+            params,
             method: 'post',
             url: '/consumers/{consumer_id}/accounting/analytic-accounts',
             body: analyticAccount,
         };
     },
-    getAnalyticAccounts(): RequestData<components['schemas']['AnalyticAccountItemOut'][]> {
+    getAnalyticAccounts(
+        params: operations['accounting_get_analytic_accounts']['parameters']['query']
+    ): RequestData<components['schemas']['AnalyticAccountItemOut'][]> {
         return {
+            params,
             method: 'get',
             url: '/consumers/{consumer_id}/accounting/analytic-accounts',
         };
     },
     createAnalyticAccountWithMultiplePlans(
         analytic_plan: string,
-        analyticAccount: components['schemas']['AnalyticAccountItemIn']
+        analyticAccount: components['schemas']['AnalyticAccountItemIn'],
+        params: operations['accounting_create_analytic_account_multi_plans']['parameters']['query']
     ): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans']> {
         return {
+            params,
             method: 'post',
             url: `/consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans/${analytic_plan}`,
             body: analyticAccount,
         };
     },
     getAnalyticAccount(
-        analytic_account_id: string
+        analytic_account_id: string,
+        params: operations['accounting_get_analytic_account']['parameters']['query']
     ): RequestData<components['schemas']['AnalyticAccountItemOut']> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/analytic-accounts/${analytic_account_id}`,
         };
     },
     updateAnalyticAccount(
         analytic_account_id: string,
-        analyticAccount: components['schemas']['AnalyticAccountItemUpdate']
+        analyticAccount: components['schemas']['AnalyticAccountItemUpdate'],
+        params: operations['accounting_update_analytic_account']['parameters']['query']
     ): RequestData<components['schemas']['AnalyticAccountItemOut']> {
         return {
+            params,
             method: 'patch',
             url: `/consumers/{consumer_id}/accounting/analytic-accounts/${analytic_account_id}`,
             body: analyticAccount,
@@ -216,9 +248,11 @@ const accountingFactory = {
     },
     getAnalyticAccountWithMultiplePlans(
         analytic_account_id: string,
-        analytic_plan: string
+        analytic_plan: string,
+        params: operations['accounting_get_analytic_account_multi_plans']['parameters']['query']
     ): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans']> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/analytic-accounts/${analytic_account_id}/multi-analytic-plans/${analytic_plan}`,
         };
@@ -226,18 +260,21 @@ const accountingFactory = {
     updateAnalyticAccountWithMultiplePlans(
         analytic_account_id: string,
         analytic_plan: string,
-        analyticAccount: components['schemas']['AnalyticAccountItemUpdate']
+        analyticAccount: components['schemas']['AnalyticAccountItemUpdate'],
+        params: operations['accounting_update_analytic_account_multi_plans']['parameters']['query']
     ): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans']> {
         return {
+            params,
             method: 'patch',
             url: `/consumers/{consumer_id}/accounting/analytic-accounts/${analytic_account_id}/multi-analytic-plans/${analytic_plan}`,
             body: analyticAccount,
         };
     },
-    getAnalyticAccountsWithMultiplePlans(): RequestData<
-        components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans'][]
-    > {
+    getAnalyticAccountsWithMultiplePlans(
+        params: operations['accounting_get_analytic_accounts_multi_plans']['parameters']['query']
+    ): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans'][]> {
         return {
+            params,
             method: 'get',
             url: '/consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans',
         };
@@ -260,20 +297,30 @@ const accountingFactory = {
             url: `/consumers/{consumer_id}/accounting/journal/entries/multi-analytic-plans`,
         };
     },
-    getPaymentsByInvoiceId(invoice_id: string): RequestData<components['schemas']['Payment'][]> {
+    getPaymentsByInvoiceId(
+        invoice_id: string,
+        params: operations['accounting_get_payments_by_invoice']['parameters']['query']
+    ): RequestData<components['schemas']['Payment'][]> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/invoices/id/${invoice_id}/payments`,
         };
     },
-    getJournals(): RequestData<components['schemas']['Journal'][]> {
+    getJournals(
+        params: operations['accounting_get_journals']['parameters']['query']
+    ): RequestData<components['schemas']['Journal'][]> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/journals`,
         };
     },
-    getVatCodes(): RequestData<components['schemas']['app__routers__accounting__VatCode'][]> {
+    getVatCodes(
+        params: operations['accounting_get_vat_codes']['parameters']['query']
+    ): RequestData<components['schemas']['app__routers__accounting__VatCode'][]> {
         return {
+            params,
             method: 'get',
             url: `/consumers/{consumer_id}/accounting/vat-codes`,
         };
@@ -320,6 +367,15 @@ const accountingFactory = {
             body: attachment,
         };
     },
+    getAttachments(
+        params: operations['accounting_get_attachments']['parameters']['query']
+    ): RequestData<components['schemas']['AttachmentItem'][]> {
+        return {
+            params,
+            method: 'get',
+            url: `/consumers/{consumer_id}/accounting/attachments`,
+        };
+    },
     getChartOfAccounts(
         params: getChartOfAccountsParams
     ): RequestData<components['schemas']['AccountItem'][]> {
@@ -403,6 +459,23 @@ const accountingFactory = {
             body: journal_entry,
         };
     },
+    matchEntries(
+        body: components['schemas']['MatchingIn'],
+        params: operations['accounting_match_entries']['parameters']['query']
+    ): RequestData<components['schemas']['MatchingOut']> {
+        return {
+            params,
+            body,
+            method: 'post',
+            url: '/consumers/{consumer_id}/accounting/matching',
+        };
+    },
+    getFolders(): RequestData<components['schemas']['FolderItem'][]> {
+        return {
+            method: 'get',
+            url: '/consumers/{consumer_id}/accounting/folders',
+        };
+    },
 };
 
 export { accountingFactory };

package/test/modules/accounting.test.ts

@@ -595,3 +595,34 @@ test('createFinancialEntryOld', async () => {
     expect(financialEntry).toBeTruthy();
     expect(financialEntry).toHaveProperty('journal_id', journal.id);
 });
+
+let folders: components['schemas']['FolderItem'][] = [];
+test('getFolders', async () => {
+    folders = await consumer.accounting.getFolders();
+    expect(folders).toBeInstanceOf(Array);
+    expect(folders.length).toBeGreaterThan(0);
+    expect(folders[0]).toHaveProperty('id', expect.any(String));
+    expect(folders[0]).toHaveProperty('name', expect.any(String));
+});
+
+test.skip('getAttachments', async () => {
+    const attachments = await consumer.accounting.getAttachments({
+        // TODO: Add documentId from test account
+        documentId: '',
+        type: 'invoice',
+    });
+    expect(attachments).toBeInstanceOf(Array);
+    expect(attachments.length).toBeGreaterThan(0);
+    expect(attachments[0]).toHaveProperty('id', expect.any(String));
+    expect(attachments[0]).toHaveProperty('base64_string', expect.any(String));
+});
+
+test.skip('matchEntries', async () => {
+    const match = await consumer.accounting.matchEntries({
+        // TODO: Change params with test account values
+        entries: [],
+        partner_id: '',
+    });
+    expect(match).toHaveProperty('matching_number', expect.any(String));
+    expect(match).toHaveProperty('balance', expect.any(Number));
+});