@compassdigital/sdk.typescript 3.39.0 → 3.41.0

package/src/index.ts

@@ -154,7 +154,6 @@ import {
   GetLocationBrandResponse,
   PatchLocationBrandBody,
   PatchLocationBrandResponse,
-  DeleteLocationBrandBody,
   DeleteLocationBrandResponse,
   PutLocationBrandBody,
   PutLocationBrandResponse,
@@ -265,6 +264,7 @@ import {
   GetMealplanResponse,
   DeleteMealplanBody,
   DeleteMealplanResponse,
+  PostMealplanCallbackQuery,
   PostMealplanCallbackResponse,
   GetMealplanTenderQuery,
   GetMealplanTenderResponse,
@@ -457,6 +457,22 @@ import {
 } from "./interface/file";
 
 import {
+  GetMenuV2ModifiersQuery,
+  GetMenuV2ModifiersResponse,
+  GetMenuV2ModifierQuery,
+  GetMenuV2ModifierResponse,
+  PatchMenuV2ModifierResponse,
+  PostMenuV2ModifierResponse,
+  GetMenuV2ModifierCountQuery,
+  GetMenuV2ModifierCountResponse,
+  GetMenuV2ModifierGroupsQuery,
+  GetMenuV2ModifierGroupsResponse,
+  PostMenuV2ModifierGroupResponse,
+  GetMenuV2ModifierGroupQuery,
+  GetMenuV2ModifierGroupResponse,
+  PatchMenuV2ModifierGroupResponse,
+  GetMenuV2ModifierGroupCountQuery,
+  GetMenuV2ModifierGroupCountResponse,
   GetMenuClientQuery,
   GetMenuClientResponse,
   GetMenusQuery,
@@ -2112,12 +2128,10 @@ export class ServiceClient extends BaseServiceClient {
    * DELETE /location/brand/{id} - Delete data from a Brand
    *
    * @param id - Brand ID
-   * @param body
    * @param options - additional request options
    */
   delete_location_brand(
     id: string,
-    body: DeleteLocationBrandBody,
     options?: RequestOptions
   ): ResponsePromise<DeleteLocationBrandResponse> {
     return this.request(
@@ -2125,7 +2139,7 @@ export class ServiceClient extends BaseServiceClient {
       "delete_location_brand",
       "delete",
       `/location/brand/${id}`,
-      body,
+      null,
       options
     );
   }
@@ -3069,7 +3083,9 @@ export class ServiceClient extends BaseServiceClient {
    */
   post_mealplan_callback(
     id: string,
-    options?: RequestOptions
+    options?: {
+      query?: PostMealplanCallbackQuery;
+    } & RequestOptions
   ): ResponsePromise<PostMealplanCallbackResponse> {
     return this.request(
       "mealplan",
@@ -4637,6 +4653,204 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("file", "delete_file", "delete", `/file`, body, options);
   }
 
+  /**
+   * GET /menu/v2/modifiers
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_modifiers(
+    options?: {
+      query?: GetMenuV2ModifiersQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifiersResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifiers",
+      "get",
+      `/menu/v2/modifiers`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/modifier/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier(
+    id: string,
+    options?: {
+      query?: GetMenuV2ModifierQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier",
+      "get",
+      `/menu/v2/modifier/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PATCH /menu/v2/modifier/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  patch_menu_v2_modifier(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV2ModifierResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v2_modifier",
+      "patch",
+      `/menu/v2/modifier/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v2/modifier
+   *
+   * @param options - additional request options
+   */
+  post_menu_v2_modifier(options?: RequestOptions): ResponsePromise<PostMenuV2ModifierResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v2_modifier",
+      "post",
+      `/menu/v2/modifier`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/modifier/count
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier_count(
+    options?: {
+      query?: GetMenuV2ModifierCountQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierCountResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier_count",
+      "get",
+      `/menu/v2/modifier/count`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/modifier-groups
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier_groups(
+    options?: {
+      query?: GetMenuV2ModifierGroupsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierGroupsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier_groups",
+      "get",
+      `/menu/v2/modifier-groups`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v2/modifier-group
+   *
+   * @param options - additional request options
+   */
+  post_menu_v2_modifier_group(
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV2ModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v2_modifier_group",
+      "post",
+      `/menu/v2/modifier-group`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/modifier-group/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier_group(
+    id: string,
+    options?: {
+      query?: GetMenuV2ModifierGroupQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier_group",
+      "get",
+      `/menu/v2/modifier-group/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PATCH /menu/v2/modifier-group/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  patch_menu_v2_modifier_group(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV2ModifierGroupResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v2_modifier_group",
+      "patch",
+      `/menu/v2/modifier-group/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/modifier-group/count
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier_group_count(
+    options?: {
+      query?: GetMenuV2ModifierGroupCountQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierGroupCountResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier_group_count",
+      "get",
+      `/menu/v2/modifier-group/count`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /menu/client/{client_id} - Get menu client
    *

package/src/interface/location.ts

@@ -309,6 +309,10 @@ export interface MultiGroup {
   [index: string]: any;
 }
 
+export interface success {
+  success?: boolean;
+}
+
 export interface Error {
   error?: string;
   code?: number;
@@ -437,6 +441,8 @@ export interface WaitTime {
   max: number;
   // minimum wait time to the next time slot in minutes
   min: number;
+  // the epoch timestamp of the next available ready time for a station
+  ready_time: number;
 }
 
 // POST /location - Create a new location
@@ -1234,13 +1240,9 @@ export interface DeleteLocationBrandPath {
   id: string;
 }
 
-export type DeleteLocationBrandBody = Brand;
+export type DeleteLocationBrandResponse = success;
 
-export type DeleteLocationBrandResponse = Brand;
-
-export interface DeleteLocationBrandRequest extends BaseRequest, DeleteLocationBrandPath {
-  body: DeleteLocationBrandBody;
-}
+export interface DeleteLocationBrandRequest extends BaseRequest, DeleteLocationBrandPath {}
 
 // PUT /location/brand/{id} - Update location brand
 

package/src/interface/mealplan.ts

@@ -5,6 +5,9 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
+  headers?: {
+    Location?: string;
+  };
 }
 
 export interface Tender {
@@ -142,13 +145,21 @@ export interface PostMealplanCallbackPath {
   id: string;
 }
 
+export interface PostMealplanCallbackQuery {
+  // Determines whether the request originates from a web client or not
+  web?: boolean;
+}
+
 export interface PostMealplanCallbackResponse {
   token?: string;
   // DH 1.0 format for returning the token
   cardNumber?: string;
 }
 
-export interface PostMealplanCallbackRequest extends BaseRequest, PostMealplanCallbackPath {}
+export interface PostMealplanCallbackRequest
+  extends BaseRequest,
+    RequestQuery<PostMealplanCallbackQuery>,
+    PostMealplanCallbackPath {}
 
 // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
 

package/src/interface/menu.ts

@@ -2,6 +2,55 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
+export interface ModifiersListResponse {
+  meta?: Meta;
+  results?: Modifier[];
+}
+
+export interface ModifierGroupsListResponse {
+  meta?: Meta;
+  results?: ModifierGroup[];
+}
+
+export interface Meta {
+  limit?: number;
+  page?: number;
+  sort_by?: string;
+  sort_order?: string;
+  search?: string;
+  total_results?: number;
+  total_pages?: number;
+  result_count?: number;
+  [index: string]: any;
+}
+
+export interface Modifier {
+  id?: string;
+  name?: string;
+  description?: string;
+  price?: number;
+  calories?: number;
+  posid?: string;
+  tax_tags?: string[];
+  barcode?: string;
+  is_active?: boolean;
+  is_in_stock?: boolean;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface ModifierGroup {
+  id?: string;
+  name?: string;
+  label?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
 export interface Menu {
   // menu
   id?: string;
@@ -299,6 +348,132 @@ export interface ZippedExcelExport {
   format?: string;
 }
 
+// GET /menu/v2/modifiers
+
+export interface GetMenuV2ModifiersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifiersResponse = ModifiersListResponse;
+
+export interface GetMenuV2ModifiersRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifiersQuery> {}
+
+// GET /menu/v2/modifier/{id}
+
+export interface GetMenuV2ModifierPath {
+  id: string;
+}
+
+export interface GetMenuV2ModifierQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierResponse = Modifier;
+
+export interface GetMenuV2ModifierRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierQuery>,
+    GetMenuV2ModifierPath {}
+
+// PATCH /menu/v2/modifier/{id}
+
+export interface PatchMenuV2ModifierPath {
+  id: string;
+}
+
+export type PatchMenuV2ModifierResponse = Modifier;
+
+export interface PatchMenuV2ModifierRequest extends BaseRequest, PatchMenuV2ModifierPath {}
+
+// POST /menu/v2/modifier
+
+export type PostMenuV2ModifierResponse = Modifier;
+
+export interface PostMenuV2ModifierRequest extends BaseRequest {}
+
+// GET /menu/v2/modifier/count
+
+export interface GetMenuV2ModifierCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2ModifierCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2ModifierCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierCountQuery> {}
+
+// GET /menu/v2/modifier-groups
+
+export interface GetMenuV2ModifierGroupsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierGroupsResponse = ModifierGroupsListResponse;
+
+export interface GetMenuV2ModifierGroupsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupsQuery> {}
+
+// POST /menu/v2/modifier-group
+
+export type PostMenuV2ModifierGroupResponse = Modifier;
+
+export interface PostMenuV2ModifierGroupRequest extends BaseRequest {}
+
+// GET /menu/v2/modifier-group/{id}
+
+export interface GetMenuV2ModifierGroupPath {
+  id: string;
+}
+
+export interface GetMenuV2ModifierGroupQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierGroupResponse = Modifier;
+
+export interface GetMenuV2ModifierGroupRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupQuery>,
+    GetMenuV2ModifierGroupPath {}
+
+// PATCH /menu/v2/modifier-group/{id}
+
+export interface PatchMenuV2ModifierGroupPath {
+  id: string;
+}
+
+export type PatchMenuV2ModifierGroupResponse = Modifier;
+
+export interface PatchMenuV2ModifierGroupRequest
+  extends BaseRequest,
+    PatchMenuV2ModifierGroupPath {}
+
+// GET /menu/v2/modifier-group/count
+
+export interface GetMenuV2ModifierGroupCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2ModifierGroupCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2ModifierGroupCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupCountQuery> {}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {

package/src/interface/order.ts

@@ -144,6 +144,8 @@ export interface Order {
         amount?: number;
         meals?: number;
       };
+      // the amount remaining on the transaction after refund - remaining amount available for refund
+      transaction_remainder_amount?: number;
       [index: string]: any;
     };
     // Shoppingcart details
@@ -172,6 +174,8 @@ export interface RefundTransaction {
   refund_date?: string;
   // user
   issued_by?: string;
+  amount?: number;
+  refund_amount?: number;
   [index: string]: any;
 }