@compassdigital/sdk.typescript 3.0.0-beta.15 → 3.0.0-beta.18

package/src/index.ts

@@ -356,6 +356,7 @@ import {
   GetUserKdsTokenQuery,
   GetUserKdsTokenResponse,
   DeleteUserDeviceAuthResponse,
+  PatchUserAuthKdsBody,
   PatchUserAuthKdsResponse,
   PostUserChangePasswordBody,
   PostUserChangePasswordResponse,
@@ -467,6 +468,51 @@ import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "./inte
 
 import { GetLoggerBrandStatusQuery, GetLoggerBrandStatusResponse } from "./interface/logger";
 
+import {
+  GetMenuClientResponse,
+  GetMenusQuery,
+  GetMenusResponse,
+  PostMenuBody,
+  PostMenuResponse,
+  HeadMenuQuery,
+  HeadMenuResponse,
+  GetMenuQuery,
+  GetMenuResponse,
+  PutMenuQuery,
+  PutMenuBody,
+  PutMenuResponse,
+  DeleteMenuQuery,
+  DeleteMenuResponse,
+  PatchMenuQuery,
+  PatchMenuBody,
+  PatchMenuResponse,
+  PostMenuImportMenuBody,
+  PostMenuImportMenuResponse,
+  GetMenuItemResponse,
+  DeleteMenuItemResponse,
+  PostMenuItemBody,
+  PostMenuItemResponse,
+  GetMenuItemsQuery,
+  GetMenuItemsResponse,
+  PostMenuImportItemsCanteenResponse,
+  GetMenuLocationItemsResponse,
+  GetMenuLocationItemRandomQuery,
+  GetMenuLocationItemRandomResponse,
+  GetMenuLocationItemsRandomQuery,
+  GetMenuLocationItemsRandomResponse,
+  GetMenuSectorMenusResponse,
+  GetMenuCompanyMenusResponse,
+  PostMenuModifierGroupBody,
+  PostMenuModifierGroupResponse,
+  GetMenuModifierGroupResponse,
+  PutMenuModifierGroupBody,
+  PutMenuModifierGroupResponse,
+  DeleteMenuModifierGroupResponse,
+  GetMenuCompanyModifierGroupsResponse,
+  GetMenuCompanyModifierGroupsExportResponse,
+  GetMenuExportResponse,
+} from "./interface/menu";
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
 
@@ -3785,10 +3831,12 @@ export class ServiceClient extends BaseServiceClient {
    * PATCH /user/device/auth/{device_id} - Endpoint for authorizing device to retrieve valid kds token
    *
    * @param device_id - KDS device ID
+   * @param body
    * @param options - additional request options
    */
   patch_user_auth_kds(
     device_id: string,
+    body: PatchUserAuthKdsBody,
     options?: RequestOptions
   ): ResponsePromise<PatchUserAuthKdsResponse> {
     return this.request(
@@ -3796,7 +3844,7 @@ export class ServiceClient extends BaseServiceClient {
       "patch_user_auth_kds",
       "patch",
       `/user/device/auth/${device_id}`,
-      null,
+      body,
       options
     );
   }
@@ -4839,4 +4887,441 @@ export class ServiceClient extends BaseServiceClient {
       options
     );
   }
+
+  /**
+   * GET /menu/client/{client_id} - Get menu client
+   *
+   * @param client_id
+   * @param options - additional request options
+   */
+  get_menu_client(
+    client_id: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuClientResponse> {
+    return this.request(
+      "menu",
+      "get_menu_client",
+      "get",
+      `/menu/client/${client_id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu - Get Menus or search for Menus
+   *
+   * @param options - additional request options
+   */
+  get_menus(
+    options: {
+      query: GetMenusQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenusResponse> {
+    return this.request("menu", "get_menus", "get", `/menu`, null, options);
+  }
+
+  /**
+   * POST /menu - Create a new Menu
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu(body: PostMenuBody, options?: RequestOptions): ResponsePromise<PostMenuResponse> {
+    return this.request("menu", "post_menu", "post", `/menu`, body, options);
+  }
+
+  /**
+   * HEAD /menu/{id} - Get an individual Menu
+   *
+   * @param id - menu
+   * @param options - additional request options
+   */
+  head_menu(
+    id: string,
+    options?: {
+      query?: HeadMenuQuery;
+    } & RequestOptions
+  ): ResponsePromise<HeadMenuResponse> {
+    return this.request("menu", "head_menu", "head", `/menu/${id}`, null, options);
+  }
+
+  /**
+   * GET /menu/{id} - Get an individual Menu
+   *
+   * @param id - menu
+   * @param options - additional request options
+   */
+  get_menu(
+    id: string,
+    options?: {
+      query?: GetMenuQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuResponse> {
+    return this.request("menu", "get_menu", "get", `/menu/${id}`, null, options);
+  }
+
+  /**
+   * PUT /menu/{id} - Override a complete Menu
+   *
+   * @param id - menu
+   * @param body
+   * @param options - additional request options
+   */
+  put_menu(
+    id: string,
+    body: PutMenuBody,
+    options?: {
+      query?: PutMenuQuery;
+    } & RequestOptions
+  ): ResponsePromise<PutMenuResponse> {
+    return this.request("menu", "put_menu", "put", `/menu/${id}`, body, options);
+  }
+
+  /**
+   * DELETE /menu/{id} - Delete a Menu
+   *
+   * @param id - menu
+   * @param options - additional request options
+   */
+  delete_menu(
+    id: string,
+    options?: {
+      query?: DeleteMenuQuery;
+    } & RequestOptions
+  ): ResponsePromise<DeleteMenuResponse> {
+    return this.request("menu", "delete_menu", "delete", `/menu/${id}`, null, options);
+  }
+
+  /**
+   * PATCH /menu/{id} - Update a menu
+   *
+   * @param id - menu
+   * @param body
+   * @param options - additional request options
+   */
+  patch_menu(
+    id: string,
+    body: PatchMenuBody,
+    options?: {
+      query?: PatchMenuQuery;
+    } & RequestOptions
+  ): ResponsePromise<PatchMenuResponse> {
+    return this.request("menu", "patch_menu", "patch", `/menu/${id}`, body, options);
+  }
+
+  /**
+   * POST /menu/import - Import an existing Menu
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_import_menu(
+    body: PostMenuImportMenuBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuImportMenuResponse> {
+    return this.request("menu", "post_menu_import_menu", "post", `/menu/import`, body, options);
+  }
+
+  /**
+   * GET /menu/item/{id} - Get menu item
+   *
+   * @param id - Item ID
+   * @param options - additional request options
+   */
+  get_menu_item(id: string, options?: RequestOptions): ResponsePromise<GetMenuItemResponse> {
+    return this.request("menu", "get_menu_item", "get", `/menu/item/${id}`, null, options);
+  }
+
+  /**
+   * DELETE /menu/item/{id} - Delete a menu item
+   *
+   * @param id - Item ID
+   * @param options - additional request options
+   */
+  delete_menu_item(id: string, options?: RequestOptions): ResponsePromise<DeleteMenuItemResponse> {
+    return this.request("menu", "delete_menu_item", "delete", `/menu/item/${id}`, null, options);
+  }
+
+  /**
+   * POST /menu/item - Create a menu item
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_item(
+    body: PostMenuItemBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuItemResponse> {
+    return this.request("menu", "post_menu_item", "post", `/menu/item`, body, options);
+  }
+
+  /**
+   * GET /menu/items - Search for menu items
+   *
+   * @param options - additional request options
+   */
+  get_menu_items(
+    options: {
+      query: GetMenuItemsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuItemsResponse> {
+    return this.request("menu", "get_menu_items", "get", `/menu/items`, null, options);
+  }
+
+  /**
+   * POST /menu/items/import/{location} - trigger import items
+   *
+   * @param location - Location ID
+   * @param options - additional request options
+   */
+  post_menu_import_items_canteen(
+    location: string,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuImportItemsCanteenResponse> {
+    return this.request(
+      "menu",
+      "post_menu_import_items_canteen",
+      "post",
+      `/menu/items/import/${location}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/items/location/{location} - Get all menu items for a location
+   *
+   * @param location - Location ID
+   * @param options - additional request options
+   */
+  get_menu_location_items(
+    location: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuLocationItemsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_location_items",
+      "get",
+      `/menu/items/location/${location}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/item/random/location/{location} - Get a random item
+   *
+   * @param location - Location ID
+   * @param options - additional request options
+   */
+  get_menu_location_item_random(
+    location: string,
+    options?: {
+      query?: GetMenuLocationItemRandomQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuLocationItemRandomResponse> {
+    return this.request(
+      "menu",
+      "get_menu_location_item_random",
+      "get",
+      `/menu/item/random/location/${location}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/items/random/location/{location} - Get a set of random items
+   *
+   * @param location - Location ID
+   * @param options - additional request options
+   */
+  get_menu_location_items_random(
+    location: string,
+    options?: {
+      query?: GetMenuLocationItemsRandomQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuLocationItemsRandomResponse> {
+    return this.request(
+      "menu",
+      "get_menu_location_items_random",
+      "get",
+      `/menu/items/random/location/${location}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/sector/{sector} - Get menus that belong to sector
+   *
+   * @param sector - Sector ID
+   * @param options - additional request options
+   */
+  get_menu_sector_menus(
+    sector: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuSectorMenusResponse> {
+    return this.request(
+      "menu",
+      "get_menu_sector_menus",
+      "get",
+      `/menu/sector/${sector}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/company/{company} - Get menus that belong to company
+   *
+   * @param company - Company ID
+   * @param options - additional request options
+   */
+  get_menu_company_menus(
+    company: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuCompanyMenusResponse> {
+    return this.request(
+      "menu",
+      "get_menu_company_menus",
+      "get",
+      `/menu/company/${company}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/modifier/group - Create a new Menu Modifier Group
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_modifier_group(
+    body: PostMenuModifierGroupBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "post_menu_modifier_group",
+      "post",
+      `/menu/modifier/group`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/modifier/group/{id} - Get a Menu Modifier Group
+   *
+   * @param id - modifier_group
+   * @param options - additional request options
+   */
+  get_menu_modifier_group(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "get_menu_modifier_group",
+      "get",
+      `/menu/modifier/group/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PUT /menu/modifier/group/{id} - Update a Menu Modifier Group
+   *
+   * @param id - modifier_group
+   * @param body
+   * @param options - additional request options
+   */
+  put_menu_modifier_group(
+    id: string,
+    body: PutMenuModifierGroupBody,
+    options?: RequestOptions
+  ): ResponsePromise<PutMenuModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "put_menu_modifier_group",
+      "put",
+      `/menu/modifier/group/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * DELETE /menu/modifier/group/{id} - Delete a Menu Modifier Group
+   *
+   * @param id - modifier_group
+   * @param options - additional request options
+   */
+  delete_menu_modifier_group(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeleteMenuModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "delete_menu_modifier_group",
+      "delete",
+      `/menu/modifier/group/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/modifier/group/company/{company} - Get the modifier groups that belong to company
+   *
+   * @param company - Company ID
+   * @param options - additional request options
+   */
+  get_menu_company_modifier_groups(
+    company: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuCompanyModifierGroupsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_company_modifier_groups",
+      "get",
+      `/menu/modifier/group/company/${company}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/modifier/group/company/{company}/export - Export company modifier groups to zipped excel file.
+   *
+   * @param company - Company ID
+   * @param options - additional request options
+   */
+  get_menu_company_modifier_groups_export(
+    company: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetMenuCompanyModifierGroupsExportResponse> {
+    return this.request(
+      "menu",
+      "get_menu_company_modifier_groups_export",
+      "get",
+      `/menu/modifier/group/company/${company}/export`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/{id}/export - Export menu set to zipped excel file.
+   *
+   * @param id - menu; TODO: cannot use compassdigital.id as path parameter
+   * @param options - additional request options
+   */
+  get_menu_export(id: string, options?: RequestOptions): ResponsePromise<GetMenuExportResponse> {
+    return this.request("menu", "get_menu_export", "get", `/menu/${id}/export`, null, options);
+  }
 }

package/src/interface/kds.ts

@@ -47,6 +47,8 @@ export interface AuthPostBodyResponse {
 export interface GetKdsDevicesQuery {
   // Unit numbers string separated with commas
   unitNumber: string;
+  // Do not return cached device information
+  nocache?: boolean;
 }
 
 export type GetKdsDevicesResponse = Units;