@horpynka/api-sdk 1.0.0

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.
@@ -0,0 +1,645 @@
1
+ import * as axios from 'axios';
2
+ import { AxiosInstance, RawAxiosRequestConfig, CreateAxiosDefaults } from 'axios';
3
+ import { QueryClient } from '@tanstack/react-query';
4
+
5
+ /**
6
+ * Horpynka API
7
+ * Backend API for Horpynka POS
8
+ *
9
+ * The version of the OpenAPI document: 1.0
10
+ *
11
+ *
12
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
13
+ * https://openapi-generator.tech
14
+ * Do not edit the class manually.
15
+ */
16
+ interface ConfigurationParameters {
17
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
18
+ username?: string;
19
+ password?: string;
20
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
21
+ basePath?: string;
22
+ serverIndex?: number;
23
+ baseOptions?: any;
24
+ formDataCtor?: new () => any;
25
+ }
26
+ declare class Configuration {
27
+ /**
28
+ * parameter for apiKey security
29
+ * @param name security name
30
+ * @memberof Configuration
31
+ */
32
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
33
+ /**
34
+ * parameter for basic security
35
+ *
36
+ * @type {string}
37
+ * @memberof Configuration
38
+ */
39
+ username?: string;
40
+ /**
41
+ * parameter for basic security
42
+ *
43
+ * @type {string}
44
+ * @memberof Configuration
45
+ */
46
+ password?: string;
47
+ /**
48
+ * parameter for oauth2 security
49
+ * @param name security name
50
+ * @param scopes oauth2 scope
51
+ * @memberof Configuration
52
+ */
53
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * override base path
56
+ *
57
+ * @type {string}
58
+ * @memberof Configuration
59
+ */
60
+ basePath?: string;
61
+ /**
62
+ * override server index
63
+ *
64
+ * @type {number}
65
+ * @memberof Configuration
66
+ */
67
+ serverIndex?: number;
68
+ /**
69
+ * base options for axios calls
70
+ *
71
+ * @type {any}
72
+ * @memberof Configuration
73
+ */
74
+ baseOptions?: any;
75
+ /**
76
+ * The FormData constructor that will be used to create multipart form data
77
+ * requests. You can inject this here so that execution environments that
78
+ * do not support the FormData class can still run the generated client.
79
+ *
80
+ * @type {new () => FormData}
81
+ */
82
+ formDataCtor?: new () => any;
83
+ constructor(param?: ConfigurationParameters);
84
+ /**
85
+ * Check if the given MIME is a JSON MIME.
86
+ * JSON MIME examples:
87
+ * application/json
88
+ * application/json; charset=UTF8
89
+ * APPLICATION/JSON
90
+ * application/vnd.company+json
91
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
92
+ * @return True if the given MIME is JSON, false otherwise.
93
+ */
94
+ isJsonMime(mime: string): boolean;
95
+ }
96
+
97
+ /**
98
+ * Horpynka API
99
+ * Backend API for Horpynka POS
100
+ *
101
+ * The version of the OpenAPI document: 1.0
102
+ *
103
+ *
104
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
105
+ * https://openapi-generator.tech
106
+ * Do not edit the class manually.
107
+ */
108
+
109
+ /**
110
+ *
111
+ * @export
112
+ * @class BaseAPI
113
+ */
114
+ declare class BaseAPI {
115
+ protected basePath: string;
116
+ protected axios: AxiosInstance;
117
+ protected configuration: Configuration | undefined;
118
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
119
+ }
120
+
121
+ /**
122
+ *
123
+ * @export
124
+ * @interface Category
125
+ */
126
+ interface Category {
127
+ /**
128
+ *
129
+ * @type {number}
130
+ * @memberof Category
131
+ */
132
+ 'id': number;
133
+ /**
134
+ *
135
+ * @type {string}
136
+ * @memberof Category
137
+ */
138
+ 'name': string;
139
+ /**
140
+ *
141
+ * @type {Array<Dish>}
142
+ * @memberof Category
143
+ */
144
+ 'dishes': Array<Dish>;
145
+ /**
146
+ *
147
+ * @type {Array<Product>}
148
+ * @memberof Category
149
+ */
150
+ 'products': Array<Product>;
151
+ }
152
+ /**
153
+ *
154
+ * @export
155
+ * @interface CreateOrderDto
156
+ */
157
+ interface CreateOrderDto {
158
+ /**
159
+ * @default CREATED
160
+ * @type {string}
161
+ * @memberof CreateOrderDto
162
+ */
163
+ 'status'?: CreateOrderDtoStatusEnum;
164
+ /**
165
+ *
166
+ * @type {number}
167
+ * @memberof CreateOrderDto
168
+ */
169
+ 'orderPrice': number;
170
+ /**
171
+ *
172
+ * @type {number}
173
+ * @memberof CreateOrderDto
174
+ */
175
+ 'paidWithCash': number;
176
+ /**
177
+ *
178
+ * @type {number}
179
+ * @memberof CreateOrderDto
180
+ */
181
+ 'paidWithCard': number;
182
+ /**
183
+ *
184
+ * @type {number}
185
+ * @memberof CreateOrderDto
186
+ */
187
+ 'refundedWithCash': number;
188
+ /**
189
+ *
190
+ * @type {number}
191
+ * @memberof CreateOrderDto
192
+ */
193
+ 'refundedWithCard': number;
194
+ }
195
+ declare const CreateOrderDtoStatusEnum: {
196
+ readonly Created: "CREATED";
197
+ readonly Paid: "PAID";
198
+ readonly Cancelled: "CANCELLED";
199
+ readonly Deleted: "DELETED";
200
+ readonly Refunded: "REFUNDED";
201
+ readonly Completed: "COMPLETED";
202
+ };
203
+ type CreateOrderDtoStatusEnum = typeof CreateOrderDtoStatusEnum[keyof typeof CreateOrderDtoStatusEnum];
204
+ /**
205
+ *
206
+ * @export
207
+ * @interface Dish
208
+ */
209
+ interface Dish {
210
+ /**
211
+ *
212
+ * @type {number}
213
+ * @memberof Dish
214
+ */
215
+ 'id': number;
216
+ /**
217
+ *
218
+ * @type {string}
219
+ * @memberof Dish
220
+ */
221
+ 'name': string;
222
+ /**
223
+ *
224
+ * @type {number}
225
+ * @memberof Dish
226
+ */
227
+ 'categoryId': number | null;
228
+ /**
229
+ *
230
+ * @type {Category}
231
+ * @memberof Dish
232
+ */
233
+ 'category': Category;
234
+ /**
235
+ *
236
+ * @type {number}
237
+ * @memberof Dish
238
+ */
239
+ 'ownPrice': number;
240
+ /**
241
+ *
242
+ * @type {number}
243
+ * @memberof Dish
244
+ */
245
+ 'sellingPrice': number;
246
+ /**
247
+ *
248
+ * @type {boolean}
249
+ * @memberof Dish
250
+ */
251
+ 'selling': boolean;
252
+ /**
253
+ *
254
+ * @type {string}
255
+ * @memberof Dish
256
+ */
257
+ 'createdAt': string;
258
+ /**
259
+ *
260
+ * @type {string}
261
+ * @memberof Dish
262
+ */
263
+ 'updatedAt': string;
264
+ /**
265
+ *
266
+ * @type {Array<DishIngredient>}
267
+ * @memberof Dish
268
+ */
269
+ 'dishIngredients': Array<DishIngredient>;
270
+ }
271
+ /**
272
+ *
273
+ * @export
274
+ * @interface DishIngredient
275
+ */
276
+ interface DishIngredient {
277
+ /**
278
+ *
279
+ * @type {number}
280
+ * @memberof DishIngredient
281
+ */
282
+ 'id': number;
283
+ /**
284
+ *
285
+ * @type {number}
286
+ * @memberof DishIngredient
287
+ */
288
+ 'dishId': number | null;
289
+ /**
290
+ *
291
+ * @type {number}
292
+ * @memberof DishIngredient
293
+ */
294
+ 'ingredientId': number | null;
295
+ /**
296
+ *
297
+ * @type {Dish}
298
+ * @memberof DishIngredient
299
+ */
300
+ 'dish': Dish;
301
+ /**
302
+ *
303
+ * @type {Ingredient}
304
+ * @memberof DishIngredient
305
+ */
306
+ 'ingredient': Ingredient;
307
+ }
308
+ /**
309
+ *
310
+ * @export
311
+ * @interface Ingredient
312
+ */
313
+ interface Ingredient {
314
+ /**
315
+ *
316
+ * @type {number}
317
+ * @memberof Ingredient
318
+ */
319
+ 'id': number;
320
+ /**
321
+ *
322
+ * @type {string}
323
+ * @memberof Ingredient
324
+ */
325
+ 'measurementUnit': string;
326
+ /**
327
+ *
328
+ * @type {Array<DishIngredient>}
329
+ * @memberof Ingredient
330
+ */
331
+ 'dishIngredients': Array<DishIngredient>;
332
+ }
333
+ /**
334
+ *
335
+ * @export
336
+ * @interface Order
337
+ */
338
+ interface Order {
339
+ /**
340
+ *
341
+ * @type {number}
342
+ * @memberof Order
343
+ */
344
+ 'id': number;
345
+ /**
346
+ *
347
+ * @type {string}
348
+ * @memberof Order
349
+ */
350
+ 'status': OrderStatusEnum;
351
+ /**
352
+ *
353
+ * @type {string}
354
+ * @memberof Order
355
+ */
356
+ 'createdAt': string;
357
+ /**
358
+ *
359
+ * @type {string}
360
+ * @memberof Order
361
+ */
362
+ 'updatedAt': string;
363
+ /**
364
+ *
365
+ * @type {number}
366
+ * @memberof Order
367
+ */
368
+ 'orderPrice': number;
369
+ /**
370
+ *
371
+ * @type {number}
372
+ * @memberof Order
373
+ */
374
+ 'paidWithCash': number;
375
+ /**
376
+ *
377
+ * @type {number}
378
+ * @memberof Order
379
+ */
380
+ 'paidWithCard': number;
381
+ /**
382
+ *
383
+ * @type {number}
384
+ * @memberof Order
385
+ */
386
+ 'refundedWithCash': number;
387
+ /**
388
+ *
389
+ * @type {number}
390
+ * @memberof Order
391
+ */
392
+ 'refundedWithCard': number;
393
+ /**
394
+ *
395
+ * @type {Array<OrderItem>}
396
+ * @memberof Order
397
+ */
398
+ 'orderItems': Array<OrderItem>;
399
+ }
400
+ declare const OrderStatusEnum: {
401
+ readonly Created: "CREATED";
402
+ readonly Paid: "PAID";
403
+ readonly Cancelled: "CANCELLED";
404
+ readonly Deleted: "DELETED";
405
+ readonly Refunded: "REFUNDED";
406
+ readonly Completed: "COMPLETED";
407
+ };
408
+ type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
409
+ /**
410
+ *
411
+ * @export
412
+ * @interface OrderItem
413
+ */
414
+ interface OrderItem {
415
+ /**
416
+ *
417
+ * @type {number}
418
+ * @memberof OrderItem
419
+ */
420
+ 'id': number;
421
+ /**
422
+ *
423
+ * @type {number}
424
+ * @memberof OrderItem
425
+ */
426
+ 'sellingPrice': number;
427
+ /**
428
+ *
429
+ * @type {string}
430
+ * @memberof OrderItem
431
+ */
432
+ 'discount': string | null;
433
+ /**
434
+ *
435
+ * @type {string}
436
+ * @memberof OrderItem
437
+ */
438
+ 'discountType': string;
439
+ /**
440
+ *
441
+ * @type {number}
442
+ * @memberof OrderItem
443
+ */
444
+ 'dishId': number | null;
445
+ /**
446
+ *
447
+ * @type {number}
448
+ * @memberof OrderItem
449
+ */
450
+ 'productId': number | null;
451
+ /**
452
+ *
453
+ * @type {number}
454
+ * @memberof OrderItem
455
+ */
456
+ 'orderId': number | null;
457
+ /**
458
+ *
459
+ * @type {Dish}
460
+ * @memberof OrderItem
461
+ */
462
+ 'dish': Dish | null;
463
+ /**
464
+ *
465
+ * @type {Product}
466
+ * @memberof OrderItem
467
+ */
468
+ 'product': Product | null;
469
+ /**
470
+ *
471
+ * @type {Order}
472
+ * @memberof OrderItem
473
+ */
474
+ 'order': Order;
475
+ }
476
+ /**
477
+ *
478
+ * @export
479
+ * @interface Product
480
+ */
481
+ interface Product {
482
+ /**
483
+ *
484
+ * @type {number}
485
+ * @memberof Product
486
+ */
487
+ 'id': number;
488
+ /**
489
+ *
490
+ * @type {string}
491
+ * @memberof Product
492
+ */
493
+ 'name': string;
494
+ /**
495
+ *
496
+ * @type {number}
497
+ * @memberof Product
498
+ */
499
+ 'ownPrice': number;
500
+ /**
501
+ *
502
+ * @type {number}
503
+ * @memberof Product
504
+ */
505
+ 'sellingPrice': number;
506
+ /**
507
+ *
508
+ * @type {number}
509
+ * @memberof Product
510
+ */
511
+ 'categoryId': number | null;
512
+ /**
513
+ *
514
+ * @type {Category}
515
+ * @memberof Product
516
+ */
517
+ 'category': Category;
518
+ /**
519
+ *
520
+ * @type {boolean}
521
+ * @memberof Product
522
+ */
523
+ 'selling': boolean;
524
+ /**
525
+ *
526
+ * @type {string}
527
+ * @memberof Product
528
+ */
529
+ 'createdAt': string;
530
+ /**
531
+ *
532
+ * @type {string}
533
+ * @memberof Product
534
+ */
535
+ 'updatedAt': string;
536
+ }
537
+ /**
538
+ *
539
+ * @export
540
+ * @interface UpdateOrderDto
541
+ */
542
+ interface UpdateOrderDto {
543
+ /**
544
+ * @default CREATED
545
+ * @type {string}
546
+ * @memberof UpdateOrderDto
547
+ */
548
+ 'status'?: UpdateOrderDtoStatusEnum;
549
+ /**
550
+ *
551
+ * @type {number}
552
+ * @memberof UpdateOrderDto
553
+ */
554
+ 'orderPrice'?: number;
555
+ /**
556
+ *
557
+ * @type {number}
558
+ * @memberof UpdateOrderDto
559
+ */
560
+ 'paidWithCash'?: number;
561
+ /**
562
+ *
563
+ * @type {number}
564
+ * @memberof UpdateOrderDto
565
+ */
566
+ 'paidWithCard'?: number;
567
+ /**
568
+ *
569
+ * @type {number}
570
+ * @memberof UpdateOrderDto
571
+ */
572
+ 'refundedWithCash'?: number;
573
+ /**
574
+ *
575
+ * @type {number}
576
+ * @memberof UpdateOrderDto
577
+ */
578
+ 'refundedWithCard'?: number;
579
+ }
580
+ declare const UpdateOrderDtoStatusEnum: {
581
+ readonly Created: "CREATED";
582
+ readonly Paid: "PAID";
583
+ readonly Cancelled: "CANCELLED";
584
+ readonly Deleted: "DELETED";
585
+ readonly Refunded: "REFUNDED";
586
+ readonly Completed: "COMPLETED";
587
+ };
588
+ type UpdateOrderDtoStatusEnum = typeof UpdateOrderDtoStatusEnum[keyof typeof UpdateOrderDtoStatusEnum];
589
+ /**
590
+ * OrdersApi - object-oriented interface
591
+ * @export
592
+ * @class OrdersApi
593
+ * @extends {BaseAPI}
594
+ */
595
+ declare class OrdersApi extends BaseAPI {
596
+ /**
597
+ *
598
+ * @param {CreateOrderDto} createOrderDto
599
+ * @param {*} [options] Override http request option.
600
+ * @throws {RequiredError}
601
+ * @memberof OrdersApi
602
+ */
603
+ create(createOrderDto: CreateOrderDto, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Order, any, {}, any>>;
604
+ /**
605
+ *
606
+ * @param {number} [page]
607
+ * @param {number} [limit]
608
+ * @param {string} [status]
609
+ * @param {*} [options] Override http request option.
610
+ * @throws {RequiredError}
611
+ * @memberof OrdersApi
612
+ */
613
+ findAll(page?: number, limit?: number, status?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Order[], any, {}, any>>;
614
+ /**
615
+ *
616
+ * @param {number} id
617
+ * @param {*} [options] Override http request option.
618
+ * @throws {RequiredError}
619
+ * @memberof OrdersApi
620
+ */
621
+ findOne(id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Order, any, {}, any>>;
622
+ /**
623
+ *
624
+ * @param {number} id
625
+ * @param {*} [options] Override http request option.
626
+ * @throws {RequiredError}
627
+ * @memberof OrdersApi
628
+ */
629
+ removeActiveReceipt(id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Order, any, {}, any>>;
630
+ /**
631
+ *
632
+ * @param {number} id
633
+ * @param {UpdateOrderDto} updateOrderDto
634
+ * @param {*} [options] Override http request option.
635
+ * @throws {RequiredError}
636
+ * @memberof OrdersApi
637
+ */
638
+ update(id: number, updateOrderDto: UpdateOrderDto, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Order, any, {}, any>>;
639
+ }
640
+
641
+ declare let tanstackClient: QueryClient;
642
+ declare let ordersApi: OrdersApi;
643
+ declare function initApiClient(config: CreateAxiosDefaults): void;
644
+
645
+ export { type Order as O, initApiClient as i, ordersApi as o, tanstackClient as t };