@chift/chift-nodejs 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/.eslintcache +1 -1
  2. package/CHANGELOG.md +10 -1
  3. package/dist/src/modules/api.d.ts +1174 -269
  4. package/dist/src/modules/consumer.d.ts +233 -53
  5. package/dist/src/modules/consumer.js +3 -0
  6. package/dist/src/modules/consumers.d.ts +1160 -260
  7. package/dist/src/modules/integrations.d.ts +6 -1
  8. package/dist/src/modules/pms.d.ts +15 -0
  9. package/dist/src/modules/pms.js +47 -0
  10. package/dist/src/modules/pos.d.ts +4 -4
  11. package/dist/src/modules/sync.d.ts +928 -208
  12. package/dist/src/types/public-api/schema.d.ts +1034 -298
  13. package/package.json +1 -1
  14. package/src/modules/consumer.ts +6 -1
  15. package/src/modules/pms.ts +67 -0
  16. package/src/modules/pos.ts +4 -4
  17. package/src/types/public-api/schema.d.ts +12073 -0
  18. package/src/types/public-api/schema.ts +1037 -294
  19. package/test/modules/pos.test.ts +1 -1
package/dist/src/modules/consumer.d.ts CHANGED
@@ -17,7 +17,7 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
17
17
  status: "up" | "down";
18
18
  } | undefined;
19
19
  }[]>;
20
- createConnection: (body?: components['schemas']['PostConnectionItem']) => Promise<{
20
+ createConnection: (body?: components['schemas']['app__routers__connections__PostConnectionItem']) => Promise<{
21
21
  url: string;
22
22
  }>;
23
23
  updateConnection: (connectionId: string, body?: components['schemas']['PatchConnectionItem']) => Promise<{
@@ -66,6 +66,27 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
66
66
  total_discount?: number | undefined;
67
67
  total_refund?: number | undefined;
68
68
  total_tip?: number | undefined;
69
+ currency?: string | undefined;
70
+ country?: string | undefined;
71
+ loyalty?: number | undefined;
72
+ customer_id?: string | undefined;
73
+ location_id?: string | undefined;
74
+ taxes?: {
75
+ tax_rate: number;
76
+ tax_amount: number;
77
+ total: number;
78
+ }[] | undefined;
79
+ guests?: number | undefined;
80
+ payments: {
81
+ id?: string | undefined;
82
+ payment_method_id?: string | undefined;
83
+ payment_method_name?: string | undefined;
84
+ total: number;
85
+ tip?: number | undefined;
86
+ status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
87
+ currency?: string | undefined;
88
+ date?: string | undefined;
89
+ }[];
69
90
  items: {
70
91
  id: string;
71
92
  quantity: number;
@@ -81,26 +102,6 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
81
102
  product_id?: string | undefined;
82
103
  accounting_category_id?: string | undefined;
83
104
  }[];
84
- payments: {
85
- id?: string | undefined;
86
- payment_method_id?: string | undefined;
87
- payment_method_name?: string | undefined;
88
- total: number;
89
- tip?: number | undefined;
90
- status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
91
- currency?: string | undefined;
92
- date?: string | undefined;
93
- }[];
94
- currency?: string | undefined;
95
- country?: string | undefined;
96
- loyalty?: number | undefined;
97
- customer_id?: string | undefined;
98
- location_id?: string | undefined;
99
- taxes?: {
100
- tax_rate: number;
101
- tax_amount: number;
102
- total: number;
103
- }[] | undefined;
104
105
  }[]>;
105
106
  getCustomers(params?: {
106
107
  search?: string | undefined;
@@ -139,6 +140,27 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
139
140
  total_discount?: number | undefined;
140
141
  total_refund?: number | undefined;
141
142
  total_tip?: number | undefined;
143
+ currency?: string | undefined;
144
+ country?: string | undefined;
145
+ loyalty?: number | undefined;
146
+ customer_id?: string | undefined;
147
+ location_id?: string | undefined;
148
+ taxes?: {
149
+ tax_rate: number;
150
+ tax_amount: number;
151
+ total: number;
152
+ }[] | undefined;
153
+ guests?: number | undefined;
154
+ payments: {
155
+ id?: string | undefined;
156
+ payment_method_id?: string | undefined;
157
+ payment_method_name?: string | undefined;
158
+ total: number;
159
+ tip?: number | undefined;
160
+ status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
161
+ currency?: string | undefined;
162
+ date?: string | undefined;
163
+ }[];
142
164
  items: {
143
165
  id: string;
144
166
  quantity: number;
@@ -154,26 +176,6 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
154
176
  product_id?: string | undefined;
155
177
  accounting_category_id?: string | undefined;
156
178
  }[];
157
- payments: {
158
- id?: string | undefined;
159
- payment_method_id?: string | undefined;
160
- payment_method_name?: string | undefined;
161
- total: number;
162
- tip?: number | undefined;
163
- status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
164
- currency?: string | undefined;
165
- date?: string | undefined;
166
- }[];
167
- currency?: string | undefined;
168
- country?: string | undefined;
169
- loyalty?: number | undefined;
170
- customer_id?: string | undefined;
171
- location_id?: string | undefined;
172
- taxes?: {
173
- tax_rate: number;
174
- tax_amount: number;
175
- total: number;
176
- }[] | undefined;
177
179
  }>;
178
180
  getCustomer(customerId: string): import("../types/api").RequestData<{
179
181
  id: string;
@@ -309,6 +311,27 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
309
311
  total_discount?: number | undefined;
310
312
  total_refund?: number | undefined;
311
313
  total_tip?: number | undefined;
314
+ currency?: string | undefined;
315
+ country?: string | undefined;
316
+ loyalty?: number | undefined;
317
+ customer_id?: string | undefined;
318
+ location_id?: string | undefined;
319
+ taxes?: {
320
+ tax_rate: number;
321
+ tax_amount: number;
322
+ total: number;
323
+ }[] | undefined;
324
+ guests?: number | undefined;
325
+ payments: {
326
+ id?: string | undefined;
327
+ payment_method_id?: string | undefined;
328
+ payment_method_name?: string | undefined;
329
+ total: number;
330
+ tip?: number | undefined;
331
+ status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
332
+ currency?: string | undefined;
333
+ date?: string | undefined;
334
+ }[];
312
335
  items: {
313
336
  id: string;
314
337
  quantity: number;
@@ -324,16 +347,53 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
324
347
  product_id?: string | undefined;
325
348
  accounting_category_id?: string | undefined;
326
349
  }[];
327
- payments: {
350
+ }>;
351
+ getAccountingCategories(params?: {} | undefined): import("../types/api").RequestData<{
352
+ id: string;
353
+ name: string;
354
+ id_parent?: string | undefined;
355
+ code?: string | undefined;
356
+ ledger_account_code?: string | undefined;
357
+ posting_account_code?: string | undefined;
358
+ }[]>;
359
+ }>;
360
+ pms: import("../types/api").ApiFor<{
361
+ getLocations(): import("../types/api").RequestData<{
362
+ id: string;
363
+ name: string;
364
+ timezone?: string | undefined;
365
+ address?: {
366
+ address_type?: string | undefined;
367
+ name?: string | undefined;
368
+ street?: string | undefined;
369
+ number?: string | undefined;
370
+ box?: string | undefined;
371
+ city?: string | undefined;
372
+ postal_code?: string | undefined;
373
+ country?: string | undefined;
374
+ } | undefined;
375
+ }[]>;
376
+ getOrders(params: {
377
+ date_from: string;
378
+ date_to: string;
379
+ location_id?: string | undefined;
380
+ state?: "closed" | "consumed" | undefined;
381
+ }): import("../types/api").RequestData<{
382
+ id: string;
383
+ source_ref: {
328
384
  id?: string | undefined;
329
- payment_method_id?: string | undefined;
330
- payment_method_name?: string | undefined;
331
- total: number;
332
- tip?: number | undefined;
333
- status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
334
- currency?: string | undefined;
335
- date?: string | undefined;
336
- }[];
385
+ model?: string | undefined;
386
+ };
387
+ order_number?: string | undefined;
388
+ creation_date: string;
389
+ closing_date?: string | undefined;
390
+ service_date?: string | undefined;
391
+ device_id?: string | undefined;
392
+ total: number;
393
+ tax_amount: number;
394
+ total_discount?: number | undefined;
395
+ total_refund?: number | undefined;
396
+ total_tip?: number | undefined;
337
397
  currency?: string | undefined;
338
398
  country?: string | undefined;
339
399
  loyalty?: number | undefined;
@@ -344,9 +404,69 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
344
404
  tax_amount: number;
345
405
  total: number;
346
406
  }[] | undefined;
407
+ guests?: number | undefined;
408
+ items: {
409
+ id: string;
410
+ source_ref: {
411
+ id?: string | undefined;
412
+ model?: string | undefined;
413
+ };
414
+ quantity: number;
415
+ unit_price: number;
416
+ total: number;
417
+ tax_amount: number;
418
+ tax_rate?: number | undefined;
419
+ description?: string | undefined;
420
+ discounts?: {
421
+ name?: string | undefined;
422
+ total: number;
423
+ }[] | undefined;
424
+ product_id?: string | undefined;
425
+ accounting_category_id?: string | undefined;
426
+ }[];
427
+ service_id?: string | undefined;
428
+ }[]>;
429
+ getPaymentMethods(params?: {
430
+ location_id?: string | undefined;
431
+ } | undefined): import("../types/api").RequestData<{
432
+ id: string;
433
+ source_ref: {
434
+ id?: string | undefined;
435
+ model?: string | undefined;
436
+ };
437
+ name: string;
438
+ extra?: string | undefined;
439
+ ledger_account_code?: string | undefined;
440
+ }[]>;
441
+ getClosure(date: string, params?: {
442
+ location_id?: string | undefined;
443
+ } | undefined): import("../types/api").RequestData<{
444
+ date: string;
445
+ status: "open" | "closed";
347
446
  }>;
447
+ getPayments(params: {
448
+ date_from: string;
449
+ date_to: string;
450
+ }): import("../types/api").RequestData<{
451
+ id?: string | undefined;
452
+ source_ref: {
453
+ id?: string | undefined;
454
+ model?: string | undefined;
455
+ };
456
+ payment_method_id?: string | undefined;
457
+ payment_method_name?: string | undefined;
458
+ total: number;
459
+ tip?: number | undefined;
460
+ status?: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised" | undefined;
461
+ currency?: string | undefined;
462
+ date?: string | undefined;
463
+ }[]>;
348
464
  getAccountingCategories(params?: {} | undefined): import("../types/api").RequestData<{
349
465
  id: string;
466
+ source_ref: {
467
+ id?: string | undefined;
468
+ model?: string | undefined;
469
+ };
350
470
  name: string;
351
471
  id_parent?: string | undefined;
352
472
  code?: string | undefined;
@@ -831,6 +951,7 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
831
951
  iban: string;
832
952
  };
833
953
  } | undefined;
954
+ shipping_country?: string | undefined;
834
955
  lines: {
835
956
  line_number?: number | undefined;
836
957
  description: string;
@@ -927,6 +1048,7 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
927
1048
  iban: string;
928
1049
  };
929
1050
  } | undefined;
1051
+ shipping_country?: string | undefined;
930
1052
  lines: {
931
1053
  line_number?: number | undefined;
932
1054
  description: string;
@@ -1788,6 +1910,8 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
1788
1910
  id: string;
1789
1911
  name: string;
1790
1912
  selected?: boolean | undefined;
1913
+ vat?: string | undefined;
1914
+ company_number?: string | undefined;
1791
1915
  }[]>;
1792
1916
  }>;
1793
1917
  invoicing: import("../types/api").ApiFor<{
@@ -2517,6 +2641,8 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2517
2641
  date_to?: string | undefined;
2518
2642
  updated_after?: string | undefined;
2519
2643
  include_detailed_refunds?: "true" | "false" | undefined;
2644
+ include_product_categories?: "true" | "false" | undefined;
2645
+ include_customer_details?: "true" | "false" | undefined;
2520
2646
  } | undefined): import("../types/api").RequestData<{
2521
2647
  id: string;
2522
2648
  source_ref: {
@@ -2563,8 +2689,9 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2563
2689
  created_on?: string | undefined;
2564
2690
  last_updated_on?: string | undefined;
2565
2691
  confirmed_on?: string | undefined;
2692
+ delivery_date?: string | undefined;
2566
2693
  cancelled_on?: string | undefined;
2567
- status: "cancelled" | "draft" | "confirmed" | "shipped" | "refunded";
2694
+ status: "cancelled" | "draft" | "cancelled_unpaid" | "confirmed" | "shipped" | "refunded";
2568
2695
  discount_amount: number;
2569
2696
  untaxed_amount_without_fees: number;
2570
2697
  tax_amount_without_fees: number;
@@ -2588,6 +2715,10 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2588
2715
  id: string;
2589
2716
  sku?: string | undefined;
2590
2717
  name: string;
2718
+ categories?: {
2719
+ id: string;
2720
+ name: string;
2721
+ }[] | undefined;
2591
2722
  } | undefined;
2592
2723
  quantity: number;
2593
2724
  untaxed_amount: number;
@@ -2605,6 +2736,14 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2605
2736
  tax_amount: number;
2606
2737
  total: number;
2607
2738
  }[] | undefined;
2739
+ transactions?: {
2740
+ id: string;
2741
+ created_on?: string | undefined;
2742
+ payment_method_id?: string | undefined;
2743
+ payment_method_name?: string | undefined;
2744
+ amount: number;
2745
+ status: "failed" | "pending" | "success";
2746
+ }[] | undefined;
2608
2747
  }[] | undefined;
2609
2748
  currency: string;
2610
2749
  note?: string | undefined;
@@ -2619,6 +2758,10 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2619
2758
  id: string;
2620
2759
  sku?: string | undefined;
2621
2760
  name: string;
2761
+ categories?: {
2762
+ id: string;
2763
+ name: string;
2764
+ }[] | undefined;
2622
2765
  } | undefined;
2623
2766
  quantity: number;
2624
2767
  unit_price: number;
@@ -2657,6 +2800,7 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2657
2800
  payment_method_id?: string | undefined;
2658
2801
  transactions?: {
2659
2802
  id: string;
2803
+ created_on?: string | undefined;
2660
2804
  payment_method_id?: string | undefined;
2661
2805
  payment_method_name?: string | undefined;
2662
2806
  amount: number;
@@ -2754,8 +2898,9 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2754
2898
  created_on?: string | undefined;
2755
2899
  last_updated_on?: string | undefined;
2756
2900
  confirmed_on?: string | undefined;
2901
+ delivery_date?: string | undefined;
2757
2902
  cancelled_on?: string | undefined;
2758
- status: "cancelled" | "draft" | "confirmed" | "shipped" | "refunded";
2903
+ status: "cancelled" | "draft" | "cancelled_unpaid" | "confirmed" | "shipped" | "refunded";
2759
2904
  discount_amount: number;
2760
2905
  untaxed_amount_without_fees: number;
2761
2906
  tax_amount_without_fees: number;
@@ -2779,6 +2924,10 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2779
2924
  id: string;
2780
2925
  sku?: string | undefined;
2781
2926
  name: string;
2927
+ categories?: {
2928
+ id: string;
2929
+ name: string;
2930
+ }[] | undefined;
2782
2931
  } | undefined;
2783
2932
  quantity: number;
2784
2933
  untaxed_amount: number;
@@ -2796,6 +2945,14 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2796
2945
  tax_amount: number;
2797
2946
  total: number;
2798
2947
  }[] | undefined;
2948
+ transactions?: {
2949
+ id: string;
2950
+ created_on?: string | undefined;
2951
+ payment_method_id?: string | undefined;
2952
+ payment_method_name?: string | undefined;
2953
+ amount: number;
2954
+ status: "failed" | "pending" | "success";
2955
+ }[] | undefined;
2799
2956
  }[] | undefined;
2800
2957
  currency: string;
2801
2958
  note?: string | undefined;
@@ -2810,6 +2967,10 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2810
2967
  id: string;
2811
2968
  sku?: string | undefined;
2812
2969
  name: string;
2970
+ categories?: {
2971
+ id: string;
2972
+ name: string;
2973
+ }[] | undefined;
2813
2974
  } | undefined;
2814
2975
  quantity: number;
2815
2976
  unit_price: number;
@@ -2848,6 +3009,7 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2848
3009
  payment_method_id?: string | undefined;
2849
3010
  transactions?: {
2850
3011
  id: string;
3012
+ created_on?: string | undefined;
2851
3013
  payment_method_id?: string | undefined;
2852
3014
  payment_method_name?: string | undefined;
2853
3015
  amount: number;
@@ -2904,8 +3066,9 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2904
3066
  created_on?: string | undefined;
2905
3067
  last_updated_on?: string | undefined;
2906
3068
  confirmed_on?: string | undefined;
3069
+ delivery_date?: string | undefined;
2907
3070
  cancelled_on?: string | undefined;
2908
- status: "cancelled" | "draft" | "confirmed" | "shipped" | "refunded";
3071
+ status: "cancelled" | "draft" | "cancelled_unpaid" | "confirmed" | "shipped" | "refunded";
2909
3072
  discount_amount: number;
2910
3073
  untaxed_amount_without_fees: number;
2911
3074
  tax_amount_without_fees: number;
@@ -2929,6 +3092,10 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2929
3092
  id: string;
2930
3093
  sku?: string | undefined;
2931
3094
  name: string;
3095
+ categories?: {
3096
+ id: string;
3097
+ name: string;
3098
+ }[] | undefined;
2932
3099
  } | undefined;
2933
3100
  quantity: number;
2934
3101
  untaxed_amount: number;
@@ -2946,6 +3113,14 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2946
3113
  tax_amount: number;
2947
3114
  total: number;
2948
3115
  }[] | undefined;
3116
+ transactions?: {
3117
+ id: string;
3118
+ created_on?: string | undefined;
3119
+ payment_method_id?: string | undefined;
3120
+ payment_method_name?: string | undefined;
3121
+ amount: number;
3122
+ status: "failed" | "pending" | "success";
3123
+ }[] | undefined;
2949
3124
  }[] | undefined;
2950
3125
  currency: string;
2951
3126
  note?: string | undefined;
@@ -2960,6 +3135,10 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2960
3135
  id: string;
2961
3136
  sku?: string | undefined;
2962
3137
  name: string;
3138
+ categories?: {
3139
+ id: string;
3140
+ name: string;
3141
+ }[] | undefined;
2963
3142
  } | undefined;
2964
3143
  quantity: number;
2965
3144
  unit_price: number;
@@ -2998,6 +3177,7 @@ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperati
2998
3177
  payment_method_id?: string | undefined;
2999
3178
  transactions?: {
3000
3179
  id: string;
3180
+ created_on?: string | undefined;
3001
3181
  payment_method_id?: string | undefined;
3002
3182
  payment_method_name?: string | undefined;
3003
3183
  amount: number;
package/dist/src/modules/consumer.js CHANGED
@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.Consumer = void 0;
13
13
  const pos_1 = require("./pos");
14
+ const pms_1 = require("./pms");
14
15
  const openapi_1 = require("../helpers/openapi");
15
16
  const accounting_1 = require("./accounting");
16
17
  const invoicing_1 = require("./invoicing");
@@ -24,6 +25,7 @@ const Consumer = (internalApi, body) => {
24
25
  const redirect_url = data.redirect_url;
25
26
  const email = data.email;
26
27
  const pos = (0, openapi_1.createApiFor)(pos_1.posFactory, _internalApi, data.name, consumerId);
28
+ const pms = (0, openapi_1.createApiFor)(pms_1.pmsFactory, _internalApi, data.name, consumerId);
27
29
  const accounting = (0, openapi_1.createApiFor)(accounting_1.accountingFactory, _internalApi, data.name, consumerId);
28
30
  const invoicing = (0, openapi_1.createApiFor)(invoicing_1.invoicingFactory, _internalApi, data.name, consumerId);
29
31
  const ecommerce = (0, openapi_1.createApiFor)(ecommerce_1.ecommerceFactory, _internalApi, data.name, consumerId);
@@ -117,6 +119,7 @@ const Consumer = (internalApi, body) => {
117
119
  redirect_url,
118
120
  email,
119
121
  pos,
122
+ pms,
120
123
  accounting,
121
124
  invoicing,
122
125
  ecommerce,