@matochmat/api-client 2.0.0-next.24 → 2.0.0-next.4

package/dist/v2/customer.d.ts

@@ -1,73 +1,3 @@
-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/customerContact.d.ts

@@ -1,45 +1,3 @@
-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 = {
-    /**
-     * Whether or not the contact is active.
-     */
-    active: boolean;
-    /**
-     * 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/customerQuoteUploadGrouping.d.ts

@@ -0,0 +1,3 @@
+import type { ApiV2CustomerQuoteUploadConnectionType } from '../v2/customerQuoteUploadConnection';
+import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
+export type ApiV2CustomerQuoteUploadGroupingType = ApiV2UploadGroupingType<ApiV2CustomerQuoteUploadConnectionType>;

package/dist/v2/dinnerFunctionality.d.ts

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

package/dist/v2/emailTemplate.d.ts

@@ -1,53 +1,3 @@
-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/lunchBoxFunctionality.d.ts

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

package/dist/v2/notificationPreference.d.ts

@@ -1,37 +1,3 @@
-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,33 +1,3 @@
-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,10 +6,9 @@ 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 { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
+import type { ApiV2RestaurantUploadGroupingType } from '../v2/restaurantUploadGrouping';
 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.
  */
@@ -53,16 +52,7 @@ export type ApiV2RestaurantType = {
     /**
      * Background for the restaurant details page header.
      */
-    detailsPageHeaderBackground: {
-        /**
-         * The upload connection between the restaurant and the upload.
-         */
-        restaurantUpload: ApiV2RestaurantUploadConnectionType;
-        /**
-         * Information about the actual upload.
-         */
-        upload: ApiV2UploadType;
-    };
+    detailsPageHeaderBackground: ApiV2RestaurantUploadGroupingType;
     /**
      *
      */
@@ -98,42 +88,15 @@ export type ApiV2RestaurantType = {
     /**
      * Background for the restaurant logotype.
      */
-    logotypeBackground: {
-        /**
-         * The upload connection between the restaurant and the upload.
-         */
-        restaurantUpload: ApiV2RestaurantUploadConnectionType;
-        /**
-         * Information about the actual upload.
-         */
-        upload: ApiV2UploadType;
-    };
+    logotypeBackground: ApiV2RestaurantUploadGroupingType;
     /**
      * Restaurant logotype info for the logotype to display on image backgrounds.
      */
-    logotypeForImageBackground: {
-        /**
-         * The upload connection between the restaurant and the upload.
-         */
-        restaurantUpload: ApiV2RestaurantUploadConnectionType;
-        /**
-         * Information about the actual upload.
-         */
-        upload: ApiV2UploadType;
-    };
+    logotypeForImageBackground: ApiV2RestaurantUploadGroupingType;
     /**
      * Restaurant logotype info for the logotype to display on white backgrounds.
      */
-    logotypeForWhiteBackground: {
-        /**
-         * The upload connection between the restaurant and the upload.
-         */
-        restaurantUpload: ApiV2RestaurantUploadConnectionType;
-        /**
-         * Information about the actual upload.
-         */
-        upload: ApiV2UploadType;
-    };
+    logotypeForWhiteBackground: ApiV2RestaurantUploadGroupingType;
     /**
      *
      */

package/dist/v2/restaurantFunctionalityVisitibilityType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * API endpoint slug.
+ */
+export declare const apiV2RestaurantFunctionalityVisibilityTypeApiEndpointSlug = "restaurant-functionality-visibility-types";

package/dist/v2/restaurantUploadGrouping.d.ts

@@ -0,0 +1,7 @@
+import type { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
+import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
+export type ApiV2RestaurantUploadGroupingType = ApiV2UploadGroupingType<ApiV2RestaurantUploadConnectionType>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV2RestaurantUploadGroupingApiEndpointSlug = "restaurant-upload-groupings";

package/dist/v2/showcaseLocation.d.ts

@@ -0,0 +1,26 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the showcase locations endpoint.
+ */
+export type ApiV2ShowcaseLocationType = {
+    /**
+     * City ID for the location.
+     */
+    cityId: number;
+    /**
+     * Entity ID for the location.
+     */
+    entityId: number;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+};
+/**
+ * The API response type for showcase locations.
+ */
+export type ApiV2ShowcaseLocationResponseType = ApiV2BaseResponseType<ApiV2ShowcaseLocationType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV2ShowcaseLocationApiEndpointSlug = "showcase-location-lists";

package/dist/v2/showcaseUploadGrouping.d.ts

@@ -0,0 +1,3 @@
+import type { ApiV2ShowcaseUploadConnectionType } from '../v2/showcaseUploadConnection';
+import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
+export type ApiV2ShowcaseUploadGroupingType = ApiV2UploadGroupingType<ApiV2ShowcaseUploadConnectionType>;

package/dist/v2/showcaseUserRoleConnection.d.ts

@@ -0,0 +1,30 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the showcase user role connections endpoint.
+ */
+export type ApiV2ShowcaseUserRoleConnectionType = {
+    /**
+     * String representation of when the entity relation was created.
+     */
+    created: string;
+    /**
+     * String representation of when the entity relation was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Showcase ID (first entity).
+     */
+    showcaseId: number;
+    /**
+     * User role ID (second entity).
+     */
+    userRoleId: number;
+};
+/**
+ * The API response type for showcase user role connections.
+ */
+export type ApiV2ShowcaseUserRoleConnectionResponseType = ApiV2BaseResponseType<ApiV2ShowcaseUserRoleConnectionType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV2ShowcaseUserRoleConnectionApiEndpointSlug = "showcase-user-role-connections";

package/dist/v2/upload.d.ts

@@ -31,10 +31,6 @@ 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/uploadGrouping.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2UploadType } from '../v2/upload';
+export type ApiV2UploadGroupingType<T> = {
+    /**
+     * Upload instance. This represents the actual uploaded file.
+     */
+    upload: ApiV2UploadType;
+    /**
+     * Upload connection. This is the relation entity between the uploaded file and another entity.
+     */
+    uploadConnection: T;
+};

package/dist/v3/lunchFunctionality.d.ts

@@ -1,7 +1,6 @@
 import type { ApiV2BaseResponseType } from '../v2/baseResponse';
 import type { ApiV2LunchFunctionalityType } from '../v2/lunchFunctionality';
 import type { ApiV3OpeningHourType } from '../v3/openingHour';
-export { apiV2LunchFunctionalityApiEndpointSlug as apiV3LunchFunctionalityApiEndpointSlug } from '../v2/lunchFunctionality';
 /**
  * Type for the individual array items in v3 of the API for the lunch functionality endpoint.
  */

package/dist/v3/showcaseUserRoleConnection.d.ts

@@ -7,20 +7,16 @@ export type ApiV3ShowcaseUserRoleConnectionType = {
      * String representation of when the entity relation was created.
      */
     created: string;
-    /**
-     * Unique ID for the showcase user role connection.
-     */
-    id: number;
     /**
      * String representation of when the entity relation was last updated.
      */
     lastUpdated: string;
     /**
-     * Showcase ID.
+     * Showcase ID (first entity).
      */
     showcaseId: number;
     /**
-     * User role ID.
+     * User role ID (second entity).
      */
     userRoleId: number;
 };
@@ -31,4 +27,4 @@ export type ApiV3ShowcaseUserRoleConnectionResponseType = ApiV3BaseResponseType<
 /**
  * API endpoint slug.
  */
-export declare const apiV3ShowcaseUserRoleConnectionApiEndpointSlug = "showcase-user-role-connections";
+export declare const apiV3ShowcaseUserRoleConnectionsApiEndpointSlug = "showcase-user-role-connections";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@matochmat/api-client",
   "description": "API types and helper functionality for the Mat och Mat API.",
-  "version": "2.0.0-next.24",
+  "version": "2.0.0-next.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -40,7 +40,6 @@
     "eslint-plugin-jsdoc": "^50.3.1",
     "eslint-plugin-sort-destructure-keys": "^2.0.0",
     "eslint-plugin-sort-imports-es6-autofix": "^0.6.0",
-    "rimraf": "^6.0.1",
     "rollup": "^4.24.4",
     "standard-version": "^9.5.0",
     "tsc-alias": "^1.8.10",
@@ -49,7 +48,7 @@
     "typescript": "^5.6.2"
   },
   "scripts": {
-    "build": "rimraf ./dist/* && tsx scripts/generateMainIndexFile.ts && rollup -c && tsc-alias -p ./tsconfig.json",
+    "build": "tsx scripts/generateMainIndexFile.ts && rollup -c && tsc-alias -p ./tsconfig.json",
     "docs:generate": "typedoc 2> /dev/null && git add docs && git commit --no-verify -m 'docs: Autogenerated documentation'",
     "lint": "eslint ./src --ext .ts",
     "release": "( npm whoami || npm login ) && git checkout main && git merge develop --no-ff -m \"chore: Merge branch 'develop' into 'main'\" && npm run build && git add dist src && git commit --no-verify -m 'chore: Built dist files and types'; npm run docs:generate; standard-version --no-verify && git push origin main develop --tags && npm publish --access public && npm run update-next-tag && git checkout develop && git merge main --ff-only",

package/dist/v1/bonusStamp.d.ts

@@ -1,21 +0,0 @@
-/**
- *
- */
-export type ApiV1BonusStampType = {
-    /**
-     * When the stamp was last updated.
-     */
-    lastUpdated: string;
-    /**
-     * Restaurant ID of the restaurant where stamps are valid.
-     */
-    restaurantId: number;
-    /**
-     * Current number of stamps.
-     */
-    stampCount: number;
-    /**
-     * User ID of the user the stamps belong to.
-     */
-    userId: number;
-};

package/dist/v1/favorite.d.ts

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

package/dist/v2/subscriptionType.d.ts

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

package/dist/v2/userLocation.d.ts

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

package/dist/v3/bonusStampCode.d.ts

@@ -1,11 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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/cityUploadConnection.d.ts

@@ -1,11 +0,0 @@
-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>;