@compassdigital/sdk.typescript 3.43.1 → 3.44.1

package/src/index.ts

@@ -13,8 +13,6 @@ import {
   PostPaymentConsumerResponse,
   PostPaymentMethodBody,
   PostPaymentMethodResponse,
-  GetPaymentMethodQuery,
-  GetPaymentMethodResponse,
   DeletePaymentMethodBody,
   DeletePaymentMethodResponse,
   GetPaymentTokenQuery,
@@ -210,10 +208,6 @@ import {
   GetPartnerStandardcognitionStoresResponse,
   PostPartnerStandardcognitionMenuBody,
   PostPartnerStandardcognitionMenuResponse,
-  GetPartnerCoolrLocationsQuery,
-  GetPartnerCoolrLocationsResponse,
-  GetPartnerCoolrImagesQuery,
-  GetPartnerCoolrImagesResponse,
   GetPartnerSwaggerQuery,
   GetPartnerSwaggerResponse,
 } from "./interface/partner";
@@ -477,6 +471,24 @@ import {
   PatchMenuV2ModifierGroupResponse,
   GetMenuV2ModifierGroupCountQuery,
   GetMenuV2ModifierGroupCountResponse,
+  GetMenuV2ModifierGroupRelationshipsModifiersQuery,
+  GetMenuV2ModifierGroupRelationshipsModifiersResponse,
+  PostMenuV2ModifierGroupRelationshipsModifierBody,
+  PostMenuV2ModifierGroupRelationshipsModifierResponse,
+  GetMenuV2ModifierGroupRelationshipsModifierQuery,
+  GetMenuV2ModifierGroupRelationshipsModifierResponse,
+  PatchMenuV2ModifierGroupRelationshipsModifierBody,
+  PatchMenuV2ModifierGroupRelationshipsModifierResponse,
+  GetMenuV2ItemsQuery,
+  GetMenuV2ItemsResponse,
+  GetMenuV2ItemQuery,
+  GetMenuV2ItemResponse,
+  PatchMenuV2ItemBody,
+  PatchMenuV2ItemResponse,
+  PostMenuV2ItemBody,
+  PostMenuV2ItemResponse,
+  GetMenuV2ItemsCountQuery,
+  GetMenuV2ItemsCountResponse,
   GetMenuClientQuery,
   GetMenuClientResponse,
   GetMenusQuery,
@@ -780,28 +792,6 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("payment", "post_payment_method", "post", `/payment/method`, body, options);
   }
 
-  /**
-   * GET /payment/{id}/method - Get a users available payment methods
-   *
-   * @param id - TODO: add parameter to swagger.json
-   * @param options - additional request options
-   */
-  get_payment_method(
-    id: string,
-    options: {
-      query: GetPaymentMethodQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetPaymentMethodResponse> {
-    return this.request(
-      "payment",
-      "get_payment_method",
-      "get",
-      `/payment/${id}/method`,
-      null,
-      options
-    );
-  }
-
   /**
    * DELETE /payment/{id}/method/{method_id}
    *
@@ -2678,48 +2668,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * GET /partner/coolr/locations - Gets the locations where Coolr is available
-   *
-   * @param options - additional request options
-   */
-  get_partner_coolr_locations(
-    options?: {
-      query?: GetPartnerCoolrLocationsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetPartnerCoolrLocationsResponse> {
-    return this.request(
-      "partner",
-      "get_partner_coolr_locations",
-      "get",
-      `/partner/coolr/locations`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /partner/coolr/{id}/images - Gets the latest images for Coolr Location AssetID
-   *
-   * @param id - location
-   * @param options - additional request options
-   */
-  get_partner_coolr_images(
-    id: string,
-    options?: {
-      query?: GetPartnerCoolrImagesQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetPartnerCoolrImagesResponse> {
-    return this.request(
-      "partner",
-      "get_partner_coolr_images",
-      "get",
-      `/partner/coolr/${id}/images`,
-      null,
-      options
-    );
-  }
-
   /**
    * GET /partner/swagger.json
    *
@@ -4865,6 +4813,173 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /menu/v2/modifier-group/relationships/modifiers
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier_group_relationships_modifiers(
+    options?: {
+      query?: GetMenuV2ModifierGroupRelationshipsModifiersQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierGroupRelationshipsModifiersResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier_group_relationships_modifiers",
+      "get",
+      `/menu/v2/modifier-group/relationships/modifiers`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v2/modifier-group/relationships/modifier
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v2_modifier_group_relationships_modifier(
+    body: PostMenuV2ModifierGroupRelationshipsModifierBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV2ModifierGroupRelationshipsModifierResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v2_modifier_group_relationships_modifier",
+      "post",
+      `/menu/v2/modifier-group/relationships/modifier`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/modifier-group/relationships/modifier/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v2_modifier_group_relationships_modifier(
+    id: string,
+    options?: {
+      query?: GetMenuV2ModifierGroupRelationshipsModifierQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ModifierGroupRelationshipsModifierResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_modifier_group_relationships_modifier",
+      "get",
+      `/menu/v2/modifier-group/relationships/modifier/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PATCH /menu/v2/modifier-group/relationships/modifier/{id}
+   *
+   * @param id
+   * @param body
+   * @param options - additional request options
+   */
+  patch_menu_v2_modifier_group_relationships_modifier(
+    id: string,
+    body: PatchMenuV2ModifierGroupRelationshipsModifierBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV2ModifierGroupRelationshipsModifierResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v2_modifier_group_relationships_modifier",
+      "patch",
+      `/menu/v2/modifier-group/relationships/modifier/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v2/items
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_items(
+    options?: {
+      query?: GetMenuV2ItemsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ItemsResponse> {
+    return this.request("menu", "get_menu_v2_items", "get", `/menu/v2/items`, null, options);
+  }
+
+  /**
+   * GET /menu/v2/item/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v2_item(
+    id: string,
+    options?: {
+      query?: GetMenuV2ItemQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ItemResponse> {
+    return this.request("menu", "get_menu_v2_item", "get", `/menu/v2/item/${id}`, null, options);
+  }
+
+  /**
+   * PATCH /menu/v2/item/{id}
+   *
+   * @param id
+   * @param body
+   * @param options - additional request options
+   */
+  patch_menu_v2_item(
+    id: string,
+    body: PatchMenuV2ItemBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV2ItemResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v2_item",
+      "patch",
+      `/menu/v2/item/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v2/item
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v2_item(
+    body: PostMenuV2ItemBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV2ItemResponse> {
+    return this.request("menu", "post_menu_v2_item", "post", `/menu/v2/item`, body, options);
+  }
+
+  /**
+   * GET /menu/v2/items/count
+   *
+   * @param options - additional request options
+   */
+  get_menu_v2_items_count(
+    options?: {
+      query?: GetMenuV2ItemsCountQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV2ItemsCountResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v2_items_count",
+      "get",
+      `/menu/v2/items/count`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /menu/client/{client_id} - Get menu client
    *

package/src/interface/location.ts

@@ -758,6 +758,8 @@ export interface GetLocationGroupQuery {
   non_market_places?: boolean;
   // return only groups with non-scan & go locations/brands
   non_scan_go?: boolean;
+  //  determine whether to calculate estimated_wait_time
+  include_estimated_wait_time?: number;
   // Graphql query string
   _query?: string;
   nocache?: boolean;
@@ -1206,6 +1208,8 @@ export interface GetLocationBrandQuery {
   include_config?: boolean;
   // show additional hidden properties/entities
   extended?: boolean;
+  //  determine whether to calculate estimated_wait_time
+  include_estimated_wait_time?: number;
   // Graphql query string
   _query?: string;
   nocache?: boolean;

package/src/interface/menu.ts

@@ -12,6 +12,16 @@ export interface ModifierGroupsListResponse {
   results?: ModifierGroup[];
 }
 
+export interface ItemsListResponse {
+  meta?: Meta;
+  results?: LocalItem[];
+}
+
+export interface ModifierGroupToModifierRelationshipListResponse {
+  meta?: Meta;
+  results?: ModifierGroupToModifierRelationship[];
+}
+
 export interface Meta {
   limit?: number;
   page?: number;
@@ -28,6 +38,7 @@ export interface Modifier {
   id?: string;
   name?: string;
   description?: string;
+  label?: string;
   price?: number;
   calories?: number;
   posid?: string;
@@ -53,6 +64,37 @@ export interface ModifierGroup {
   [index: string]: any;
 }
 
+export interface LocalItem {
+  id?: string;
+  name?: string;
+  description?: string;
+  label?: string;
+  price?: number;
+  calories?: number;
+  posid?: string;
+  barcode?: string;
+  tax_tags?: string[];
+  is_active?: boolean;
+  is_in_stock?: boolean;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface ModifierGroupToModifierRelationship {
+  id?: string;
+  modifier?: Modifier;
+  modifier_id?: string;
+  modifier_group?: ModifierGroup;
+  modifier_group_id?: string;
+  sequence?: number;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
 export interface Menu {
   // menu
   id?: string;
@@ -490,6 +532,135 @@ export interface GetMenuV2ModifierGroupCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV2ModifierGroupCountQuery> {}
 
+// GET /menu/v2/modifier-group/relationships/modifiers
+
+export interface GetMenuV2ModifierGroupRelationshipsModifiersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierGroupRelationshipsModifiersResponse =
+  ModifierGroupToModifierRelationshipListResponse;
+
+export interface GetMenuV2ModifierGroupRelationshipsModifiersRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupRelationshipsModifiersQuery> {}
+
+// POST /menu/v2/modifier-group/relationships/modifier
+
+export type PostMenuV2ModifierGroupRelationshipsModifierBody = ModifierGroupToModifierRelationship;
+
+export type PostMenuV2ModifierGroupRelationshipsModifierResponse =
+  ModifierGroupToModifierRelationship;
+
+export interface PostMenuV2ModifierGroupRelationshipsModifierRequest extends BaseRequest {
+  body: PostMenuV2ModifierGroupRelationshipsModifierBody;
+}
+
+// GET /menu/v2/modifier-group/relationships/modifier/{id}
+
+export interface GetMenuV2ModifierGroupRelationshipsModifierPath {
+  id: string;
+}
+
+export interface GetMenuV2ModifierGroupRelationshipsModifierQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierGroupRelationshipsModifierResponse =
+  ModifierGroupToModifierRelationship;
+
+export interface GetMenuV2ModifierGroupRelationshipsModifierRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupRelationshipsModifierQuery>,
+    GetMenuV2ModifierGroupRelationshipsModifierPath {}
+
+// PATCH /menu/v2/modifier-group/relationships/modifier/{id}
+
+export interface PatchMenuV2ModifierGroupRelationshipsModifierPath {
+  id: string;
+}
+
+export type PatchMenuV2ModifierGroupRelationshipsModifierBody = ModifierGroupToModifierRelationship;
+
+export type PatchMenuV2ModifierGroupRelationshipsModifierResponse =
+  ModifierGroupToModifierRelationship;
+
+export interface PatchMenuV2ModifierGroupRelationshipsModifierRequest
+  extends BaseRequest,
+    PatchMenuV2ModifierGroupRelationshipsModifierPath {
+  body: PatchMenuV2ModifierGroupRelationshipsModifierBody;
+}
+
+// GET /menu/v2/items
+
+export interface GetMenuV2ItemsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ItemsResponse = ItemsListResponse;
+
+export interface GetMenuV2ItemsRequest extends BaseRequest, RequestQuery<GetMenuV2ItemsQuery> {}
+
+// GET /menu/v2/item/{id}
+
+export interface GetMenuV2ItemPath {
+  id: string;
+}
+
+export interface GetMenuV2ItemQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ItemResponse = LocalItem;
+
+export interface GetMenuV2ItemRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ItemQuery>,
+    GetMenuV2ItemPath {}
+
+// PATCH /menu/v2/item/{id}
+
+export interface PatchMenuV2ItemPath {
+  id: string;
+}
+
+export type PatchMenuV2ItemBody = LocalItem;
+
+export type PatchMenuV2ItemResponse = LocalItem;
+
+export interface PatchMenuV2ItemRequest extends BaseRequest, PatchMenuV2ItemPath {
+  body: PatchMenuV2ItemBody;
+}
+
+// POST /menu/v2/item
+
+export type PostMenuV2ItemBody = LocalItem;
+
+export type PostMenuV2ItemResponse = LocalItem;
+
+export interface PostMenuV2ItemRequest extends BaseRequest {
+  body: PostMenuV2ItemBody;
+}
+
+// GET /menu/v2/items/count
+
+export interface GetMenuV2ItemsCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2ItemsCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2ItemsCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ItemsCountQuery> {}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {

package/src/interface/order.ts

@@ -153,6 +153,10 @@ export interface Order {
       total?: {
         amount?: number;
       };
+      // Total of first cart on order. Carts can change after refunds, so this is original value
+      original_total?: {
+        amount?: number;
+      };
       [index: string]: any;
     };
     [index: string]: any;

package/src/interface/partner.ts

@@ -828,42 +828,6 @@ export interface PostPartnerStandardcognitionMenuRequest extends BaseRequest {
   body: PostPartnerStandardcognitionMenuBody;
 }
 
-// GET /partner/coolr/locations - Gets the locations where Coolr is available
-
-export interface GetPartnerCoolrLocationsQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export interface GetPartnerCoolrLocationsResponse {
-  locations?: CoolrLocations[];
-}
-
-export interface GetPartnerCoolrLocationsRequest
-  extends BaseRequest,
-    RequestQuery<GetPartnerCoolrLocationsQuery> {}
-
-// GET /partner/coolr/{id}/images - Gets the latest images for Coolr Location AssetID
-
-export interface GetPartnerCoolrImagesPath {
-  // location
-  id: string;
-}
-
-export interface GetPartnerCoolrImagesQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export interface GetPartnerCoolrImagesResponse {
-  images?: CoolrImages;
-}
-
-export interface GetPartnerCoolrImagesRequest
-  extends BaseRequest,
-    RequestQuery<GetPartnerCoolrImagesQuery>,
-    GetPartnerCoolrImagesPath {}
-
 // GET /partner/swagger.json
 
 export interface GetPartnerSwaggerQuery {

package/src/interface/payment.ts

@@ -263,29 +263,6 @@ export interface PostPaymentMethodRequest extends BaseRequest {
   body: PostPaymentMethodBody;
 }
 
-// GET /payment/{id}/method - Get a users available payment methods
-
-export interface GetPaymentMethodPath {
-  // TODO: add parameter to swagger.json
-  id: string;
-}
-
-export interface GetPaymentMethodQuery {
-  // The user id
-  user_id: string;
-  // Graphql query string
-  _query?: string;
-}
-
-export interface GetPaymentMethodResponse {
-  payment_methods?: PaymentMethod[];
-}
-
-export interface GetPaymentMethodRequest
-  extends BaseRequest,
-    RequestQuery<GetPaymentMethodQuery>,
-    GetPaymentMethodPath {}
-
 // DELETE /payment/{id}/method/{method_id}
 
 export interface DeletePaymentMethodPath {