@chift/chift-nodejs 1.0.0 → 1.0.2

package/dist/src/modules/sync.js

@@ -22,7 +22,9 @@ const Sync = (internalApi, body) => {
     };
     const getFlowByName = (name) => {
         const flow = data.flows.find((flow) => flow.name.toLowerCase() === name.toLowerCase());
+        console.log('undefined ?');
         if (flow) {
+            console.log('on a le flux');
             return (0, flow_1.Flow)(_internalApi, flow, data.syncid, data.consumers);
         }
         return undefined;

package/dist/test/modules/flow.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/modules/flow.test.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const chift = __importStar(require("../../src/index"));
+const dotenv = __importStar(require("dotenv"));
+dotenv.config();
+const client = new chift.API({
+    baseUrl: process.env.CHIFT_BASE_URL,
+    clientId: process.env.CHIFT_CLIENT_ID,
+    clientSecret: process.env.CHIFT_CLIENT_SECRET,
+    accountId: process.env.CHIFT_ACCOUNT_ID,
+});
+let flow;
+(0, globals_1.beforeAll)(() => __awaiter(void 0, void 0, void 0, function* () {
+    const syncId = process.env.CHIFT_TEST_SYNC_ID;
+    const sync = yield client.Syncs.getSyncById(syncId);
+    flow = yield sync.createFlow({
+        name: 'Je suis un flux de test',
+        description: 'Flux de test',
+        execution: {
+            type: 'code',
+        },
+        trigger: {
+            type: 'event',
+        },
+        config: {},
+    }, (consumer, flowContext) => __awaiter(void 0, void 0, void 0, function* () {
+        console.log(`Mon flow_id : ${flowContext.flow_id}`);
+        console.log(`Bonjour, ceci est un test, on exécute le flux pour consumer: ${consumer}`);
+    }));
+}));
+(0, globals_1.test)('executeLocal', () => __awaiter(void 0, void 0, void 0, function* () {
+    flow.execute({ context: { logs: true, local: true } });
+}));
+(0, globals_1.test)('execute', () => __awaiter(void 0, void 0, void 0, function* () {
+    flow.execute({ context: { logs: true, local: false } });
+}));

package/dist/test/modules/pos.test.js

@@ -61,8 +61,8 @@ let lightspeedConsumer;
 let orders;
 (0, globals_1.test)('getOrders', () => __awaiter(void 0, void 0, void 0, function* () {
     orders = yield lightspeedConsumer.pos.getOrders({
-        date_from: '2023-01-11',
-        date_to: '2023-02-28',
+        date_from: '2022-08-11',
+        date_to: '2022-08-12',
     });
     (0, globals_1.expect)(orders).toBeInstanceOf(Array);
     (0, globals_1.expect)(orders.length).toBeGreaterThan(0);
@@ -142,8 +142,8 @@ globals_1.test.skip('getCustomer', () => __awaiter(void 0, void 0, void 0, funct
 }));
 (0, globals_1.test)('getPayments', () => __awaiter(void 0, void 0, void 0, function* () {
     const payments = yield lightspeedConsumer.pos.getPayments({
-        date_from: '2023-01-11',
-        date_to: '2023-02-28',
+        date_from: '2022-08-11',
+        date_to: '2022-08-12',
     });
     (0, globals_1.expect)(payments).toBeInstanceOf(Array);
     (0, globals_1.expect)(payments.length).toBeGreaterThan(0);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chift/chift-nodejs",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "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

@@ -31,6 +31,11 @@ type getInvoicesByTypeParams = Omit<
     'page' | 'size'
 >;
 
+type getOutstandingsParams = Omit<
+    operations['accounting_get_outstandings']['parameters']['query'],
+    'page' | 'size'
+>;
+
 const accountingFactory = {
     getAnalyticPlans(): RequestData<components['schemas']['AnalyticPlanItem'][]> {
         return {
@@ -343,15 +348,35 @@ const accountingFactory = {
             url: '/consumers/{consumer_id}/accounting/employees',
         };
     },
+    getOutstandings(
+        params: getOutstandingsParams
+    ): RequestData<components['schemas']['OutstandingItem'][]> {
+        return {
+            params,
+            method: 'get',
+            url: '/consumers/{consumer_id}/accounting/outstandings',
+        };
+    },
     createFinancialEntry(
-        financial_entry: components['schemas']['FinancialEntryItemIn']
+        financial_entry: components['schemas']['FinancialEntryItemIn'],
+        params: operations['accounting_create_financial_entry']['parameters']['query']
     ): RequestData<components['schemas']['FinancialEntryItemOut']> {
         return {
+            params,
             method: 'post',
             url: '/consumers/{consumer_id}/accounting/financial-entry',
             body: financial_entry,
         };
     },
+    createJournalEntry(
+        journal_entry: components['schemas']['JournalEntryIn']
+    ): RequestData<components['schemas']['JournalEntryMultiAnalyticPlan']> {
+        return {
+            method: 'post',
+            url: '/consumers/{consumer_id}/accounting/journal/entries',
+            body: journal_entry,
+        };
+    },
 };
 
 export { accountingFactory };

package/src/types/public-api/schema.d.ts

@@ -64,6 +64,10 @@ export interface paths {
          */
         get: operations['integrations_get_integrations'];
     };
+    '/integrations/{integrationid}/{image_type}.json': {
+        /** Returns a logo/icon of an integration (as base64) */
+        get: operations['integrations_get_integration_logo_json'];
+    };
     '/webhooks/list': {
         /**
          * Get list of possible webhooks
@@ -128,6 +132,13 @@ export interface paths {
          */
         post: operations['syncs_send_custom_event'];
     };
+    '/consumers/{consumerid}/syncs/{syncid}/flows/{flowid}/executions': {
+        /**
+         * Get executions information for one consumer/flow/sync
+         * @description Returns executions information for one consumer/flow/sync
+         */
+        get: operations['syncs_get_consumer_executions'];
+    };
     '/syncs/{syncid}/flows/{flowid}/executions/{executionid}': {
         /**
          * Get execution start/end timestamp
@@ -431,6 +442,13 @@ export interface paths {
          */
         post: operations['accounting_create_financial_entry'];
     };
+    '/consumers/{consumer_id}/accounting/outstandings': {
+        /**
+         * Get clients/suppliers outstandings
+         * @description Returns a list of all clients/suppliers outstanding's informations
+         */
+        get: operations['accounting_get_outstandings'];
+    };
     '/consumers/{consumer_id}/pos/orders': {
         /**
          * Get orders
@@ -1284,6 +1302,8 @@ export interface components {
             addresses?: components['schemas']['models__common__AddressItemOut'][];
             /** Account Number */
             account_number?: string;
+            /** Company Number */
+            company_number?: string;
             /** Id */
             id?: string;
         };
@@ -1930,7 +1950,7 @@ export interface components {
             account_number: string;
             /**
              * Partner Id
-             * @description Must be filled in it is a 'customer_account' or 'supplier_account' line type.
+             * @description Must be filled in it is a 'customer_account', 'supplier_account' or 'employee_account' line type.
              */
             partner_id?: string;
             /**
@@ -1948,7 +1968,7 @@ export interface components {
             account_number: string;
             /**
              * Partner Id
-             * @description Must be filled in it is a 'customer_account' or 'supplier_account' line type.
+             * @description Must be filled in it is a 'customer_account', 'supplier_account' or 'employee_account' line type.
              */
             partner_id?: string;
             /**
@@ -2062,6 +2082,12 @@ export interface components {
             /** Url */
             url: string;
         };
+        /**
+         * ImageType
+         * @description An enumeration.
+         * @enum {unknown}
+         */
+        ImageType: 'icon' | 'logo';
         /** IntegrationItem */
         IntegrationItem: {
             /** Integrationid */
@@ -2070,6 +2096,10 @@ export interface components {
             name: string;
             status: components['schemas']['app__routers__integrations__Status'];
             api: components['schemas']['Api'];
+            /** Logo Url */
+            logo_url: string;
+            /** Icon Url */
+            icon_url: string;
             /**
              * Credentials
              * @description List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.
@@ -3087,7 +3117,8 @@ export interface components {
             | 'supplier_invoice'
             | 'supplier_refund'
             | 'financial_operation'
-            | 'miscellaneous_operation';
+            | 'miscellaneous_operation'
+            | 'unknown';
         /** LinkItem */
         LinkItem: {
             /** Url */
@@ -3098,6 +3129,13 @@ export interface components {
             /** Url */
             url: string;
         };
+        /** LogoImage */
+        LogoImage: {
+            /** Integrationid */
+            integrationid: string;
+            /** Data */
+            data: string;
+        };
         /** MappingItem */
         MappingItem: {
             /** Source Id */
@@ -3629,6 +3667,48 @@ export interface components {
          * @enum {string}
          */
         OrderStatus: 'cancelled' | 'draft' | 'confirmed';
+        /** OutstandingItem */
+        OutstandingItem: {
+            /** Id */
+            id: string;
+            /** Number */
+            number?: string;
+            /** Journal Id */
+            journal_id: string;
+            journal_type: components['schemas']['JournalType'];
+            /**
+             * Date
+             * Format: date
+             */
+            date: string;
+            /**
+             * Due Date
+             * Format: date
+             */
+            due_date?: string;
+            /** Currency */
+            currency: string;
+            /** Currency Exchange Rate */
+            currency_exchange_rate: number;
+            /** Amount */
+            amount: number;
+            /** Open Amount */
+            open_amount: number;
+            /** Partner Id */
+            partner_id: string;
+            /** Account Number */
+            account_number: string;
+            /** Reference */
+            reference?: string;
+            /** Posted */
+            posted: boolean;
+        };
+        /**
+         * OutstandingType
+         * @description An enumeration.
+         * @enum {string}
+         */
+        OutstandingType: 'client' | 'supplier';
         /** POSCreateCustomerItem */
         POSCreateCustomerItem: {
             /** First Name */
@@ -3942,6 +4022,17 @@ export interface components {
             /** Size */
             size: number;
         };
+        /** Page[OutstandingItem] */
+        Page_OutstandingItem_: {
+            /** Items */
+            items: components['schemas']['OutstandingItem'][];
+            /** Total */
+            total: number;
+            /** Page */
+            page: number;
+            /** Size */
+            size: number;
+        };
         /** Page[POSCustomerItem] */
         Page_POSCustomerItem_: {
             /** Items */
@@ -4564,6 +4655,8 @@ export interface components {
             addresses?: components['schemas']['models__common__AddressItemOut'][];
             /** Account Number */
             account_number?: string;
+            /** Company Number */
+            company_number?: string;
             /** Id */
             id?: string;
         };
@@ -4735,7 +4828,15 @@ export interface components {
          * @description An enumeration.
          * @enum {string}
          */
-        TransactionAccountingCategory: 'all' | 'unknown' | 'test';
+        TransactionAccountingCategory:
+            | 'all'
+            | 'unknown'
+            | 'payout'
+            | 'payout_cancel'
+            | 'payment'
+            | 'payment_cancel'
+            | 'fee'
+            | 'fee_cancel';
         /**
          * TransactionFilterDateType
          * @description An enumeration.
@@ -5737,6 +5838,35 @@ export interface operations {
             };
         };
     };
+    /** Returns a logo/icon of an integration (as base64) */
+    integrations_get_integration_logo_json: {
+        parameters: {
+            path: {
+                integrationid: number;
+                image_type: components['schemas']['ImageType'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                content: {
+                    'application/json': components['schemas']['LogoImage'];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                content: {
+                    'application/json': components['schemas']['ChiftError'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     /**
      * Get list of possible webhooks
      * @description Returns a list of webhook that are available for your account
@@ -6022,12 +6152,52 @@ export interface operations {
             };
         };
     };
+    /**
+     * Get executions information for one consumer/flow/sync
+     * @description Returns executions information for one consumer/flow/sync
+     */
+    syncs_get_consumer_executions: {
+        parameters: {
+            query?: {
+                date_to?: string;
+                date_from?: string;
+            };
+            path: {
+                consumerid: string;
+                syncid: string;
+                flowid: string;
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                content: {
+                    'application/json': components['schemas']['ChainExecutionItem'][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                content: {
+                    'application/json': components['schemas']['ChiftError'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     /**
      * Get execution start/end timestamp
      * @description Get execution start/end timestamp
      */
     syncs_get_execution: {
         parameters: {
+            query?: {
+                consumerid?: string;
+            };
             path: {
                 syncid: string;
                 flowid: string;
@@ -6161,6 +6331,8 @@ export interface operations {
     datastores_get_consumer_and_datastoredata: {
         parameters: {
             query?: {
+                date_to?: string;
+                date_from?: string;
                 executionid?: string;
             };
             path: {
@@ -7822,6 +7994,10 @@ export interface operations {
      */
     accounting_create_financial_entry: {
         parameters: {
+            query?: {
+                /** @description Counterpart account number of the bank/cash journal. This will be retrieved from the accounting settings if left empty. */
+                financial_counterpart_account?: string;
+            };
             path: {
                 consumer_id: string;
             };
@@ -7858,6 +8034,43 @@ export interface operations {
             };
         };
     };
+    /**
+     * Get clients/suppliers outstandings
+     * @description Returns a list of all clients/suppliers outstanding's informations
+     */
+    accounting_get_outstandings: {
+        parameters: {
+            query: {
+                type: components['schemas']['OutstandingType'];
+                unposted_allowed: components['schemas']['BoolParam'];
+                page?: number;
+                size?: number;
+            };
+            path: {
+                consumer_id: string;
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                content: {
+                    'application/json': components['schemas']['Page_OutstandingItem_'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                content: {
+                    'application/json': components['schemas']['ChiftError'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     /**
      * Get orders
      * @description Returns a list of the orders
@@ -8669,7 +8882,7 @@ export interface operations {
                 date_from?: string;
                 /** @description Filter orders created at or before this date (e.g. 2023-01-31) */
                 date_to?: string;
-                /** @description Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC) */
+                /** @description Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors. */
                 updated_after?: string;
                 /** @description Include detailed information concerning refunds */
                 include_detailed_refunds?: components['schemas']['BoolParam'];