@open-tender/types 0.1.8 → 0.1.9

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 (35) hide show
  1. package/dist/cjs/types/api/config.d.ts +3 -366
  2. package/dist/cjs/types/api/configPos.d.ts +47 -0
  3. package/dist/cjs/types/api/customer/communicationPreferences.d.ts +1 -1
  4. package/dist/cjs/types/api/customer/customer.d.ts +5 -5
  5. package/dist/cjs/types/api/index.d.ts +9 -10
  6. package/dist/cjs/types/api/index.js +9 -10
  7. package/dist/cjs/types/api/order.d.ts +1 -2
  8. package/dist/cjs/types/api/theme.d.ts +493 -0
  9. package/dist/cjs/types/api/theme.js +2 -0
  10. package/dist/cjs/types/global.d.ts +2 -0
  11. package/dist/cjs/types/index.d.ts +1 -1
  12. package/dist/cjs/types/index.js +1 -1
  13. package/dist/cjs/types/inputs.d.ts +80 -0
  14. package/dist/cjs/types/inputs.js +23 -0
  15. package/dist/cjs/types/themePos.js +2 -0
  16. package/dist/esm/types/api/config.d.ts +3 -366
  17. package/dist/esm/types/api/configPos.d.ts +47 -0
  18. package/dist/esm/types/api/customer/communicationPreferences.d.ts +1 -1
  19. package/dist/esm/types/api/customer/customer.d.ts +5 -5
  20. package/dist/esm/types/api/index.d.ts +9 -10
  21. package/dist/esm/types/api/index.js +9 -10
  22. package/dist/esm/types/api/order.d.ts +1 -2
  23. package/dist/esm/types/api/theme.d.ts +493 -0
  24. package/dist/esm/types/api/theme.js +1 -0
  25. package/dist/esm/types/global.d.ts +2 -0
  26. package/dist/esm/types/index.d.ts +1 -1
  27. package/dist/esm/types/index.js +1 -1
  28. package/dist/esm/types/inputs.d.ts +80 -0
  29. package/dist/esm/types/inputs.js +15 -0
  30. package/dist/esm/types/themePos.js +1 -0
  31. package/package.json +1 -1
  32. /package/dist/cjs/types/{theme.js → api/configPos.js} +0 -0
  33. /package/dist/cjs/types/{theme.d.ts → themePos.d.ts} +0 -0
  34. /package/dist/esm/types/{theme.js → api/configPos.js} +0 -0
  35. /package/dist/esm/types/{theme.d.ts → themePos.d.ts} +0 -0
@@ -1,54 +1,7 @@
1
1
  import { TimezonePython } from '../datetimes';
2
- import { IpAddress, OrderType, ServiceType } from '../global';
3
- import { ButtonColor } from '../theme';
2
+ import { OrderType, ServiceType } from '../global';
4
3
  import { LoyaltyType, NotificationChannel } from './customer';
5
- import { PrepStations, PrepStatus } from './kds';
6
4
  import { RevenueCenterStatus } from './revenueCenter';
7
- export interface Config {
8
- backup_printer_ip_address: IpAddress | null;
9
- backup_printer_use_beeper: boolean;
10
- brand_id: number;
11
- cardreader_id: string;
12
- has_cardreader: boolean;
13
- has_cardwriter: boolean;
14
- has_cashdrawer: boolean;
15
- has_pinpad: boolean;
16
- has_qrcode: boolean;
17
- has_timeclock: boolean;
18
- ip_address: IpAddress;
19
- name: string;
20
- pos_server_id: number;
21
- pos_terminal_id: number;
22
- prep_stations?: PrepStations | null;
23
- print_kds: boolean;
24
- print_receipt: 'never' | 'always' | 'prompt';
25
- printer: IpAddress;
26
- printer_use_beeper: boolean;
27
- scanner_id: string;
28
- server: IpAddress;
29
- terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
30
- }
31
- export interface ItemType {
32
- default_prep_status: PrepStatus;
33
- is_default: boolean;
34
- is_grouped: boolean;
35
- is_hidden_assembly: boolean;
36
- is_hidden_qa: boolean;
37
- item_type_id: number;
38
- items: number[];
39
- name: string;
40
- position: number;
41
- prep_time: number;
42
- print_on_completed: boolean;
43
- }
44
- export declare type ItemTypes = Array<ItemType>;
45
- export interface SelectOption {
46
- name: string;
47
- option_type: 'PAID_IN' | 'PAID_OUT';
48
- position: number;
49
- select_option_id: number;
50
- }
51
- export declare type SelectOptions = Array<SelectOption>;
52
5
  export interface ConfigApp {
53
6
  authUrl: string;
54
7
  baseUrl: string;
@@ -98,7 +51,7 @@ export interface ConfigOrderNotifications {
98
51
  title: string;
99
52
  }
100
53
  export interface ConfigBrand {
101
- accepts_marketing: ConfigAcceptMarketing;
54
+ accepts_marketing: ConfigAcceptMarketing | null;
102
55
  applePayMerchantId: string;
103
56
  appleTouchIcon: string;
104
57
  brandId: number;
@@ -128,7 +81,7 @@ export interface ConfigBrand {
128
81
  loyalty: ConfigLoyalty;
129
82
  olo_id: number;
130
83
  openGraphImage: string | null;
131
- order_notifications: ConfigOrderNotifications;
84
+ order_notifications: ConfigOrderNotifications | null;
132
85
  origin: string;
133
86
  timezone: TimezonePython;
134
87
  title: string;
@@ -471,319 +424,3 @@ export interface ConfigSettings {
471
424
  giftCards: boolean;
472
425
  };
473
426
  }
474
- export interface ConfigButtonSize {
475
- borderRadius: string;
476
- borderWidth: string;
477
- borderWidthApp: string;
478
- fontSize: string;
479
- letterSpacing: string;
480
- padding: string;
481
- showButtonApp: boolean;
482
- showSubtitle: boolean;
483
- showSubtitleMobile: boolean;
484
- subtitleFontMobile: string;
485
- subtitleFontSize: string;
486
- subtitleFontSizeMobile: string;
487
- subtitleFontWeight: string;
488
- subtitleMarginTop: string;
489
- subtitleMarginTopMobile: string;
490
- titleFontMobile: string;
491
- titleFontSize: string;
492
- titleFontSizeMobile: string;
493
- titleFontWeight: string;
494
- titleMarginLeft: string;
495
- titleMarginLeftMobile: string;
496
- fontMobile: string;
497
- }
498
- export interface ConfigCardColors {
499
- bgColor: string;
500
- borderColor: string;
501
- borderRadius: string;
502
- borderWidth: string;
503
- borderWidthApp: string;
504
- boxShadow: string;
505
- caloriesColor: string;
506
- overrideFontColors: boolean;
507
- priceColor: string;
508
- priceSize: string;
509
- priceSizeMobile: string;
510
- textColor: string;
511
- titleColor: string;
512
- titleSize: string;
513
- titleSizeMobile: string;
514
- }
515
- export interface ConfigCountColors {
516
- bgColor: string;
517
- borderColor: string;
518
- borderWidth: string;
519
- borderWidthApp: string;
520
- color: string;
521
- family: string;
522
- fontMobile: string;
523
- fontSize: string;
524
- fontSizeMobile: string;
525
- fontSmoothing: string;
526
- paddingBottom: string;
527
- paddingTop: string;
528
- weight: string;
529
- }
530
- export declare type ConfigFontSizes = 'big' | 'giga' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'main' | 'mega' | 'small' | 'tera' | 'xBig' | 'xSmall' | 'xxBig' | 'xxSmall';
531
- export declare type ConfigThemeFontSizes = Record<string, string> & {
532
- [keys in ConfigFontSizes]: string;
533
- };
534
- export interface ConfigFont {
535
- color: string;
536
- family: string;
537
- fontMobile: string;
538
- fontSmoothing: string;
539
- letterSpacing: string;
540
- lineHeight: number;
541
- lineHeights: ConfigThemeFontSizes;
542
- textTransform: string;
543
- url: string;
544
- weight: string;
545
- fontSize?: string;
546
- }
547
- export interface ConfigItem {
548
- imageHeight: string;
549
- imageMaxHeight: string;
550
- imageMinHeight: string;
551
- imagePadding: string;
552
- maxWidth: string;
553
- padding: string;
554
- }
555
- export interface ConfigLink {
556
- color: string;
557
- hover: string;
558
- }
559
- export interface ConfigThemeFont {
560
- body: ConfigFont;
561
- headings: ConfigFont;
562
- headline: ConfigFont;
563
- lineHeights: ConfigThemeFontSizes;
564
- preface: ConfigFont;
565
- sizes: ConfigThemeFontSizes;
566
- sizesMobile: ConfigThemeFontSizes;
567
- }
568
- export interface ConfigThemeInputLabel {
569
- fontSize: string;
570
- left: string;
571
- lineHeight: string;
572
- offset: string;
573
- padding: string;
574
- top: string;
575
- fontSizeMobile: string;
576
- }
577
- export interface ConfigThemeInput {
578
- bgColor: string;
579
- bgColorFocus: string;
580
- borderColor: string;
581
- borderColorFocus: string;
582
- borderStyle: string;
583
- borderWidth: string;
584
- borderWidthApp: string;
585
- bottomBorderOnly: boolean;
586
- boxShadow: string;
587
- color: string;
588
- colorFocus: string;
589
- family: string;
590
- fontMobile: string;
591
- fontSize: string;
592
- fontSizeMobile: string;
593
- fontSmoothing: string;
594
- iconLeft: string;
595
- iconPadding: string;
596
- label: ConfigThemeInputLabel;
597
- letterSpacing: string;
598
- lineHeight: string;
599
- padding: string;
600
- paddingBottom: string;
601
- paddingBottomActive: string;
602
- paddingHorizontal: string;
603
- paddingTop: string;
604
- paddingTopActive: string;
605
- paddingVertical: string;
606
- placeholderColor: string;
607
- radius: string;
608
- selectPaddingBottom: string;
609
- selectSize: string;
610
- selectSizeMobile: string;
611
- showIcon: boolean;
612
- showLabel: boolean;
613
- showOutline: boolean;
614
- textTransform: string;
615
- weight: string;
616
- }
617
- export interface ConfigThemeItem {
618
- desktop: ConfigItem;
619
- imageMaxHeight: string;
620
- imageMinHeight: string;
621
- imagePadding: string;
622
- maxWidth: string;
623
- mobile: ConfigItem;
624
- padding: string;
625
- }
626
- export interface ConfigThemeLayout {
627
- containerMaxWidth: string;
628
- headerHeightApp: string;
629
- headerHeightSite: string;
630
- headerHeightSiteMobile: string;
631
- margin: string;
632
- marginMobile: string;
633
- maxWidth: string;
634
- navHeight: string;
635
- navHeightApp: string;
636
- navHeightMobile: string;
637
- padding: string;
638
- paddingMobile: string;
639
- }
640
- export interface ConfigCategoriesItem {
641
- desktop: {
642
- displayType: string;
643
- };
644
- mobile: {
645
- displayType: string;
646
- };
647
- }
648
- export interface ConfigThemeButtons {
649
- colors: {
650
- cart: ButtonColor;
651
- cartHover: ButtonColor;
652
- header: ButtonColor;
653
- headerHover: ButtonColor;
654
- large: ButtonColor & {
655
- iconColor: string;
656
- subtitleColor: string;
657
- };
658
- largeHover: ButtonColor & {
659
- iconColor: string;
660
- subtitleColor: string;
661
- };
662
- light: ButtonColor;
663
- lightHover: ButtonColor;
664
- primary: ButtonColor;
665
- primaryHover: ButtonColor;
666
- secondary: ButtonColor;
667
- secondaryHover: ButtonColor;
668
- };
669
- sizes: {
670
- big: Partial<ConfigButtonSize>;
671
- default: Partial<ConfigButtonSize>;
672
- header: Partial<ConfigButtonSize>;
673
- large: Partial<ConfigButtonSize>;
674
- small: Partial<ConfigButtonSize>;
675
- };
676
- }
677
- export interface ConfigThemeCards {
678
- default: Partial<ConfigCardColors>;
679
- form: Partial<ConfigCardColors>;
680
- menuItem: Partial<ConfigCardColors>;
681
- modifier: Partial<ConfigCardColors>;
682
- }
683
- export interface ConfigThemeBorder {
684
- color: string;
685
- radius: string;
686
- radiusSmall: string;
687
- width: string;
688
- widthApp: string;
689
- }
690
- export interface ConfigThemeCounts {
691
- alerts: Partial<ConfigCountColors>;
692
- quantity: Partial<ConfigCountColors>;
693
- }
694
- export interface ConfigThemeWelcome {
695
- marginBottom: string;
696
- marginTop: string;
697
- subtitleLineHeight: string;
698
- subtitleMarginTop: string;
699
- subtitleSize: string;
700
- textAlign: string;
701
- titleLineHeight: string;
702
- titleMarginLeft: string;
703
- titleSize: string;
704
- mobile?: ConfigThemeWelcome;
705
- }
706
- export interface ConfigThemeColors extends Record<string, string> {
707
- alert: string;
708
- allergens: string;
709
- dark: string;
710
- error: string;
711
- highlight: string;
712
- light: string;
713
- primary: string;
714
- secondary: string;
715
- success: string;
716
- tertiary: string;
717
- toast: string;
718
- }
719
- export interface ConfigTheme {
720
- alert: {
721
- bgColor: string;
722
- color: string;
723
- };
724
- bgColors: ConfigThemeColors;
725
- boldWeight: string;
726
- border: ConfigThemeBorder;
727
- boxShadow: {
728
- appBig: string;
729
- appSmall: string;
730
- inset: string;
731
- outer: string;
732
- };
733
- breakpoints: {
734
- laptop: string;
735
- mobile: string;
736
- narrow: string;
737
- tablet: string;
738
- };
739
- buttons: ConfigThemeButtons;
740
- cards: ConfigThemeCards;
741
- colors: ConfigThemeColors;
742
- counts: ConfigThemeCounts;
743
- error: {
744
- bgColor: string;
745
- color: string;
746
- };
747
- favorite: {
748
- iconSize: string;
749
- size: string;
750
- };
751
- fonts: ConfigThemeFont;
752
- header: {
753
- primary: string;
754
- stuck: string;
755
- };
756
- icons: {
757
- strokeWidth: number;
758
- };
759
- inputs: ConfigThemeInput;
760
- item: ConfigThemeItem;
761
- layout: ConfigThemeLayout;
762
- lineHeight: string;
763
- links: {
764
- customize: ConfigLink;
765
- dark: ConfigLink;
766
- light: ConfigLink;
767
- primary: ConfigLink;
768
- textDecoration: string;
769
- transition: string;
770
- };
771
- overlay: {
772
- alert: string;
773
- dark: string;
774
- light: string;
775
- primary: string;
776
- secondary: string;
777
- tertiary: string;
778
- };
779
- success: {
780
- bgColor: string;
781
- color: string;
782
- };
783
- toast: {
784
- bgColor: string;
785
- color: string;
786
- };
787
- welcome: ConfigThemeWelcome;
788
- categories: ConfigCategoriesItem;
789
- }
@@ -0,0 +1,47 @@
1
+ import { IpAddress } from '../global';
2
+ import { PrepStations, PrepStatus } from './kds';
3
+ export interface Config {
4
+ backup_printer_ip_address: IpAddress | null;
5
+ backup_printer_use_beeper: boolean;
6
+ brand_id: number;
7
+ cardreader_id: string;
8
+ has_cardreader: boolean;
9
+ has_cardwriter: boolean;
10
+ has_cashdrawer: boolean;
11
+ has_pinpad: boolean;
12
+ has_qrcode: boolean;
13
+ has_timeclock: boolean;
14
+ ip_address: IpAddress;
15
+ name: string;
16
+ pos_server_id: number;
17
+ pos_terminal_id: number;
18
+ prep_stations?: PrepStations | null;
19
+ print_kds: boolean;
20
+ print_receipt: 'never' | 'always' | 'prompt';
21
+ printer: IpAddress;
22
+ printer_use_beeper: boolean;
23
+ scanner_id: string;
24
+ server: IpAddress;
25
+ terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
26
+ }
27
+ export interface ItemType {
28
+ default_prep_status: PrepStatus;
29
+ is_default: boolean;
30
+ is_grouped: boolean;
31
+ is_hidden_assembly: boolean;
32
+ is_hidden_qa: boolean;
33
+ item_type_id: number;
34
+ items: number[];
35
+ name: string;
36
+ position: number;
37
+ prep_time: number;
38
+ print_on_completed: boolean;
39
+ }
40
+ export declare type ItemTypes = Array<ItemType>;
41
+ export interface SelectOption {
42
+ name: string;
43
+ option_type: 'PAID_IN' | 'PAID_OUT';
44
+ position: number;
45
+ select_option_id: number;
46
+ }
47
+ export declare type SelectOptions = Array<SelectOption>;
@@ -2,7 +2,7 @@ import { ISOStringOffset } from '../../datetimes';
2
2
  export declare type NotificationChannel = 'EMAIL' | 'SMS' | 'PUSH' | 'ALL';
3
3
  export declare type NotificationArea = 'ORDER' | 'RATING' | 'MARKETING';
4
4
  export interface CustomerNotificationPref {
5
- craeted_at: ISOStringOffset;
5
+ created_at: ISOStringOffset;
6
6
  customer_notification_preference_id: number;
7
7
  notification_area: NotificationArea;
8
8
  notification_channel: NotificationChannel;
@@ -1,6 +1,7 @@
1
1
  import { DateString } from '../../datetimes';
2
+ import { Gender, OrderNotifications } from '../../global';
2
3
  import { Allergens } from '../allergens';
3
- import { CreditCard } from '../creditCards';
4
+ import { CreditCards } from '../creditCards';
4
5
  import { Favorites } from '../favorite';
5
6
  import { CustomerNotificationPrefs } from './communicationPreferences';
6
7
  import { CustomerGiftCard, CustomerGiftCards } from './giftCards';
@@ -12,18 +13,17 @@ export interface Customer {
12
13
  customer_id?: number;
13
14
  email?: string;
14
15
  first_name?: string;
15
- gender?: 'MALE' | 'FEMALE' | 'DECLINED' | null;
16
+ gender?: Gender;
16
17
  is_guest?: boolean;
17
18
  is_notification_set?: boolean;
18
19
  is_verified?: boolean;
19
20
  last_name?: string;
20
- order_notifications?: 'NEW' | 'EMAIL' | 'SMS' | 'ALL' | 'NONE';
21
+ order_notifications?: OrderNotifications;
21
22
  phone?: string | null;
22
23
  password?: string;
23
- credit_cards?: Array<Partial<CreditCard>>;
24
+ credit_cards?: CreditCards;
24
25
  gift_cards?: Array<Partial<CustomerGiftCard>>;
25
26
  house_accounts?: HouseAccounts;
26
- levelup?: any;
27
27
  }
28
28
  export interface CustomerWithRelated extends Customer {
29
29
  allergens?: Allergens;
@@ -1,15 +1,22 @@
1
1
  export * from './alerts';
2
+ export * from './allergens';
3
+ export * from './announcements';
2
4
  export * from './arrivals';
3
5
  export * from './cart';
4
6
  export * from './checkout';
7
+ export * from './completedOrders';
5
8
  export * from './config';
9
+ export * from './creditCards';
6
10
  export * from './customer';
11
+ export * from './deals';
7
12
  export * from './device';
8
13
  export * from './discounts';
14
+ export * from './donations';
9
15
  export * from './employee';
10
16
  export * from './errorAlerts';
11
17
  export * from './favorite';
12
18
  export * from './giftCard';
19
+ export * from './guest';
13
20
  export * from './kds';
14
21
  export * from './menu';
15
22
  export * from './menuPages';
@@ -17,6 +24,7 @@ export * from './messages';
17
24
  export * from './notifications';
18
25
  export * from './offlineAuths';
19
26
  export * from './order';
27
+ export * from './orders';
20
28
  export * from './pos';
21
29
  export * from './refund';
22
30
  export * from './revenueCenter';
@@ -24,13 +32,4 @@ export * from './settings';
24
32
  export * from './store';
25
33
  export * from './surcharges';
26
34
  export * from './taxes';
27
- export * from './donations';
28
- export * from './guest';
29
- export * from './completedOrders';
30
- export * from './orders';
31
- export * from './allergens';
32
- export * from './creditCards';
33
- export * from './announcements';
34
- export * from './deals';
35
- export * from './allergens';
36
- export * from './config';
35
+ export * from './theme';
@@ -1,15 +1,22 @@
1
1
  export * from './alerts';
2
+ export * from './allergens';
3
+ export * from './announcements';
2
4
  export * from './arrivals';
3
5
  export * from './cart';
4
6
  export * from './checkout';
7
+ export * from './completedOrders';
5
8
  export * from './config';
9
+ export * from './creditCards';
6
10
  export * from './customer';
11
+ export * from './deals';
7
12
  export * from './device';
8
13
  export * from './discounts';
14
+ export * from './donations';
9
15
  export * from './employee';
10
16
  export * from './errorAlerts';
11
17
  export * from './favorite';
12
18
  export * from './giftCard';
19
+ export * from './guest';
13
20
  export * from './kds';
14
21
  export * from './menu';
15
22
  export * from './menuPages';
@@ -17,6 +24,7 @@ export * from './messages';
17
24
  export * from './notifications';
18
25
  export * from './offlineAuths';
19
26
  export * from './order';
27
+ export * from './orders';
20
28
  export * from './pos';
21
29
  export * from './refund';
22
30
  export * from './revenueCenter';
@@ -24,13 +32,4 @@ export * from './settings';
24
32
  export * from './store';
25
33
  export * from './surcharges';
26
34
  export * from './taxes';
27
- export * from './donations';
28
- export * from './guest';
29
- export * from './completedOrders';
30
- export * from './orders';
31
- export * from './allergens';
32
- export * from './creditCards';
33
- export * from './announcements';
34
- export * from './deals';
35
- export * from './allergens';
36
- export * from './config';
35
+ export * from './theme';
@@ -1,5 +1,5 @@
1
1
  import { ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
2
- import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Images, Money, NegativeMoney, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
2
+ import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Images, Money, NegativeMoney, OrderNotifications, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
3
3
  import { CreditCard } from './creditCards';
4
4
  import { Address } from './customer';
5
5
  import { PrepStatus } from './kds';
@@ -32,7 +32,6 @@ export interface OrderItemGroup {
32
32
  }
33
33
  export declare type OrderItemGroups = OrderItemGroup[];
34
34
  export declare type OrderCart = OrderItem[];
35
- export declare type OrderNotifications = 'ALL' | 'EMAIL' | 'NEW' | 'NONE' | 'SMS';
36
35
  export interface OrderCustomerCreditCard {
37
36
  card_type: CardType;
38
37
  card_type_name: CardTypeName;