@matochmat/api-client 2.0.0-next.8 → 2.0.0

package/dist/v3/notificationPreference.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2NotificationPreferenceType } from '../v2/notificationPreference';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2NotificationPreferenceApiEndpointSlug as apiV3NotificationPreferenceApiEndpointSlug } from '../v2/notificationPreference';
+/**
+ * Type for the individual array items in v3 of the API for the notification preference endpoint.
+ */
+export type ApiV3NotificationPreferenceType = ApiV2NotificationPreferenceType;
+/**
+ * The API response type for notification preference items.
+ */
+export type ApiV3NotificationPreferenceResponseType = ApiV3BaseResponseType<ApiV3NotificationPreferenceType[], number>;

package/dist/v3/policy.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2PolicyType } from '../v2/policy';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2PolicyApiEndpointSlug as apiV3PolicyApiEndpointSlug } from '../v2/policy';
+/**
+ * Type for the individual array items in v3 of the API for the policy endpoint.
+ */
+export type ApiV3PolicyType = ApiV2PolicyType;
+/**
+ * The API response type for policy items.
+ */
+export type ApiV3PolicyResponseType = ApiV3BaseResponseType<ApiV3PolicyType[], number>;

package/dist/v3/restaurant.d.ts

@@ -0,0 +1,34 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2RestaurantType } from '../v2/restaurant';
+import type { ApiV3CateringFunctionalityType } from '../v3/cateringFunctionality';
+import type { ApiV3DinnerFunctionalityType } from '../v3/dinnerFunctionality';
+import type { ApiV3LunchBoxFunctionalityType } from '../v3/lunchBoxFunctionality';
+import type { ApiV3LunchFunctionalityType } from '../v3/lunchFunctionality';
+export { apiV2RestaurantApiEndpointSlug as apiV3RestaurantApiEndpointSlug } from '../v2/restaurant';
+/**
+ * Type for the individual array items in v3 of the API for the restaurant endpoint.
+ * NOTE: This is currently marked "internal" (not really, but treat it as if it were) since the interface is actively undergoing change to a modernized structures. It is very much a WIP and should be treated as such. Breaking changes to this not only can, but **will**, occur.
+ * @internal
+ */
+export type ApiV3RestaurantType = Omit<ApiV2RestaurantType, 'cateringFunctionality' | 'dinnerFunctionality' | 'lunchBoxFunctionality' | 'lunchFunctionality'> & {
+    /**
+     *
+     */
+    cateringFunctionality: ApiV3CateringFunctionalityType;
+    /**
+     *
+     */
+    dinnerFunctionality: ApiV3DinnerFunctionalityType;
+    /**
+     *
+     */
+    lunchBoxFunctionality: ApiV3LunchBoxFunctionalityType;
+    /**
+     *
+     */
+    lunchFunctionality: ApiV3LunchFunctionalityType;
+};
+/**
+ * The API response type for restaurant.
+ */
+export type ApiV3RestaurantResponseType = ApiV2BaseResponseType<ApiV3RestaurantType[], number>;

package/dist/v3/restaurantFunctionality.d.ts

@@ -0,0 +1,5 @@
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionality';
+/**
+ *
+ */
+export type ApiV3RestaurantFunctionalityType = ApiV2RestaurantFunctionalityType;

package/dist/v3/restaurantManagement.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 restaurant management endpoint.
+ */
+export type ApiV3RestaurantManagementType = {
+    /**
+     * String representation of when the entity relation was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the restaurant management.
+     */
+    id: number;
+    /**
+     * String representation of when the entity relation was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Restaurant ID.
+     */
+    restaurantId: number;
+    /**
+     * User ID.
+     */
+    userId: number;
+};
+/**
+ * The API response type for restaurant management items.
+ */
+export type ApiV3RestaurantManagementResponseType = ApiV3BaseResponseType<ApiV3RestaurantManagementType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3RestaurantManagementApiEndpointSlug = "restaurant-management";

package/dist/v3/restaurantRegistration.d.ts

@@ -0,0 +1,62 @@
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+/**
+ * Type for the individual array items in v3 of the API for the restaurant registration endpoint.
+ */
+export type ApiV3RestaurantRegistrationType = {
+    /**
+     *
+     */
+    additionalInfoStepCompleted: boolean;
+    /**
+     *
+     */
+    citySelectionStepCompleted: boolean;
+    /**
+     *
+     */
+    createAccountStepCompleted: boolean;
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     *
+     */
+    createRestaurantStepCompleted: boolean;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * String representation of when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the city the restaurant should be registered in.
+     */
+    restaurantCityId: number | null;
+    /**
+     * ID of the restaurant which the registration concerns.
+     */
+    restaurantId: number | null;
+    /**
+     *
+     */
+    restaurantRegistrationStateId: number;
+    /**
+     * Token to allow resuming an abandoned registration.
+     */
+    resumeToken: string;
+    /**
+     * ID of the user which the registration concerns.
+     */
+    userId: number | null;
+};
+/**
+ * The API response type for restaurant registration items.
+ */
+export type ApiV3RestaurantRegistrationResponseType = ApiV3BaseResponseType<ApiV3RestaurantRegistrationType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3RestaurantRegistrationApiEndpointSlug = "restaurant-registrations";

package/dist/v3/restaurantRegistrationState.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 restaurant registration state endpoint.
+ */
+export type ApiV3RestaurantRegistrationStateType = {
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * String representation of when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Human readable name of the state.
+     */
+    name: string;
+};
+/**
+ * The API response type for restaurant registration state items.
+ */
+export type ApiV3RestaurantRegistrationStateResponseType = ApiV3BaseResponseType<ApiV3RestaurantRegistrationStateType[], number>;
+/**
+ * API endpoint slug.
+ */
+export declare const apiV3RestaurantRegistrationStateApiEndpointSlug = "restaurant-registration-states";

package/dist/v3/restaurantUploadConnection.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2RestaurantUploadConnectionType } from '../v2/restaurantUploadConnection';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2RestaurantUploadConnectionApiEndpointSlug as apiV3RestaurantUploadConnectionApiEndpointSlug } from '../v2/restaurantUploadConnection';
+/**
+ * Type for the individual array items in v3 of the API for the restaurant upload connection endpoint.
+ */
+export type ApiV3RestaurantUploadConnectionType = ApiV2RestaurantUploadConnectionType;
+/**
+ * The API response type for restaurant upload connection items.
+ */
+export type ApiV3URestaurantUploadConnectionResponseType = ApiV3BaseResponseType<ApiV3RestaurantUploadConnectionType[], number>;

package/dist/v3/session.d.ts

@@ -0,0 +1 @@
+export { apiV2SessionApiEndpointSlug as apiV3SessionApiEndpointSlug } from '../v2/session';

package/dist/v3/showcaseUserRoleConnection.d.ts

@@ -16,11 +16,11 @@ export type ApiV3ShowcaseUserRoleConnectionType = {
      */
     lastUpdated: string;
     /**
-     * Showcase ID (first entity).
+     * Showcase ID.
      */
     showcaseId: number;
     /**
-     * User role ID (second entity).
+     * User role ID.
      */
     userRoleId: number;
 };

package/dist/v3/subscriptionPeriod.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2SubscriptionPeriodType } from '../v2/subscriptionPeriod';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2SubscriptionPeriodApiEndpointSlug as apiV3SubscriptionPeriodApiEndpointSlug } from '../v2/subscriptionPeriod';
+/**
+ * Type for the individual array items in v3 of the API for the subscription period endpoint.
+ */
+export type ApiV3SubscriptionPeriodType = ApiV2SubscriptionPeriodType;
+/**
+ * The API response type for subscription period items.
+ */
+export type ApiV3SubscriptionPeriodResponseType = ApiV3BaseResponseType<ApiV3SubscriptionPeriodType[], number>;

package/dist/v3/systemSetting.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2SystemSettingType } from '../v2/systemSetting';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2SystemSettingApiEndpointSlug as apiV3SystemSettingApiEndpointSlug } from '../v2/systemSetting';
+/**
+ * Type for the individual array items in v3 of the API for the system setting endpoint.
+ */
+export type ApiV3SystemSettingType<T = unknown> = ApiV2SystemSettingType<T>;
+/**
+ * The API response type for system setting items.
+ */
+export type ApiV3SystemSettingResponseType = ApiV3BaseResponseType<ApiV3SystemSettingType[], number>;

package/dist/v3/updatedByType.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2UpdatedByTypeType } from '../v2/updatedByType';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+export { apiV2UpdatedByTypeApiEndpointSlug as apiV3UpdatedByTypeApiEndpointSlug } from '../v2/updatedByType';
+/**
+ * Type for the individual array items in v3 of the API for the updated by type endpoint.
+ */
+export type ApiV3UpdatedByTypeType = ApiV2UpdatedByTypeType;
+/**
+ * The API response type for updated by type items.
+ */
+export type ApiV3UpdatedByTypeResponseType = ApiV3BaseResponseType<ApiV3UpdatedByTypeType[], number>;

package/dist/v3/user.d.ts

@@ -0,0 +1,66 @@
+import type { ApiV1BonusStampType } from '../v1/bonusStamp';
+import type { ApiV1FavoriteType } from '../v1/favorite';
+import type { ApiV3BaseResponseType } from '../v3/baseResponse';
+import type { ApiV3NotificationPreferenceType } from '../v3/notificationPreference';
+export { apiV2UserApiEndpointSlug as apiV3UserApiEndpointSlug } from '../v2/user';
+/**
+ * Type for the individual array items in v3 of the API for the block content endpoint.
+ */
+export type ApiV3UserType = {
+    /**
+     * List of bonus stamps the user has collected.
+     */
+    bonusStampList: ApiV1BonusStampType[];
+    /**
+     * Whether or not the user has accepted campaign and news communications.
+     */
+    campaignAndNewsCommunicationsAccepted: boolean;
+    /**
+     * String representation of when the restaurant was created.
+     */
+    created: null | string;
+    /**
+     * Email address for the user. Also used as user name when logging in.
+     */
+    email: string;
+    /**
+     * List of restaurant favorite info for restaurants user has marked as favorites.
+     */
+    favoriteList: ApiV1FavoriteType[];
+    /**
+     * User's first name. Also commonly used as display name.
+     */
+    firstName: string;
+    /**
+     * Unique entity ID.
+     */
+    id: number;
+    /**
+     * User's last name.
+     */
+    lastName: string;
+    /**
+     * String representation of the last time user was updated.
+     */
+    lastUpdated: string;
+    /**
+     * List of user notification preferences.
+     */
+    notificationPreferenceList: ApiV3NotificationPreferenceType[];
+    /**
+     * Temporary holder on password change before form submission. Note that this isn't actually ever present other than when temporarily set by the client from input data that and gets cleared immediately after form submission (and isn't even preserved if the form isn't submitted), meaning that you can never rely on this even being populated at all (because why would it be, that would be a huge security issue?).
+     */
+    password?: string;
+    /**
+     * User's phone number.
+     */
+    phone: string;
+    /**
+     * User role.
+     */
+    userRoleId: number;
+};
+/**
+ * The API response type for user items.
+ */
+export type ApiV3UserResponseType = ApiV3BaseResponseType<ApiV3UserType[], number>;

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.8",
+  "version": "2.0.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -40,6 +40,7 @@
     "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",
@@ -48,7 +49,7 @@
     "typescript": "^5.6.2"
   },
   "scripts": {
-    "build": "tsx scripts/generateMainIndexFile.ts && rollup -c && tsc-alias -p ./tsconfig.json",
+    "build": "rimraf ./dist/* && 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/v2/cityUploadGrouping.d.ts

@@ -1,3 +0,0 @@
-import type { ApiV2CityUploadConnectionType } from '../v2/cityUploadConnection';
-import type { ApiV2UploadGroupingType } from '../v2/uploadGrouping';
-export type ApiV2CityUploadGroupingType = ApiV2UploadGroupingType<ApiV2CityUploadConnectionType>;

package/dist/v2/customer.d.ts

@@ -1,4 +0,0 @@
-/**
- * API endpoint slug for the entity.
- */
-export declare const apiV2CustomerApiEndpointSlug = "customers";

package/dist/v2/customerContact.d.ts

@@ -1,4 +0,0 @@
-/**
- * API endpoint slug.
- */
-export declare const apiV2CustomerContactApiEndpointSlug = "customer-contacts";

package/dist/v2/customerManagemement.d.ts

@@ -1,4 +0,0 @@
-/**
- * API endpoint slug.
- */
-export declare const apiV2CustomerManagementApiEndpointSlug = "customer-management";

package/dist/v2/customerQuoteUploadGrouping.d.ts

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

package/dist/v2/dynamicContent.d.ts

@@ -1,30 +0,0 @@
-import type { ApiV2BaseResponseType } from '../v2/baseResponse';
-/**
- * Type for the individual array items in v2 of the API for the dynamic content endpoint.
- */
-export type ApiV2DynamicContentType = {
-    /**
-     * Data for the dynamic content instance.
-     */
-    data: string;
-    /**
-     * Unique ID for the entity.
-     */
-    id: number;
-    /**
-     * TImestamp for when the entity was last updated.
-     */
-    lastUpdated: string;
-    /**
-     * ID of the user that the entity belongs to.
-     */
-    userId: number;
-};
-/**
- * The API response type for dynamic content.
- */
-export type ApiV2DynamicContentResponseType = ApiV2BaseResponseType<ApiV2DynamicContentType[], number>;
-/**
- * API endpoint slug.
- */
-export declare const apiV2DynamicContentApiEndpointSlug = "dynamic-content";

package/dist/v2/geodata.d.ts

@@ -1,34 +0,0 @@
-export type ApiV2GeodataType = {
-    /**
-     * Timestamp for when the entity was created.
-     */
-    created: string;
-    /**
-     * Unique ID for the entity.
-     */
-    id: number;
-    /**
-     * Timestamp for when the entity was last updated.
-     */
-    lastUpdated: string;
-    /**
-     *
-     */
-    latitude: string;
-    /**
-     *
-     */
-    longitude: string;
-    /**
-     *
-     */
-    restaurantId: number;
-    /**
-     * The URL for the static map image.
-     */
-    staticMapImageUrl: string;
-};
-/**
- * API endpoint slug.
- */
-export declare const apiV2GeodataApiEndpointSlug = "geodata";

package/dist/v2/restaurantFunctionalityVisitibilityType.d.ts

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

package/dist/v2/restaurantUploadGrouping.d.ts

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

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

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

package/dist/v2/showcaseUserRoleConnection.d.ts

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

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

@@ -1,11 +0,0 @@
-import type { ApiV2GeodataType } from '../v2/geodata';
-import type { ApiV3BaseResponseType } from '../v3/baseResponse';
-export { apiV2GeodataApiEndpointSlug as apiV3GeodataApiEndpointSlug } from '../v2/geodata';
-/**
- * Type for the individual array items in v3 of the API for the geodata endpoint.
- */
-export type ApiV3GeodataType = ApiV2GeodataType;
-/**
- * The API response type for geodata items.
- */
-export type ApiV3GeodataResponseType = ApiV3BaseResponseType<ApiV3GeodataType[], number>;