@matochmat/api-client 1.5.0-next.0 → 1.5.0-next.1

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 (62) hide show
  1. package/dist/index.cjs.js +282 -0
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.d.ts +30 -0
  4. package/dist/index.esm.js +236 -1
  5. package/dist/index.esm.js.map +1 -1
  6. package/dist/v2/bonusStampCode.d.ts +4 -0
  7. package/dist/v2/cateringDish.d.ts +4 -4
  8. package/dist/v2/cateringDishCategory.d.ts +4 -4
  9. package/dist/v2/cateringDishTab.d.ts +4 -4
  10. package/dist/v2/cateringFunctionality.d.ts +4 -0
  11. package/dist/v2/city.d.ts +4 -0
  12. package/dist/v2/cityUploadConnection.d.ts +4 -0
  13. package/dist/v2/coupon.d.ts +4 -0
  14. package/dist/v2/crawlingConfiguration.d.ts +4 -0
  15. package/dist/v2/crawlingConfigurationModel.d.ts +38 -0
  16. package/dist/v2/crawlingConfigurationTextContentStrategyType.d.ts +4 -4
  17. package/dist/v2/customer.d.ts +4 -0
  18. package/dist/v2/customerContact.d.ts +4 -0
  19. package/dist/v2/customerManagemement.d.ts +4 -0
  20. package/dist/v2/customerQuote.d.ts +51 -0
  21. package/dist/v2/customerQuoteUploadConnection.d.ts +15 -0
  22. package/dist/v2/customerQuoteUploadGrouping.d.ts +3 -0
  23. package/dist/v2/deliveryInfo.d.ts +4 -0
  24. package/dist/v2/dinnerDish.d.ts +4 -4
  25. package/dist/v2/dinnerDishCategory.d.ts +4 -4
  26. package/dist/v2/dinnerDishTab.d.ts +4 -4
  27. package/dist/v2/dinnerFunctionality.d.ts +4 -0
  28. package/dist/v2/dinnerFunctionalityType.d.ts +30 -0
  29. package/dist/v2/dynamicContent.d.ts +30 -0
  30. package/dist/v2/emailTemplate.d.ts +4 -0
  31. package/dist/v2/firebaseDeviceRegistrationToken.d.ts +4 -0
  32. package/dist/v2/geodata.d.ts +4 -0
  33. package/dist/v2/integrationV1Configuration.d.ts +4 -0
  34. package/dist/v2/integrationV2Configuration.d.ts +4 -0
  35. package/dist/v2/lunchBox.d.ts +4 -0
  36. package/dist/v2/lunchBoxFunctionality.d.ts +4 -0
  37. package/dist/v2/lunchFunctionality.d.ts +4 -0
  38. package/dist/v2/menuCrawlerProxy.d.ts +4 -0
  39. package/dist/v2/notice.d.ts +4 -0
  40. package/dist/v2/notificationPreference.d.ts +4 -0
  41. package/dist/v2/openingHour.d.ts +4 -0
  42. package/dist/v2/order.d.ts +4 -0
  43. package/dist/v2/orderItem.d.ts +4 -0
  44. package/dist/v2/policy.d.ts +4 -0
  45. package/dist/v2/restaurant.d.ts +4 -0
  46. package/dist/v2/restaurantFunctionalityVisitibilityType.d.ts +4 -0
  47. package/dist/v2/restaurantUploadConnection.d.ts +4 -0
  48. package/dist/v2/restaurantUploadGrouping.d.ts +4 -0
  49. package/dist/v2/showcase.d.ts +4 -0
  50. package/dist/v2/showcasePositionType.d.ts +4 -0
  51. package/dist/v2/showcaseUploadConnection.d.ts +15 -0
  52. package/dist/v2/showcaseViewCount.d.ts +4 -0
  53. package/dist/v2/subscriptionPeriod.d.ts +4 -0
  54. package/dist/v2/systemSetting.d.ts +38 -0
  55. package/dist/v2/tableBooking.d.ts +4 -0
  56. package/dist/v2/takeAway.d.ts +4 -0
  57. package/dist/v2/teamMember.d.ts +4 -0
  58. package/dist/v2/teamMemberUploadConnection.d.ts +15 -0
  59. package/dist/v2/updatedByType.d.ts +4 -4
  60. package/dist/v2/upload.d.ts +4 -0
  61. package/dist/v2/user.d.ts +4 -0
  62. package/package.json +1 -1
@@ -0,0 +1,3 @@
1
+ import type { ApiV2CustomerQuoteUploadConnectionType } from '../v2/customerQuoteUploadConnection';
2
+ import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
3
+ export type ApiV2CustomerQuoteUploadGroupingType = ApiV2UploadGroupingType<ApiV2CustomerQuoteUploadConnectionType>;
@@ -44,3 +44,7 @@ export type ApiV2DeliveryInfoType = {
44
44
  * The API response type for delivery info.
45
45
  */
46
46
  export type ApiV2DeliveryInfoResponseType = ApiV2BaseResponseType<ApiV2DeliveryInfoType[], number>;
47
+ /**
48
+ * API endpoint slug.
49
+ */
50
+ export declare const apiV2DeliveryInfoApiEndpointSlug = "delivery-info";
@@ -1,9 +1,5 @@
1
1
  import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
2
  import type { ApiV2DishType } from '../v2/dish';
3
- /**
4
- * API endpoint slug.
5
- */
6
- export declare const apiV2DinnerDishApiEndpointSlug = "dinner-dishes";
7
3
  /**
8
4
  * Type for the individual array items in v2 of the API for the dinner dish endpoint.
9
5
  */
@@ -17,3 +13,7 @@ export type ApiV2DinnerDishType = ApiV2DishType & {
17
13
  * The API response type for dinner dishes.
18
14
  */
19
15
  export type ApiV2DinnerDishResponseType = ApiV2BaseResponseType<ApiV2DinnerDishType[], number>;
16
+ /**
17
+ * API endpoint slug.
18
+ */
19
+ export declare const apiV2DinnerDishApiEndpointSlug = "dinner-dishes";
@@ -1,9 +1,5 @@
1
1
  import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
2
  import type { ApiV2DishCategoryType } from '../v2/dishCategory';
3
- /**
4
- * API endpoint slug.
5
- */
6
- export declare const apiV2DinnerDishCategoryApiEndpointSlug = "dinner-dish-categories";
7
3
  /**
8
4
  * Type for the individual array items in v2 of the API for the dinner dish category endpoint.
9
5
  */
@@ -17,3 +13,7 @@ export type ApiV2DinnerDishCategoryType = ApiV2DishCategoryType & {
17
13
  * The API response type for dinner dish categories.
18
14
  */
19
15
  export type ApiV2DinnerDishCategoryResponseType = ApiV2BaseResponseType<ApiV2DinnerDishCategoryType[], number>;
16
+ /**
17
+ * API endpoint slug.
18
+ */
19
+ export declare const apiV2DinnerDishCategoryApiEndpointSlug = "dinner-dish-categories";
@@ -1,9 +1,5 @@
1
1
  import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
2
  import type { ApiV2DishTabType } from '../v2/dishTab';
3
- /**
4
- * API endpoint slug.
5
- */
6
- export declare const apiV2DinnerDishTabApiEndpointSlug = "dinner-dish-tabs";
7
3
  /**
8
4
  * Type for the individual array items in v2 of the API for the dinner dish category endpoint.
9
5
  */
@@ -12,3 +8,7 @@ export type ApiV2DinnerDishTabType = ApiV2DishTabType;
12
8
  * The API response type for dinner dish categories.
13
9
  */
14
10
  export type ApiV2DinnerDishTabResponseType = ApiV2BaseResponseType<ApiV2DinnerDishTabType[], number>;
11
+ /**
12
+ * API endpoint slug.
13
+ */
14
+ export declare const apiV2DinnerDishTabApiEndpointSlug = "dinner-dish-tabs";
@@ -45,3 +45,7 @@ export type ApiV2DinnerFunctionalityType = ApiV2RestaurantFunctionalityType & {
45
45
  * The API response type for dinner functionality items.
46
46
  */
47
47
  export type ApiV2DinnerFunctionalityResponseType = ApiV2BaseResponseType<ApiV2DinnerFunctionalityType[], number>;
48
+ /**
49
+ * API endpoint slug.
50
+ */
51
+ export declare const apiV2DinnerFunctionalityApiEndpointSlug = "dinner-functionality";
@@ -0,0 +1,30 @@
1
+ import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
+ /**
3
+ * Type for the individual array items in v2 of the API for the dinner functionality type endpoint.
4
+ */
5
+ export type ApiV2DinnerFunctionalityTypeType = {
6
+ /**
7
+ * String representation of when the entity was created.
8
+ */
9
+ created: string;
10
+ /**
11
+ * Unique ID for the entity.
12
+ */
13
+ id: 1 | 2;
14
+ /**
15
+ * String representation of when the entity was last updated.
16
+ */
17
+ lastUpdated: string;
18
+ /**
19
+ * Human readable name.
20
+ */
21
+ name: string;
22
+ };
23
+ /**
24
+ * The API response type for dinner functionality types.
25
+ */
26
+ export type ApiV2DinnerFunctionalityTypeResponseType = ApiV2BaseResponseType<ApiV2DinnerFunctionalityTypeType[], number>;
27
+ /**
28
+ * API endpoint slug.
29
+ */
30
+ export declare const apiV2DinnerFunctionalityTypeApiEndpointSlug = "dinner-functionality-types";
@@ -0,0 +1,30 @@
1
+ import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
+ /**
3
+ * Type for the individual array items in v2 of the API for the dynamic content endpoint.
4
+ */
5
+ export type ApiV2DynamicContentType = {
6
+ /**
7
+ * Data for the dynamic content instance.
8
+ */
9
+ data: string;
10
+ /**
11
+ * Unique ID for the entity.
12
+ */
13
+ id: number;
14
+ /**
15
+ * TImestamp for when the entity was last updated.
16
+ */
17
+ lastUpdated: string;
18
+ /**
19
+ * ID of the user that the entity belongs to.
20
+ */
21
+ userId: number;
22
+ };
23
+ /**
24
+ * The API response type for dynamic content.
25
+ */
26
+ export type ApiV2DynamicContentResponseType = ApiV2BaseResponseType<ApiV2DynamicContentType[], number>;
27
+ /**
28
+ * API endpoint slug.
29
+ */
30
+ export declare const apiV2DynamicContentApiEndpointSlug = "dynamic-content";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2EmailTemplateApiEndpointSlug = "email-templates";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2FirebaseDeviceRegistrationTokenApiEndpointSlug = "firebase-device-registration-tokens";
@@ -37,3 +37,7 @@ export type ApiV2GeodataType = {
37
37
  */
38
38
  zoomLevel: number;
39
39
  };
40
+ /**
41
+ * API endpoint slug.
42
+ */
43
+ export declare const apiV2GeodataApiEndpointSlug = "geodata";
@@ -36,3 +36,7 @@ export type ApiV2IntegrationV1ConfigurationType = {
36
36
  * The API response type for integration v1 configurations.
37
37
  */
38
38
  export type ApiV2IntegrationV1ConfigurationResponseType = ApiV2BaseResponseType<ApiV2IntegrationV1ConfigurationType[], number>;
39
+ /**
40
+ * API endpoint slug.
41
+ */
42
+ export declare const apiV2IntegrationV1ConfigurationApiEndpointSlug = "integration-v1-configurations";
@@ -40,3 +40,7 @@ export type ApiV2IntegrationV2ConfigurationType = {
40
40
  * The API response type for integration v1 configurations.
41
41
  */
42
42
  export type ApiV2IntegrationV2ConfigurationResponseType = ApiV2BaseResponseType<ApiV2IntegrationV2ConfigurationType[], number>;
43
+ /**
44
+ * API endpoint slug.
45
+ */
46
+ export declare const apiV2IntegrationV2ConfigurationApiEndpointSlug = "integration-v2-configurations";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2LunchBoxApiEndpointSlug = "lunch-boxes";
@@ -29,3 +29,7 @@ export type ApiV2LunchBoxFunctionalityType = ApiV2RestaurantFunctionalityType &
29
29
  * The API response type for lunch box functionality.
30
30
  */
31
31
  export type ApiV2LunchBoxFunctionalityResponseType = ApiV2BaseResponseType<ApiV2LunchBoxFunctionalityType[], number>;
32
+ /**
33
+ * API endpoint slug.
34
+ */
35
+ export declare const apiV2LunchBoxFunctionalityApiEndpointSlug = "lunch-box-functionality";
@@ -57,3 +57,7 @@ export type ApiV2LunchFunctionalityType = ApiV2RestaurantFunctionalityType & {
57
57
  * The API response type for lunch functionality.
58
58
  */
59
59
  export type ApiV2LunchFunctionalityResponseType = ApiV2BaseResponseType<ApiV2LunchFunctionalityType[], number>;
60
+ /**
61
+ * API endpoint slug.
62
+ */
63
+ export declare const apiV2LunchFunctionalityApiEndpointSlug = "lunch-functionality";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * Endpoint for the local API to connect with the menu crawler.
3
+ */
4
+ export declare const apiV2MenuCrawlerProxyApiEndpointSlug = "menu-crawler-proxy";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2NoticeApiEndpointSlug = "notices";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2NotificationPreferenceApiEndpointSlug = "notification-preferences";
@@ -48,3 +48,7 @@ export type ApiV2OpeningHourType = {
48
48
  * The API response type for opening hour items.
49
49
  */
50
50
  export type ApiV2OpeningHourResponseType = ApiV2BaseResponseType<ApiV2OpeningHourType[], number>;
51
+ /**
52
+ * API endpoint slug.
53
+ */
54
+ export declare const apiV2OpeningHourApiEndpointSlug = "opening-hours";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2OrderApiEndpointSlug = "orders";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2OrderItemApiEndpointSlug = "order-items";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2PolicyApiEndpointSlug = "policies";
@@ -164,3 +164,7 @@ export type ApiV2RestaurantType = {
164
164
  * The API response type for restaurants.
165
165
  */
166
166
  export type ApiV2RestaurantResponseType = ApiV2BaseResponseType<ApiV2RestaurantType[], number>;
167
+ /**
168
+ * API endpoint slug.
169
+ */
170
+ export declare const apiV2RestaurantApiEndpointSlug = "restaurants";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2RestaurantFunctionalityVisibilityTypeApiEndpointSlug = "restaurant-functionality-visibility-types";
@@ -17,3 +17,7 @@ export type ApiV2RestaurantUploadConnectionType = ApiV2UploadConnectionType & {
17
17
  */
18
18
  sortOrder: number;
19
19
  };
20
+ /**
21
+ * API endpoint slug.
22
+ */
23
+ export declare const apiV2RestaurantUploadConnectionApiEndpointSlug = "restaurant-uploads";
@@ -1,3 +1,7 @@
1
1
  import type { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
2
2
  import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
3
3
  export type ApiV2RestaurantUploadGroupingType = ApiV2UploadGroupingType<ApiV2RestaurantUploadConnectionType>;
4
+ /**
5
+ * API endpoint slug.
6
+ */
7
+ export declare const apiV2RestaurantUploadGroupingApiEndpointSlug = "restaurant-upload-groupings";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2ShowcaseApiEndpointSlug = "showcases";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2ShowcasePositionTypeApiEndpointSlug = "showcase-position-types";
@@ -0,0 +1,15 @@
1
+ import type { ApiV2UploadConnectionType } from '../v2/uploadConnection';
2
+ export type ApiV2ShowcaseUploadConnectionType = ApiV2UploadConnectionType & {
3
+ /**
4
+ * Showcase ID upload belongs to.
5
+ */
6
+ showcaseId: number;
7
+ /**
8
+ * ID of upload type.
9
+ */
10
+ showcaseUploadTypeId: number;
11
+ };
12
+ /**
13
+ * API endpoint slug.
14
+ */
15
+ export declare const apiV2ShowcaseUploadConnectionApiEndpointSlug = "showcase-uploads";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2ShowCaseViewCountApiEndpointSlug = "showcase-view-counts";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2SubscriptionPeriodApiEndpointSlug = "subscription-periods";
@@ -0,0 +1,38 @@
1
+ import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
+ /**
3
+ * Type for available/allowed system settings.
4
+ */
5
+ export type SystemSettingKeyType = 'allowPositionFeaturesOutsideApp' | 'appUpdateNoticeDismissButtonEnabled' | 'appUpdateNoticeForVersionsOlderThan' | 'appUpdateNoticeText' | 'appUpdateNoticeTitle' | 'autoCorrections' | 'cateringRequestFormEnabled' | 'cateringDefaultSortIsShuffled' | 'dinnerDefaultSortIsShuffled' | 'dinnerDishCategoryColumnSelectionEnabled' | 'dinnerFunctionalityLinksEnabled' | 'emptyMenuRemindersActive' | 'faux404CityCateringPageText' | 'faux404CityCateringPageTitle' | 'faux404CityDinnerPageText' | 'faux404CityDinnerPageTitle' | 'faux404CityLunchBoxPageText' | 'faux404CityLunchBoxPageTitle' | 'faux404CityPageText' | 'faux404CityPageTitle' | 'getTheAppBannerActive' | 'googleMapsApiKey' | 'lunchBoxesNoticeDisplayTime' | 'mapFunctionalityEnabled' | 'promptUserToShareDialogActive' | 'readShoppingCartDataFromStorage' | 'showcaseMoreInformationContent' | 'showcaseMoreInformationTitle' | 'searchTagsEnabled' | 'simulatedServerTimeShift' | 'tellRestaurantAboutUsActive' | 'tellUsAboutRestaurantActive';
6
+ /**
7
+ * Type for the individual array items in v2 of the API for the system settings endpoint.
8
+ */
9
+ export type ApiV2SystemSettingType<T = unknown> = {
10
+ /**
11
+ * Whether or not the setting is backend only. This will still be sent to the frontend in some cases (admin editing etc.) which is why it's still available here.
12
+ */
13
+ backendOnly?: boolean;
14
+ /**
15
+ * Unique ID for the entity.
16
+ */
17
+ id: number;
18
+ /**
19
+ * Timestamp for when the entity was last updated.
20
+ */
21
+ lastUpdated: string;
22
+ /**
23
+ * Key for the setting.
24
+ */
25
+ settingKey: SystemSettingKeyType;
26
+ /**
27
+ * Value for the setting.
28
+ */
29
+ settingValue: T;
30
+ };
31
+ /**
32
+ * The API response type for system settings.
33
+ */
34
+ export type ApiV2SystemSettingResponseType = ApiV2BaseResponseType<ApiV2SystemSettingType[], number>;
35
+ /**
36
+ * API endpoint slug.
37
+ */
38
+ export declare const apiV2SystemSettingApiEndpointSlug = "system-settings";
@@ -52,3 +52,7 @@ export type ApiV2TableBookingType = {
52
52
  * The API response type for table booking info.
53
53
  */
54
54
  export type ApiV2TableBookingResponseType = ApiV2BaseResponseType<ApiV2TableBookingType[], number>;
55
+ /**
56
+ * API endpoint slug.
57
+ */
58
+ export declare const apiV2TableBookingApiEndpointSlug = "table-booking";
@@ -44,3 +44,7 @@ export type ApiV2TakeAwayType = {
44
44
  * The API response type for take away info.
45
45
  */
46
46
  export type ApiV2TakeAwayResponseType = ApiV2BaseResponseType<ApiV2TakeAwayType[], number>;
47
+ /**
48
+ * API endpoint slug.
49
+ */
50
+ export declare const apiV2TakeAwayApiEndpointSlug = "take-away";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2TeamMemberApiEndpointSlug = "team-members";
@@ -0,0 +1,15 @@
1
+ import type { ApiV2UploadConnectionType } from '../v2/uploadConnection';
2
+ export type ApiV2TeamMemberUploadConnectionType = ApiV2UploadConnectionType & {
3
+ /**
4
+ * Team member ID upload belongs to.
5
+ */
6
+ teamMemberId: number;
7
+ /**
8
+ * ID of upload type.
9
+ */
10
+ teamMemberUploadTypeId: number;
11
+ };
12
+ /**
13
+ * API endpoint slug.
14
+ */
15
+ export declare const apiV2TeamMemberUploadConnectionApiEndpointSlug = "team-member-uploads";
@@ -1,8 +1,4 @@
1
1
  import type { ApiV2BaseResponseType } from '../v2/baseResponse';
2
- /**
3
- * API endpoint slug.
4
- */
5
- export declare const apiV2UpdatedByTypeApiEndpointSlug = "updated-by-types";
6
2
  /**
7
3
  *
8
4
  */
@@ -28,3 +24,7 @@ export type ApiV2UpdatedByTypeType = {
28
24
  * The API response type for "Updated by" types.
29
25
  */
30
26
  export type ApiV2UpdatedByTypeResponseType = ApiV2BaseResponseType<ApiV2UpdatedByTypeType[], number>;
27
+ /**
28
+ * API endpoint slug.
29
+ */
30
+ export declare const apiV2UpdatedByTypeApiEndpointSlug = "updated-by-types";
@@ -32,3 +32,7 @@ export type ApiV2UploadType = {
32
32
  */
33
33
  uploaded: string;
34
34
  };
35
+ /**
36
+ * API endpoint slug.
37
+ */
38
+ export declare const apiV2UploadsApiEndpointSlug = "uploads";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * API endpoint slug.
3
+ */
4
+ export declare const apiV2UserApiEndpointSlug = "users";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@matochmat/api-client",
3
3
  "description": "API types and helper functionality for the Mat och Mat API.",
4
- "version": "1.5.0-next.0",
4
+ "version": "1.5.0-next.1",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
7
7
  "types": "dist/index.d.ts",