@matochmat/api-client 2.0.0-next.3 → 2.0.0-next.30

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,69 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the customer endpoint.
+ */
+export type ApiV2CustomerType = {
+    /**
+     * 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/customerContact.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 customer contact endpoint.
+ */
+export type ApiV2CustomerContactType = {
+    /**
+     * ID of the customer the contact belongs to.
+     */
+    customerId: number;
+    /**
+     * Email address of the contact.
+     */
+    emailAddress: string;
+    /**
+     * First name of the contact.
+     */
+    firstName: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Last name of the contact.
+     */
+    lastName: string;
+    /**
+     * Timestamp for when the entity eas last udpated.
+     */
+    lastUpdated: string;
+    /**
+     * Phone number of the contact.
+     */
+    phoneNumber: string;
+};
+/**
+ * The API response type for customer contacts.
+ */
+export type ApiV2CustomerContactResponseType = ApiV2BaseResponseType<ApiV2CustomerContactType[], number>;
 /**
  * API endpoint slug.
  */

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/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/restaurant.d.ts

@@ -6,9 +6,10 @@ import type { ApiV2DinnerFunctionalityType } from '../v2/dinnerFunctionality';
 import type { ApiV2GeodataType } from '../v2/geodata';
 import type { ApiV2LunchBoxFunctionalityType } from '../v2/lunchBoxFunctionality';
 import type { ApiV2LunchFunctionalityType } from '../v2/lunchFunctionality';
-import type { ApiV2RestaurantUploadGroupingType } from '../v2/restaurantUploadGrouping';
+import type { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
 import type { ApiV2TableBookingType } from '../v2/tableBooking';
 import type { ApiV2TakeAwayType } from '../v2/takeAway';
+import type { ApiV2UploadType } from '../v2/upload';
 /**
  * Type for the individual array items in v2 of the API for the restaurant endpoint.
  */
@@ -52,7 +53,16 @@ export type ApiV2RestaurantType = {
     /**
      * Background for the restaurant details page header.
      */
-    detailsPageHeaderBackground: ApiV2RestaurantUploadGroupingType;
+    detailsPageHeaderBackground: {
+        /**
+         * The upload connection between the restaurant and the upload.
+         */
+        restaurantUpload: ApiV2RestaurantUploadConnectionType;
+        /**
+         * Information about the actual upload.
+         */
+        upload: ApiV2UploadType;
+    };
     /**
      *
      */
@@ -88,15 +98,42 @@ export type ApiV2RestaurantType = {
     /**
      * Background for the restaurant logotype.
      */
-    logotypeBackground: ApiV2RestaurantUploadGroupingType;
+    logotypeBackground: {
+        /**
+         * The upload connection between the restaurant and the upload.
+         */
+        restaurantUpload: ApiV2RestaurantUploadConnectionType;
+        /**
+         * Information about the actual upload.
+         */
+        upload: ApiV2UploadType;
+    };
     /**
      * Restaurant logotype info for the logotype to display on image backgrounds.
      */
-    logotypeForImageBackground: ApiV2RestaurantUploadGroupingType;
+    logotypeForImageBackground: {
+        /**
+         * The upload connection between the restaurant and the upload.
+         */
+        restaurantUpload: ApiV2RestaurantUploadConnectionType;
+        /**
+         * Information about the actual upload.
+         */
+        upload: ApiV2UploadType;
+    };
     /**
      * Restaurant logotype info for the logotype to display on white backgrounds.
      */
-    logotypeForWhiteBackground: ApiV2RestaurantUploadGroupingType;
+    logotypeForWhiteBackground: {
+        /**
+         * The upload connection between the restaurant and the upload.
+         */
+        restaurantUpload: ApiV2RestaurantUploadConnectionType;
+        /**
+         * Information about the actual upload.
+         */
+        upload: ApiV2UploadType;
+    };
     /**
      *
      */
@@ -122,7 +159,7 @@ export type ApiV2RestaurantType = {
     /**
      * Determines which version of PDFs to use.
      */
-    pdfVersion: 1 | 2;
+    pdfVersion: 2;
     /**
      * Whether or not the restaurant is pending and awaiting approval.
      */

package/dist/v2/subscriptionType.d.ts

@@ -0,0 +1,13 @@
+/**
+ *
+ */
+export type ApiV2SubscriptionTypeType = {
+    /**
+     * Unique ID for the subscription type.
+     */
+    id: number;
+    /**
+     * Name of the subscription type.
+     */
+    name: string;
+};

package/dist/v2/upload.d.ts

@@ -31,6 +31,10 @@ export type ApiV2UploadType = {
      * Timestamp for when the image was first uploaded.
      */
     uploaded: string;
+    /**
+     * Who uploaded the file.
+     */
+    uploader: number;
 };
 /**
  * API endpoint slug.

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/blockContent.d.ts

@@ -0,0 +1,65 @@
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+import type { ApiV3BlockContentUploadConnectionType } from '../v3/blockContentUploadConnectionType';
+import type { ApiV3UploadType } from '../v3/upload';
+/**
+ * Type for the individual array items in v3 of the API for the block content endpoint.
+ */
+export type ApiV3BlockContentType = {
+    /**
+     * Type ID for which type of block content it is.
+     */
+    blockContentTypeId: 1 | 2 | 3 | 4;
+    /**
+     * JSON with the block data.
+     */
+    blocks: any;
+    /**
+     * Timestamp for when the entity was last created.
+     */
+    created: string;
+    /**
+     * Description of the content to use for metadata.
+     */
+    description: string;
+    /**
+     * Featured image for the content.
+     */
+    featuredImage: {
+        /**
+         * The upload connection between the block content and the upload.
+         */
+        blockContentUpload: ApiV3BlockContentUploadConnectionType;
+        /**
+         * Information about the actual upload.
+         */
+        upload: ApiV3UploadType;
+    };
+    /**
+     * Unique ID for the content.
+     */
+    id: number;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Slug for block content that is displayed as a standalone page.
+     */
+    slug: string;
+    /**
+     * Whether or not the slug is "locked", meaning it should be treated as non-editable due to some constraint such as being linked to from hardcoded buttons or links.
+     */
+    slugIsLocked: boolean;
+    /**
+     * Title for block content that is displayed as a standalone page.
+     */
+    title: string;
+};
+/**
+ * The API response type for block content items.
+ */
+export type ApiV3BlockContentResponseType = ApiV3BaseResponseType<ApiV3BlockContentType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3BlockContentApiEndpointSlug = "block-content";

package/dist/v3/blockContentUploadConnectionType.d.ts

@@ -0,0 +1,15 @@
+import type { ApiV2UploadConnectionType } from '../v2/uploadConnection';
+export type ApiV3BlockContentUploadConnectionType = ApiV2UploadConnectionType & {
+    /**
+     * ID of the block content the entity belongs to.
+     */
+    blockContentId: number;
+    /**
+     *
+     */
+    blockContentUploadTypeId: number;
+};
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3BlockContentUploadConnectionApiEndpointSlug = "block-content-uploads";

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";