@matochmat/api-client 1.3.3 → 1.3.4

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/v2/crawlingConfigurationTextContentStrategyType.ts"],"sourcesContent":["import type { ApiV2BaseResponseType } from '@matochmat/api-client/src/v2/baseResponse';\n\n/**\n * API endpoint slug.\n */\nexport const apiV2CrawlingConfigurationTextContentStrategyTypeApiEndpointSlug = 'crawling-configuration-text-content-strategy-types';\n\n/**\n * Type for the individual array items in v2 of the API for the crawling configuration text content strategy type endpoint.\n */\nexport type ApiV2CrawlingConfigurationTextContentStrategyTypeType =\n{\n\t/**\n\t * Timestamp for when the entity was created.\n\t */\n\tcreated: string;\n\n\t/**\n\t * Unique ID for the entity.\n\t */\n\tid: 1|2;\n\n\t/**\n\t * Timestamp for when the entity was last updated.\n\t */\n\tlastUpdated: string;\n\n\t/**\n\t * Human readable name.\n\t */\n\tname: string;\n};\n\n/**\n * The API response type for crawling configurations.\n */\nexport type ApiV2CrawlingConfigurationTextContentStrategyTypeResponseType = ApiV2BaseResponseType<ApiV2CrawlingConfigurationTextContentStrategyTypeType[], number>;\n"],"names":[],"mappings":";;AAEA;;AAEG;AACI,MAAM,gEAAgE,GAAG;;;;"}

package/{src/index.ts → dist/index.d.ts}

@@ -1,5 +1,3 @@
-// Auto-generated index.ts file
-
 export * from './v2/baseResponse';
 export * from './v2/cateringFunctionality';
 export * from './v2/city';

package/dist/index.esm.js

@@ -0,0 +1,7 @@
+/**
+ * API endpoint slug.
+ */
+const apiV2CrawlingConfigurationTextContentStrategyTypeApiEndpointSlug = 'crawling-configuration-text-content-strategy-types';
+
+export { apiV2CrawlingConfigurationTextContentStrategyTypeApiEndpointSlug };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/v2/crawlingConfigurationTextContentStrategyType.ts"],"sourcesContent":["import type { ApiV2BaseResponseType } from '@matochmat/api-client/src/v2/baseResponse';\n\n/**\n * API endpoint slug.\n */\nexport const apiV2CrawlingConfigurationTextContentStrategyTypeApiEndpointSlug = 'crawling-configuration-text-content-strategy-types';\n\n/**\n * Type for the individual array items in v2 of the API for the crawling configuration text content strategy type endpoint.\n */\nexport type ApiV2CrawlingConfigurationTextContentStrategyTypeType =\n{\n\t/**\n\t * Timestamp for when the entity was created.\n\t */\n\tcreated: string;\n\n\t/**\n\t * Unique ID for the entity.\n\t */\n\tid: 1|2;\n\n\t/**\n\t * Timestamp for when the entity was last updated.\n\t */\n\tlastUpdated: string;\n\n\t/**\n\t * Human readable name.\n\t */\n\tname: string;\n};\n\n/**\n * The API response type for crawling configurations.\n */\nexport type ApiV2CrawlingConfigurationTextContentStrategyTypeResponseType = ApiV2BaseResponseType<ApiV2CrawlingConfigurationTextContentStrategyTypeType[], number>;\n"],"names":[],"mappings":"AAEA;;AAEG;AACI,MAAM,gEAAgE,GAAG;;;;"}

package/dist/v2/baseResponse.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The base API response type for v2 of the API.
+ */
+export type ApiV2BaseResponseType<DataType, CountType extends null | number> = {
+    /**
+     * Only used for development and can be ignored for other purposes.
+     */
+    buffer: string;
+    /**
+     * Number of items that matched the query where applicable, but may also be `null` for non-standard endpoints which use non-countable responses.
+     */
+    count: CountType;
+    /**
+     * Array of items.
+     */
+    data: DataType;
+    /**
+     * Generic status for the quickly checking the status of API request without needing to check HTTP status codes. This is true if data could be fetched, false if something prevented it from being fetched.
+     */
+    status: boolean;
+};

package/dist/v2/cateringFunctionality.d.ts

@@ -0,0 +1,39 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
+/**
+ * Type for the individual array items in v2 of the API for the catering functionality endpoint.
+ */
+export type ApiV2CateringFunctionalityType = ApiV2RestaurantFunctionalityType & {
+    /**
+     * Number of columns to display catering menu in.
+     */
+    columns: 1 | 2 | 3;
+    /**
+     * Text about catering conditions.
+     */
+    conditionsText: string;
+    /**
+     * Text shown above the menu to provide generic information not directly related to the dishes themselves.
+     */
+    menuText: string;
+    /**
+     * The email address to send catering requests to.
+     */
+    requestEmail: string;
+    /**
+     * Whether or not the restaurant has a catering venue available for hire.
+     */
+    venueAvailable: boolean;
+    /**
+     * Text next to the venue image gallery.
+     */
+    venueText: string;
+    /**
+     * Title shown above the venue text.
+     */
+    venueTextTitle: string;
+};
+/**
+ * The API response type for catering functionality items.
+ */
+export type ApiV2CateringFunctionalityResponseType = ApiV2BaseResponseType<ApiV2CateringFunctionalityType[], number>;

package/dist/v2/city.d.ts

@@ -0,0 +1,102 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2CityUploadGroupingType } from '../v2/cityUploadGrouping';
+import type { ApiV2GeodataType } from '../v2/geodata';
+/**
+ * Type for the individual array items in v2 of the API for the city endpoint.
+ */
+export type ApiV2CityType = {
+    /**
+     * Determines whether the city is active or not.
+     * @deprecated This is no longer in use and you should instead look at the city type.
+     */
+    active: boolean;
+    /**
+     * Determines whether the city has bonus stamp information active or not. Note that this is exactly that, a toggle for INFORMATION only. It does NOT change either visibility or functionality of bonus stamps if a restaurant in the city has them active.
+     */
+    bonusStampsActive: boolean;
+    /**
+     * Marks bonus stamps as recently launched in this city to be able to display slightly different information.
+     */
+    bonusStampsRecentlyLaunched: boolean;
+    /**
+     * Determines whether the city has any catering restaurants active.
+     */
+    cateringFunctionalityActive: boolean;
+    /**
+     * Determines whether the city has any catering restaurants in sales mode.
+     */
+    cateringFunctionalityInSalesMode: boolean;
+    /**
+     * String representation of when the city was created.
+     */
+    created: string;
+    /**
+     * Whether or not the city uses daily lunch tip functionality.
+     */
+    dailyLunchTipActive: boolean;
+    /**
+     * Determines whether the city has any dinner restaurants active.
+     */
+    dinnerFunctionalityActive: boolean;
+    /**
+     * Determines whether the city has any dinner restaurants in sales mode.
+     */
+    dinnerFunctionalityInSalesMode: boolean;
+    /**
+     * Geodata information for the city.
+     * @deprecated
+     */
+    geodata: ApiV2GeodataType;
+    /**
+     * Unique ID for the city.
+     */
+    id: number;
+    /**
+     * Intro text to display on the functionality selection pages.
+     */
+    introText: string;
+    /**
+     * String representation of the last time the city was updated.
+     */
+    lastUpdated: string;
+    /**
+     * Determines whether the city has any lunch box restaurants active.
+     */
+    lunchBoxFunctionalityActive: boolean;
+    /**
+     * Determines whether the city has any lunch box restaurants in sales mode.
+     */
+    lunchBoxFunctionalityInSalesMode: boolean;
+    /**
+     * Determines whether the city has any lunch restaurants active.
+     */
+    lunchFunctionalityActive: boolean;
+    /**
+     * Determines whether the city has any lunch restaurants in sales mode.
+     */
+    lunchFunctionalityInSalesMode: boolean;
+    /**
+     * Readable name of the city.
+     */
+    name: string;
+    /**
+     * Determines whether or not to send a notification to the administrative personnel when a restaurant owner with a restaurant in this city logs in.
+     */
+    notifyWhenRestaurantLogsIn: boolean;
+    /**
+     * Marks city as recently launched to be able to display slightly different information.
+     */
+    recentlyLaunched: boolean;
+    /**
+     * OG image for the city.
+     */
+    sharingImage: ApiV2CityUploadGroupingType;
+    /**
+     * Machine readable name of the city used in URLs among other places.
+     */
+    slug: string;
+};
+/**
+ * The API response type for cities.
+ */
+export type ApiV2CityResponseType = ApiV2BaseResponseType<ApiV2CityType[], number>;

package/dist/v2/cityUploadConnection.d.ts

@@ -0,0 +1,11 @@
+import type { ApiV2UploadConnectionType } from '../v2/uploadConnection';
+export type ApiV2CityUploadConnectionType = ApiV2UploadConnectionType & {
+    /**
+     * City ID upload belongs to.
+     */
+    cityId: number;
+    /**
+     * ID of upload type.
+     */
+    cityUploadTypeId: number;
+};

package/dist/v2/cityUploadGrouping.d.ts

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

package/dist/v2/crawlingConfiguration.d.ts

@@ -0,0 +1,55 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2CrawlingConfigurationTextContentStrategyTypeType } from '../v2/crawlingConfigurationTextContentStrategyType';
+/**
+ * Type for the individual array items in v2 of the API for the crawling configuration endpoint.
+ */
+export type ApiV2CrawlingConfigurationType = {
+    /**
+     * Whether or not the functionality is active.
+     */
+    active: boolean;
+    /**
+     * Additional prompt to send to the data processor.
+     */
+    additionalPrompt: string;
+    /**
+     * Determines if the restaurant should be crawled even if a menu already exists.
+     */
+    crawlEvenIfMenuExists: boolean;
+    /**
+     * Timestamp for when the entity was created.
+     */
+    created: string;
+    /**
+     * Unique ID for crawling configuration functionality.
+     */
+    id: number;
+    /**
+     * Max tokens to use for parsing data.
+     */
+    maxTokens: number;
+    /**
+     * Model to use for parsing data.
+     */
+    model: string;
+    /**
+     * Restaurant ID the functionality relates to.
+     */
+    restaurantId: number;
+    /**
+     * Strategy to use for getting text content.
+     */
+    textContentStrategyTypeId: ApiV2CrawlingConfigurationTextContentStrategyTypeType['id'];
+    /**
+     * URL to crawl.
+     */
+    url: string;
+    /**
+     * Weekdays to crawl on.
+     */
+    weekdays: number[];
+};
+/**
+ * The API response type for crawling configurations.
+ */
+export type ApiV2CrawlingConfigurationResponseType = ApiV2BaseResponseType<ApiV2CrawlingConfigurationType[], number>;

package/dist/v2/crawlingConfigurationTextContentStrategyType.d.ts

@@ -0,0 +1,30 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * API endpoint slug.
+ */
+export declare const apiV2CrawlingConfigurationTextContentStrategyTypeApiEndpointSlug = "crawling-configuration-text-content-strategy-types";
+/**
+ * Type for the individual array items in v2 of the API for the crawling configuration text content strategy type endpoint.
+ */
+export type ApiV2CrawlingConfigurationTextContentStrategyTypeType = {
+    /**
+     * Timestamp for when the entity was created.
+     */
+    created: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: 1 | 2;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Human readable name.
+     */
+    name: string;
+};
+/**
+ * The API response type for crawling configurations.
+ */
+export type ApiV2CrawlingConfigurationTextContentStrategyTypeResponseType = ApiV2BaseResponseType<ApiV2CrawlingConfigurationTextContentStrategyTypeType[], number>;

package/dist/v2/date.d.ts

@@ -0,0 +1,29 @@
+import type { ApiV2DayType } from '../v2/day';
+import type { ApiV2MonthSetType } from '../v2/monthSet';
+import type { ApiV2YearSetType } from '../v2/yearSet';
+export type ApiV2DateType = {
+    /**
+     * Current day.
+     */
+    day: ApiV2DayType;
+    /**
+     * Determines whether or not the date is the actual date for the current day.
+     */
+    isActualDate: boolean;
+    /**
+     * Determines whether or not the date is the one that's currently being shown on the main site.
+     */
+    isCurrentlyShownOnMainSite: boolean;
+    /**
+     * Set of current month and month for the week (as Jan first isn't always week one of the year, but can belong to the last week of the previous year).
+     */
+    monthSet: ApiV2MonthSetType;
+    /**
+     * Current week number.
+     */
+    weekNumber: number;
+    /**
+     * Set of current year and year for the week (as Jan first isn't always week one of the year, but can belong to the last week of the previous year).
+     */
+    yearSet: ApiV2YearSetType;
+};

package/dist/v2/day.d.ts

@@ -0,0 +1,47 @@
+export type ApiV2DayType = {
+    /**
+     * American name of the day.
+     */
+    americanName: string;
+    /**
+     * American number of the week day. I.e. week starts with sunday.
+     */
+    americanNumber: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * The number of day of the month. This is actually 1 through 31 specifically, but I'm not going to write out all options and AFAIK Typescript doesn't yet have built-in helpers for this...
+     */
+    dayOfMonth: number;
+    /**
+     * Index of the day. Starting with monday.
+     */
+    index: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Whether or not the day is the current real life date.
+     * @deprecated As of 2022-04-05 you should use the variables on the date object instead of on this the day object.
+     */
+    isCurrent?: boolean;
+    /**
+     * Whether or not the day is a weekend day.
+     */
+    isWeekend: boolean;
+    /**
+     * Localized ame of the day.
+     */
+    name: 'Måndag' | 'Tisdag' | 'Onsdag' | 'Torsdag' | 'Fredag' | 'Lördag' | 'Söndag';
+    /**
+     * ISO 8601 day number of the week. Starting with monday at 1.
+     */
+    number: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    /**
+     * Short localized name of the day.
+     */
+    shortName: 'Mån' | 'Tis' | 'Ons' | 'Tors' | 'Fre' | 'Lör' | 'Sön';
+    /**
+     * Day slug.
+     */
+    slug: 'mandag' | 'tisdag' | 'onsdag' | 'torsdag' | 'fredag' | 'lordag' | 'sondag';
+    /**
+     * Shorter localized name of the day.
+     */
+    twoLetterShortName: 'Må' | 'Ti' | 'On' | 'To' | 'Fr' | 'Lö' | 'Sö';
+};

package/dist/v2/deliveryInfo.d.ts

@@ -0,0 +1,46 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the delivery info endpoint.
+ */
+export type ApiV2DeliveryInfoType = {
+    /**
+     * Timestamp for when the entity was created.
+     */
+    created: string;
+    /**
+     * ID of the specific type of delivery info that's selected.
+     */
+    deliveryInfoTypeId: number;
+    /**
+     * Delivery link.
+     */
+    deliveryLink: string;
+    /**
+     * Email to use for delivery info.
+     */
+    email: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * Timestamp for when the entity was last updated.
+     */
+    lastUpdated: string;
+    /**
+     * Phone number for booking tables.
+     */
+    phone: string;
+    /**
+     * ID of the restaurant that the delivery info info is relevant for.
+     */
+    restaurantId: number;
+    /**
+     * Informational text about delivery info conditions.
+     */
+    text: string;
+};
+/**
+ * The API response type for delivery info.
+ */
+export type ApiV2DeliveryInfoResponseType = ApiV2BaseResponseType<ApiV2DeliveryInfoType[], number>;

package/dist/v2/dinnerFunctionality.d.ts

@@ -0,0 +1,47 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2OpeningHourType } from '../v2/openingHour';
+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.
+ */
+export type ApiV2DinnerFunctionalityType = ApiV2RestaurantFunctionalityType & {
+    /**
+     * Number of columns to display dinner menu in.
+     */
+    columns: 1 | 2 | 3;
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Determines what type of dinner functionality to show.
+     */
+    dinnerFunctionalityTypeId: number;
+    /**
+     * Background for the restaurant details page header.
+     */
+    dinnerMenuImage: ApiV2RestaurantUploadGroupingType;
+    /**
+     * String representation of the last time the entity was updated.
+     */
+    lastUpdated: string;
+    /**
+     * Link to use for external link type menus.
+     */
+    menuLink: string;
+    /**
+     * Text shown above the menu to provide generic information not directly related to the dishes themselves.
+     */
+    menuText: string;
+    /**
+     * List of opening hours for the dinner.
+     */
+    openingHourList: {
+        items: ApiV2OpeningHourType[];
+    };
+};
+/**
+ * The API response type for dinner functionality items.
+ */
+export type ApiV2DinnerFunctionalityResponseType = ApiV2BaseResponseType<ApiV2DinnerFunctionalityType[], number>;

package/dist/v2/foodItem.d.ts

@@ -0,0 +1,22 @@
+export type ApiV2FoodItemType = {
+    /**
+     * Description of the dish. Usually displayed below the name.
+     */
+    description: null | string;
+    /**
+     * Name of the dish. Used as the main title.
+     */
+    name: null | string;
+    /**
+     * Price of the dish.
+     */
+    price: null | number | string;
+    /**
+     *
+     */
+    quantity: number;
+    /**
+     * List of tags for the dish.
+     */
+    tags: string[];
+};

package/dist/v2/geodata.d.ts

@@ -0,0 +1,39 @@
+export type ApiV2GeodataType = {
+    /**
+     * Unused.
+     * @deprecated
+     */
+    cityId: number;
+    /**
+     * 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;
+    /**
+     *
+     */
+    zoomLevel: number;
+};

package/dist/v2/integrationV1Configuration.d.ts

@@ -0,0 +1,38 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the integration v1 configuration endpoint.
+ */
+export type ApiV2IntegrationV1ConfigurationType = {
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Integration specific CSS.
+     */
+    css: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * The type of integration to display.
+     */
+    integrationTypeId: 1 | 2 | 3;
+    /**
+     * Integration specific JS.
+     */
+    js: string;
+    /**
+     * String representation of the last time the entity was updated.
+     */
+    lastUpdated: string;
+    /**
+     * ID of the restaurant the configuration is relevant for.
+     */
+    restaurantId: number;
+};
+/**
+ * The API response type for integration v1 configurations.
+ */
+export type ApiV2IntegrationV1ConfigurationResponseType = ApiV2BaseResponseType<ApiV2IntegrationV1ConfigurationType[], number>;

package/dist/v2/integrationV2Configuration.d.ts

@@ -0,0 +1,42 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+/**
+ * Type for the individual array items in v2 of the API for the integration v1 configuration endpoint.
+ */
+export type ApiV2IntegrationV2ConfigurationType = {
+    /**
+     * Whether or not the integration is active.
+     */
+    active: boolean;
+    /**
+     * String representation of when the entity was created.
+     */
+    created: string;
+    /**
+     * Integration specific CSS.
+     */
+    css: string;
+    /**
+     * Unique ID for the entity.
+     */
+    id: number;
+    /**
+     * String representation of the last time the entity was updated.
+     */
+    lastUpdated: string;
+    /**
+     * JS for preparing the page before the actual rendering. This should normally be left empty and used only for special scenarios where the site you're integrating isn't built dynamically enough to support rendering the integration to look the same as the rest of the page (hardcoded things, strict post type setups, etc.). Note that as the name suggests this is JSX to be used for setting up the necessary stuff beforehand and not JSX (which you're expected to place in {@link ApiV2IntegrationV2ConfigurationType.renderJsx} instead).
+     */
+    preRenderJs: string;
+    /**
+     * JSX for rendering the actual integration. Note that as the name suggests this is JSX and not plain JS (which you're expected to place in {@link ApiV2IntegrationV2ConfigurationType.preRenderJs} instead).
+     */
+    renderJsx: string;
+    /**
+     * ID of the restaurant the configuration is relevant for.
+     */
+    restaurantId: number;
+};
+/**
+ * The API response type for integration v1 configurations.
+ */
+export type ApiV2IntegrationV2ConfigurationResponseType = ApiV2BaseResponseType<ApiV2IntegrationV2ConfigurationType[], number>;

package/dist/v2/lunchBoxFunctionality.d.ts

@@ -0,0 +1,31 @@
+import type { ApiV2BaseResponseType } from '../v2/baseResponse';
+import type { ApiV2RestaurantFunctionalityType } from '../v2/restaurantFunctionalityType';
+/**
+ * Type for the individual array items in v2 of the API for the lunch box functionality endpoint.
+ */
+export type ApiV2LunchBoxFunctionalityType = ApiV2RestaurantFunctionalityType & {
+    /**
+     * Conditions for ordering lunch boxes.
+     */
+    conditionsText: string;
+    /**
+     * Latest possible time for placing orders.
+     */
+    latestOrderTime: string;
+    /**
+     * The email address to send confirmation emails to.
+     */
+    orderConfirmationEmail: string;
+    /**
+     * Earliest time for picking up orders.
+     */
+    pickupTimeFrom: string;
+    /**
+     * Latest time for picking up orders.
+     */
+    pickupTimeTo: string;
+};
+/**
+ * The API response type for lunch box functionality.
+ */
+export type ApiV2LunchBoxFunctionalityResponseType = ApiV2BaseResponseType<ApiV2LunchBoxFunctionalityType[], number>;

package/dist/v2/lunchDish.d.ts

@@ -0,0 +1,2 @@
+import type { ApiV2FoodItemType } from '../v2/foodItem';
+export type ApiV2LunchDishType = ApiV2FoodItemType;