@matochmat/api-client 2.0.0-next.2 → 2.0.0-next.21

package/dist/v2/bonusStampCode.d.ts

@@ -1,3 +1,41 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the bonus stamp code endpoint.
+ */
+export type ApiV2BonusStampCodeType = {
+    /**
+     * The batch the code belongs to.
+     */
+    batch: string;
+    /**
+     * The actual bonus stamp code.
+     */
+    code: string;
+    /**
+     * Whether or not the code has been deactivated.
+     */
+    deactivated: boolean;
+    /**
+     * Timestamp for when the code was generated.
+     */
+    generated: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Timestamp for when the code was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the restaurant the code is relevant for.
+     */
+    restaurantId: number;
+};
+/**
+ * The API response type for bonus stamp codes.
+ */
+export type ApiV2BonusStampCodeResponseType = ApiV2BaseResponseType<ApiV2BonusStampCodeType[], number>;
 /**
  * API endpoint slug.
  */

package/dist/v2/cateringFunctionality.d.ts

@@ -1,5 +1,5 @@
 import type { ApiV2BaseResponseType } from '../v2/baseResponse';
-import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionality';
 /**
  * Type for the individual array items in v2 of the API for the catering functionality endpoint.
  */

package/dist/v2/city.d.ts

@@ -1,6 +1,6 @@
 import type { ApiV2BaseResponseType } from '../v2/baseResponse';
-import type { ApiV2CityUploadGroupingType } from '../v2/cityUploadGrouping';
-import type { ApiV2GeodataType } from '../v2/geodata';
+import type { ApiV2ShowcaseUploadConnectionType } from '../v2/showcaseUploadConnection';
+import type { ApiV2UploadType } from '../v2/upload';
 /**
  * Type for the individual array items in v2 of the API for the city endpoint.
  */
@@ -50,11 +50,6 @@ export type ApiV2CityType = {
      * Intro text for the dinner list.
      */
     dinnerIntroText: string;
-    /**
-     * Geodata information for the city.
-     * @deprecated
-     */
-    geodata: ApiV2GeodataType;
     /**
      * Unique ID for the city.
      */
@@ -106,7 +101,16 @@ export type ApiV2CityType = {
     /**
      * OG image for the city.
      */
-    sharingImage: ApiV2CityUploadGroupingType;
+    sharingImage: {
+        /**
+         * The upload connection between the city and the upload.
+         */
+        cityUpload: ApiV2ShowcaseUploadConnectionType;
+        /**
+         * Information about the actual upload.
+         */
+        upload: ApiV2UploadType;
+    };
     /**
      * Machine readable name of the city used in URLs among other places.
      */

package/dist/v2/coupon.d.ts

@@ -1,3 +1,53 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the coupon endpoint.
+ */
+export type ApiV2CouponType = {
+    /**
+     * Determines whether or not the coupon is active.
+     */
+    active: boolean;
+    /**
+     * The actual coupon code string.
+     */
+    code: string;
+    /**
+     * String representation of when the coupon was created.
+     */
+    created: null | string;
+    /**
+     * Description of the coupon.
+     */
+    description: string;
+    /**
+     * String representation of the end date of the coupon validity.
+     */
+    endDate: string;
+    /**
+     * Unique ID for the coupon.
+     */
+    id: number;
+    /**
+     * String representation of when the coupon was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Name of the coupon.
+     */
+    name: string;
+    /**
+     * String representation of the start date of the coupon validity.
+     */
+    startDate: string;
+    /**
+     * Determines whether or not the coupon is valid for all cities.
+     */
+    validForAllCities: boolean;
+};
+/**
+ * The API response type for coupons.
+ */
+export type ApiV2CouponResponseType = ApiV2BaseResponseType<ApiV2CouponType[], number>;
 /**
  * API endpoint slug.
  */

package/dist/v2/customer.d.ts

@@ -1,3 +1,73 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the customer endpoint.
+ */
+export type ApiV2CustomerType = {
+    /**
+     * Active status.
+     */
+    active: boolean;
+    /**
+     * Corporate ID number.
+     */
+    corporateIdNumber: string;
+    /**
+     * String representation of when the restaurant was created.
+     */
+    created: string;
+    /**
+     * On/off status for email invoicing.
+     */
+    emailInvoicing: boolean;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * City used for billing invoicing.
+     */
+    invoiceCity: string;
+    /**
+     * Email address used for billing contact purposes. Note that this is NOT the email used for sending invoices (see `invoiceEmailAddress` instead for that).
+     */
+    invoiceContactEmailAddress: string;
+    /**
+     * First name used for billing contact purposes.
+     */
+    invoiceContactFirstName: string;
+    /**
+     * Last name used for billing contact purposes.
+     */
+    invoiceContactLastName: string;
+    /**
+     * Phone number used for billing contact purposes.
+     */
+    invoiceContactPhoneNumber: string;
+    /**
+     * Email address used for invoicing.
+     */
+    invoiceEmailAddress: string;
+    /**
+     * Postal address used for invoicing.
+     */
+    invoicePostalAddress: string;
+    /**
+     * Zip code used for invoicing.
+     */
+    invoiceZipCode: string;
+    /**
+     * String representation of when entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Name of the entity.
+     */
+    name: string;
+};
+/**
+ * The API response type for customers.
+ */
+export type ApiV2CustomerResponseType = ApiV2BaseResponseType<ApiV2CustomerType[], number>;
 /**
  * API endpoint slug for the entity.
  */

package/dist/v2/dinnerFunctionality.d.ts

@@ -1,7 +1,8 @@
 import type { ApiV2BaseResponseType } from '../v2/baseResponse';
 import type { ApiV2OpeningHourType } from '../v2/openingHour';
-import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
-import type { ApiV2RestaurantUploadGroupingType } from '../v2/restaurantUploadGrouping';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionality';
+import type { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
+import type { ApiV2UploadType } from '../v2/upload';
 /**
  * Type for the individual array items in v2 of the API for the dinner functionality endpoint.
  */
@@ -21,7 +22,16 @@ export type ApiV2DinnerFunctionalityType = ApiV2RestaurantFunctionalityType & {
     /**
      * Background for the restaurant details page header.
      */
-    dinnerMenuImage: ApiV2RestaurantUploadGroupingType;
+    dinnerMenuImage: {
+        /**
+         *
+         */
+        restaurantUpload: ApiV2RestaurantUploadConnectionType;
+        /**
+         *
+         */
+        upload: ApiV2UploadType;
+    };
     /**
      * String representation of the last time the entity was updated.
      */

package/dist/v2/emailTemplate.d.ts

@@ -1,3 +1,53 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the email template endpoint.
+ */
+export type ApiV2EmailTemplateType = {
+    /**
+     * Determines if the template is active.
+     */
+    active: boolean;
+    /**
+     * Main text content.
+     */
+    content: string;
+    /**
+     * String representation of when the email template was created.
+     */
+    created: null | string;
+    /**
+     * Determines if the template should default to sending a blind carbon copy to Hubspot.
+     */
+    hubspotBcc: boolean;
+    /**
+     * Unique ID for the email template.
+     */
+    id: number;
+    /**
+     * String representation of when the email template was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Name of the email template.
+     */
+    name: string;
+    /**
+     * Determines if the template is required by the system (which will limit what admins can do with it in regards to disabling and deleting).
+     */
+    requiredBySystem: boolean;
+    /**
+     * Determines if the template should be shown in the GUI where admins can choose a template for their emails.
+     */
+    showInTemplateSelection: boolean;
+    /**
+     * Title of the email.
+     */
+    title: string;
+};
+/**
+ * The API response type for email templates.
+ */
+export type ApiV2EmailTemplateResponseType = ApiV2BaseResponseType<ApiV2EmailTemplateType[], number>;
 /**
  * API endpoint slug.
  */

package/dist/v2/favorite.d.ts

@@ -0,0 +1,21 @@
+/**
+ *
+ */
+export type ApiV2FavoriteType = {
+    /**
+     *
+     */
+    favorite: boolean;
+    /**
+     *
+     */
+    lastUpdated: string;
+    /**
+     *
+     */
+    restaurantId: number;
+    /**
+     *
+     */
+    userId: number;
+};

package/dist/v2/geodata.d.ts

@@ -1,9 +1,4 @@
 export type ApiV2GeodataType = {
-    /**
-     * Unused.
-     * @deprecated
-     */
-    cityId: number;
     /**
      * Timestamp for when the entity was created.
      */
@@ -32,10 +27,6 @@ export type ApiV2GeodataType = {
      * The URL for the static map image.
      */
     staticMapImageUrl: string;
-    /**
-     *
-     */
-    zoomLevel: number;
 };
 /**
  * API endpoint slug.

package/dist/v2/lunchBoxFunctionality.d.ts

@@ -1,5 +1,5 @@
 import type { ApiV2BaseResponseType } from '../v2/baseResponse';
-import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionality';
 /**
  * Type for the individual array items in v2 of the API for the lunch box functionality endpoint.
  */

package/dist/v2/lunchFunctionality.d.ts

@@ -1,7 +1,7 @@
 import type { ApiV2BaseResponseType } from '../v2/baseResponse';
 import type { ApiV2LunchDishType } from '../v2/lunchDish';
 import type { ApiV2OpeningHourType } from '../v2/openingHour';
-import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionality';
 /**
  * Type for the individual array items in v2 of the API for the lunch functionality endpoint.
  */

package/dist/v2/notificationPreference.d.ts

@@ -1,3 +1,37 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the notification preference endpoint.
+ */
+export type ApiV2NotificationPreferenceType = {
+    /**
+     * Whether or not the notifications are active. We keep this as a separate value to allow users to keep their preferences after toggling notifications off and then on (as deleting it and re-adding it would mean data loss for any future properties/columns we choose to save on this class).
+     */
+    active: boolean;
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Timestamp for when the user was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the restaurant that we want to send notifications for.
+     */
+    restaurantId: number;
+    /**
+     * ID of the user to send notifications to. Note that this isn't used to send the actual notifications, that part is handled by device registration tokens that the user gets from Firebase if they do indeed opt in to push notifications. Note that those are indeed opt-in, and just because we have a notification preference here it does NOT necessarily mean we actually have any registration tokens to send the notifications to.
+     */
+    userId: number;
+};
+/**
+ * The API response type for notification preferences.
+ */
+export type ApiV2NotificationPreferenceResponseType = ApiV2BaseResponseType<ApiV2NotificationPreferenceType[], number>;
 /**
  * API endpoint slug.
  */

package/dist/v2/policy.d.ts

@@ -1,3 +1,33 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the policy endpoint.
+ */
+export type ApiV2PolicyType = {
+    /**
+     * String representation of when the policy was last created.
+     */
+    created: string;
+    /**
+     * Unique ID for the policy.
+     */
+    id: number;
+    /**
+     * String representation of when the policy was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Actual policy text.
+     */
+    policyText: string;
+    /**
+     * Date stamp for when the policy is valid from.
+     */
+    validFrom: string;
+};
+/**
+ * The API response type for policys.
+ */
+export type ApiV2PolicyResponseType = ApiV2BaseResponseType<ApiV2PolicyType[], number>;
 /**
  * API endpoint slug.
  */

package/dist/v2/restaurantFunctionality.d.ts

@@ -0,0 +1,25 @@
+/**
+ *
+ */
+export type ApiV2RestaurantFunctionalityType = {
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * String representation of the last time the entity was updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the functionality visibility type for the functionality.
+     */
+    restaurantFunctionalityVisibilityTypeId: 1 | 2 | 3 | 4;
+    /**
+     * Restaurant ID the functionality relates to.
+     */
+    restaurantId: number;
+};

package/dist/v2/showcaseLocation.d.ts

@@ -23,4 +23,4 @@ export type ApiV2ShowcaseLocationResponseType = ApiV2BaseResponseType<ApiV2Showc
 /**
  * API endpoint slug.
  */
-export declare const apiV2ShowcaseLocationApiEndpointSlug = "showcase-locations";
+export declare const apiV2ShowcaseLocationApiEndpointSlug = "showcase-location-lists";

package/dist/v2/userLocation.d.ts

@@ -0,0 +1,17 @@
+/**
+ *
+ */
+export type ApiV2UserLocationType = {
+    /**
+     * @see {@link EntityLocation.endpoint}.
+     */
+    cityId: number;
+    /**
+     * @see {@link EntityLocation.items}.
+     */
+    lastUpdated: string;
+    /**
+     * @see {@link EntityLocation.endpoint}.
+     */
+    userId: number;
+};

package/dist/v3/bonusStamp.d.ts

@@ -0,0 +1,5 @@
+import { ApiV2BonusStampType } from '../v2/bonusStamp';
+/**
+ *
+ */
+export type ApiV3BonusStampType = ApiV2BonusStampType;

package/dist/v3/bonusStampCode.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2BonusStampCodeType } from '../v2/bonusStampCode';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2BonusStampCodeApiEndpointSlug as apiV3BonusStampCodeApiEndpointSlug } from '../v2/bonusStampCode';
+/**
+ * Type for the individual array items in v3 of the API for the bonus stamp code endpoint.
+ */
+export type ApiV3BonusStampCodeType = ApiV2BonusStampCodeType;
+/**
+ * The API response type for bonus stamp code items.
+ */
+export type ApiV3BonusStampCodeResponseType = ApiV3BaseResponseType<ApiV3BonusStampCodeType[], number>;

package/dist/v3/cateringFunctionality.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2CateringFunctionalityType } from '../v2/cateringFunctionality';
+export { apiV2CateringFunctionalityApiEndpointSlug as apiV3CateringFunctionalityApiEndpointSlug } from '../v2/cateringFunctionality';
+/**
+ * Type for the individual array items in v3 of the API for the catering functionality endpoint.
+ */
+export type ApiV3CateringFunctionalityType = ApiV2CateringFunctionalityType;
+/**
+ * The API response type for catering functionality.
+ */
+export type ApiV3CateringFunctionalityResponseType = ApiV2BaseResponseType<ApiV3CateringFunctionalityType[], number>;

package/dist/v3/city.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2CityType } from '../v2/city';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2CityApiEndpointSlug as apiV3CityApiEndpointSlug } from '../v2/city';
+/**
+ * Type for the individual array items in v3 of the API for the city endpoint.
+ */
+export type ApiV3CityType = ApiV2CityType;
+/**
+ * The API response type for city items.
+ */
+export type ApiV3CityResponseType = ApiV3BaseResponseType<ApiV3CityType[], number>;

package/dist/v3/cityUploadConnection.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2CityUploadConnectionType } from '../v2/cityUploadConnection';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2CityUploadConnectionApiEndpointSlug as apiV3CityUploadConnectionApiEndpointSlug } from '../v2/cityUploadConnection';
+/**
+ * Type for the individual array items in v3 of the API for the city upload connection endpoint.
+ */
+export type ApiV3CityUploadConnectionType = ApiV2CityUploadConnectionType;
+/**
+ * The API response type for city upload connection items.
+ */
+export type ApiV3UCityUploadConnectionResponseType = ApiV3BaseResponseType<ApiV3CityUploadConnectionType[], number>;

package/dist/v3/coupon.d.ts

@@ -0,0 +1,17 @@
+import type { ApiV2CouponType } from '../v2/coupon';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+import type { ApiV3CouponLocationType } from '../v3/couponLocation';
+export { apiV2CouponApiEndpointSlug as apiV3CouponApiEndpointSlug } from '../v2/coupon';
+/**
+ * Type for the individual array items in v3 of the API for the coupon endpoint.
+ */
+export type ApiV3CouponType = ApiV2CouponType & {
+    /**
+     * List of locations where the coupon should be displayed.
+     */
+    couponLocationList: ApiV3CouponLocationType[];
+};
+/**
+ * The API response type for coupon items.
+ */
+export type ApiV3CouponResponseType = ApiV3BaseResponseType<ApiV3CouponType[], number>;

package/dist/v3/couponLocation.d.ts

@@ -0,0 +1,30 @@
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+/**
+ * Type for the individual array items in v3 of the API for the coupon location endpoint.
+ */
+export type ApiV3CouponLocationType = {
+    /**
+     * City ID for the location.
+     */
+    cityId: number;
+    /**
+     * ID of the coupon the location represents.
+     */
+    couponId: number;
+    /**
+     * Unique ID for the coupon location.
+     */
+    id: number;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+};
+/**
+ * The API response type for coupon location items.
+ */
+export type ApiV3CouponLocationResponseType = ApiV3BaseResponseType<ApiV3CouponLocationType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3CouponLocationApiEndpointSlug = "coupon-locations";

package/dist/v3/customer.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2CustomerType } from '../v2/customer';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2CustomerApiEndpointSlug as apiV3CustomerApiEndpointSlug } from '../v2/customer';
+/**
+ * Type for the individual array items in v3 of the API for the customer endpoint.
+ */
+export type ApiV3CustomerType = ApiV2CustomerType;
+/**
+ * The API response type for customer items.
+ */
+export type ApiV3CustomerResponseType = ApiV3BaseResponseType<ApiV3CustomerType[], number>;

package/dist/v3/customerManagement.d.ts

@@ -0,0 +1,34 @@
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+/**
+ * Type for the individual array items in v3 of the API for the customer management endpoint.
+ */
+export type ApiV3CustomerManagementType = {
+    /**
+     * String representation of when the entity relation was created.
+     */
+    created: string;
+    /**
+     * Customer ID.
+     */
+    customerId: number;
+    /**
+     * Unique ID for the customer management.
+     */
+    id: number;
+    /**
+     * String representation of when the entity relation was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * User ID.
+     */
+    userId: number;
+};
+/**
+ * The API response type for customer management items.
+ */
+export type ApiV3CustomerManagementResponseType = ApiV3BaseResponseType<ApiV3CustomerManagementType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3CustomerManagementApiEndpointSlug = "customer-management";

package/dist/v3/dinnerFunctionality.d.ts

@@ -0,0 +1,17 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2DinnerFunctionalityType } from '../v2/dinnerFunctionality';
+import type { ApiV3OpeningHourType } from '../v3/openingHour';
+export { apiV2DinnerFunctionalityApiEndpointSlug as apiV3DinnerFunctionalityApiEndpointSlug } from '../v2/dinnerFunctionality';
+/**
+ * Type for the individual array items in v3 of the API for the dinner functionality endpoint.
+ */
+export type ApiV3DinnerFunctionalityType = Omit<ApiV2DinnerFunctionalityType, 'openingHourList'> & {
+    /**
+     * List of opening hours for the dinner.
+     */
+    openingHourList: ApiV3OpeningHourType[];
+};
+/**
+ * The API response type for dinner functionality.
+ */
+export type ApiV3DinnerFunctionalityResponseType = ApiV2BaseResponseType<ApiV3DinnerFunctionalityType[], number>;

package/dist/v3/dinnerFunctionalityType.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2DinnerFunctionalityTypeType } from '../v2/dinnerFunctionalityType';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2DinnerFunctionalityTypeApiEndpointSlug as apiV3DinnerFunctionalityTypeApiEndpointSlug } from '../v2/dinnerFunctionalityType';
+/**
+ * Type for the individual array items in v3 of the API for the dinner functionality type endpoint.
+ */
+export type ApiV3DinnerFunctionalityTypeType = ApiV2DinnerFunctionalityTypeType;
+/**
+ * The API response type for dinner functionality type items.
+ */
+export type ApiV3DinnerFunctionalityTypeResponseType = ApiV3BaseResponseType<ApiV3DinnerFunctionalityTypeType[], number>;