@chift/chift-nodejs 1.0.10 → 1.0.13

package/src/modules/pos.ts

@@ -1,37 +1,27 @@
 import { operations, components } from '../types/public-api/schema';
-import { RequestData } from '../types/api';
+import { AutoPaginatedParams, RequestData } from '../types/api';
 
-type getPaymentsParams = Omit<
-    operations['pos_get_payments']['parameters']['query'],
-    'page' | 'size'
->;
+type GetPaymentsParams = AutoPaginatedParams<operations['pos_get_payments']['parameters']['query']>;
 
-type getPaymentMethodsParams = Omit<
-    operations['pos_get_payments_methods']['parameters']['query'],
-    'page' | 'size'
+type GetPaymentMethodsParams = AutoPaginatedParams<
+    operations['pos_get_payments_methods']['parameters']['query']
 >;
 
-type getProductCategoriesParams = Omit<
-    operations['pos_get_product_categories']['parameters']['query'],
-    'page' | 'size'
+type GetProductCategoriesParams = AutoPaginatedParams<
+    operations['pos_get_product_categories']['parameters']['query']
 >;
 
-type getProductsParams = Omit<
-    operations['pos_get_products']['parameters']['query'],
-    'page' | 'size'
->;
+type GetProductsParams = AutoPaginatedParams<operations['pos_get_products']['parameters']['query']>;
 
-type getCustomersParams = Omit<
-    operations['pos_get_customers']['parameters']['query'],
-    'page' | 'size'
+type GetCustomersParams = AutoPaginatedParams<
+    operations['pos_get_customers']['parameters']['query']
 >;
 
-type getAccountingCategoriesParams = Omit<
-    operations['pos_get_accounting_categories']['parameters']['query'],
-    'page' | 'size'
+type GetAccountingCategoriesParams = AutoPaginatedParams<
+    operations['pos_get_accounting_categories']['parameters']['query']
 >;
 
-type getOrdersParams = Omit<operations['pos_get_orders']['parameters']['query'], 'page' | 'size'>;
+type GetOrdersParams = AutoPaginatedParams<operations['pos_get_orders']['parameters']['query']>;
 
 const posFactory = {
     getLocations(): RequestData<components['schemas']['POSLocationItem'][]> {
@@ -40,7 +30,7 @@ const posFactory = {
             url: '/consumers/{consumer_id}/pos/locations',
         };
     },
-    getOrders(params: getOrdersParams): RequestData<components['schemas']['OrderItem'][]> {
+    getOrders(params: GetOrdersParams): RequestData<components['schemas']['OrderItem'][]> {
         return {
             params,
             method: 'get',
@@ -48,7 +38,7 @@ const posFactory = {
         };
     },
     getCustomers(
-        params: getCustomersParams
+        params?: GetCustomersParams
     ): RequestData<components['schemas']['POSCustomerItem'][]> {
         return {
             params,
@@ -78,7 +68,7 @@ const posFactory = {
         };
     },
     getPaymentMethods(
-        params: getPaymentMethodsParams
+        params?: GetPaymentMethodsParams
     ): RequestData<components['schemas']['PaymentMethods'][]> {
         return {
             params,
@@ -87,7 +77,7 @@ const posFactory = {
         };
     },
     getProductCategories(
-        params: getProductCategoriesParams
+        params?: GetProductCategoriesParams
     ): RequestData<components['schemas']['CategoryItem'][]> {
         return {
             params,
@@ -95,7 +85,9 @@ const posFactory = {
             url: `/consumers/{consumer_id}/pos/product-categories`,
         };
     },
-    getProducts(params: getProductsParams): RequestData<components['schemas']['POSProductItem'][]> {
+    getProducts(
+        params?: GetProductsParams
+    ): RequestData<components['schemas']['POSProductItem'][]> {
         return {
             params,
             method: 'get',
@@ -113,7 +105,7 @@ const posFactory = {
     },
     getClosure(
         date: string,
-        params: operations['pos_get_closure']['parameters']['query']
+        params?: operations['pos_get_closure']['parameters']['query']
     ): RequestData<components['schemas']['ClosureItem']> {
         return {
             params,
@@ -121,7 +113,7 @@ const posFactory = {
             url: `/consumers/{consumer_id}/pos/closures/${date}`,
         };
     },
-    getPayments(params: getPaymentsParams): RequestData<components['schemas']['PaymentItem'][]> {
+    getPayments(params: GetPaymentsParams): RequestData<components['schemas']['PaymentItem'][]> {
         return {
             params,
             method: 'get',
@@ -139,7 +131,7 @@ const posFactory = {
         };
     },
     getAccountingCategories(
-        params: getAccountingCategoriesParams
+        params?: GetAccountingCategoriesParams
     ): RequestData<components['schemas']['AccountingCategoryItem'][]> {
         return {
             params,

package/src/types/api.ts

@@ -33,3 +33,5 @@ export type ApiFor<TFactory extends RequestFactory> = {
         ? (...args: TArgs) => Promise<TResponse>
         : never;
 };
+
+export type AutoPaginatedParams<T> = Omit<Exclude<T, undefined>, 'page' | 'size'>;

package/src/types/public-api/{schema.d.ts → schema.ts}

@@ -819,6 +819,8 @@ export interface components {
         AccountBalance: {
             /** Account Number */
             account_number: string;
+            /** Account Name */
+            account_name?: string;
             /** Debit */
             debit: number;
             /** Credit */
@@ -835,12 +837,12 @@ export interface components {
             accounts: string[];
             /**
              * Start
-             * @description Start month (included, e.g. 022023 for february 2023)
+             * @description Start month (included, e.g. 202302 for february 2023)
              */
-            start: string;
+            start?: string;
             /**
              * End
-             * @description End month (included, e.g. 122023 for december 2023)
+             * @description End month (included, e.g. 202312 for december 2023)
              */
             end: string;
         };
@@ -2544,6 +2546,16 @@ export interface components {
         ExecutionType: 'code' | 'module';
         /** FeesItem */
         FeesItem: {
+            /**
+             * Id
+             * @description Technical id in Chift
+             */
+            id: string;
+            /**
+             * Source Ref
+             * @description Technical id in the target software
+             */
+            source_ref: components['schemas']['Ref'];
             /**
              * Created On
              * Format: date-time
@@ -5341,6 +5353,16 @@ export interface components {
         };
         /** ShippingRefund */
         ShippingRefund: {
+            /**
+             * Id
+             * @description Technical id in Chift
+             */
+            id: string;
+            /**
+             * Source Ref
+             * @description Technical id in the target software
+             */
+            source_ref: components['schemas']['Ref'];
             /**
              * Untaxed Amount
              * @description Untaxed amount refunded (after discount).

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

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

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

@@ -1,69 +0,0 @@
-"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 } });
-}));