@compassdigital/sdk.typescript 4.29.0 → 4.32.0

package/src/index.ts

@@ -13,8 +13,6 @@ import {
   PostPaymentConsumerResponse,
   PostPaymentMethodBody,
   PostPaymentMethodResponse,
-  DeletePaymentMethodBody,
-  DeletePaymentMethodResponse,
   GetPaymentTokenQuery,
   GetPaymentTokenResponse,
   PostPaymentTokenBody,
@@ -549,6 +547,14 @@ import {
   GetMenuV3LocalMenuGroupAllowedGlobalBrandsResponse,
   PostMenuV3LocalMenuGroupImportBrandsQuery,
   PostMenuV3LocalMenuGroupImportBrandsResponse,
+  GetMenuV3LocalMenuGroupSiteQuery,
+  GetMenuV3LocalMenuGroupSiteResponse,
+  GetMenuV3LocalMenuGroupMenuGroupQuery,
+  GetMenuV3LocalMenuGroupMenuGroupResponse,
+  PostMenuV3LocalMenuGroupsSiteGroupsBody,
+  PostMenuV3LocalMenuGroupsSiteGroupsResponse,
+  DeleteMenuV3LocalMenuGroupsSiteGroupsBody,
+  DeleteMenuV3LocalMenuGroupsSiteGroupsResponse,
   PostMenuV3GlobalMenuGroupBody,
   PostMenuV3GlobalMenuGroupResponse,
   GetMenuV3GlobalMenuGroupQuery,
@@ -931,6 +937,13 @@ import {
   GetCentricosLookerEmbedurlResponse,
 } from "./interface/centricos";
 
+import {
+  TaxHealthCheckQuery,
+  TaxHealthCheckResponse,
+  QuoteBody,
+  QuoteResponse,
+} from "./interface/tax";
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
 
@@ -938,7 +951,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * POST /payment/{id}/transaction
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
    * @param body
    * @param options - additional request options
    */
@@ -960,8 +973,8 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * POST /payment/{id}/transaction/{transaction_id}/refund
    *
-   * @param id - TODO: add parameter to swagger.json
-   * @param transaction_id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
+   * @param transaction_id - Transaction ID
    * @param body
    * @param options - additional request options
    */
@@ -984,7 +997,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * GET /payment/{id}/clienttoken
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
    * @param options - additional request options
    */
   get_payment_clienttoken(
@@ -1006,7 +1019,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * POST /payment/{id}/paymenttoken
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
    * @param body
    * @param options - additional request options
    */
@@ -1058,30 +1071,6 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("payment", "post_payment_method", "post", `/payment/method`, body, options);
   }
 
-  /**
-   * DELETE /payment/{id}/method/{method_id}
-   *
-   * @param id - TODO: add parameter to swagger.json
-   * @param method_id - TODO: add parameter to swagger.json
-   * @param body
-   * @param options - additional request options
-   */
-  delete_payment_method(
-    id: string,
-    method_id: string,
-    body: DeletePaymentMethodBody,
-    options?: RequestOptions,
-  ): ResponsePromise<DeletePaymentMethodResponse> {
-    return this.request(
-      "payment",
-      "delete_payment_method",
-      "delete",
-      `/payment/${id}/method/${method_id}`,
-      body,
-      options,
-    );
-  }
-
   /**
    * GET /payment/token
    *
@@ -1170,7 +1159,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * GET /payment/{id}/cashless
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
    * @param options - additional request options
    */
   get_payment_cashless(
@@ -1192,7 +1181,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * POST /payment/{id}/cashless
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
    * @param body
    * @param options - additional request options
    */
@@ -1214,7 +1203,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * DELETE /payment/{id}/cashless
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Payment ID
    * @param body
    * @param options - additional request options
    */
@@ -2573,7 +2562,7 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * POST /shoppingcart/ - Create a new ShoppingCart
+   * POST /shoppingcart - Create a new ShoppingCart
    *
    * @param body
    * @param options - additional request options
@@ -2586,7 +2575,7 @@ export class ServiceClient extends BaseServiceClient {
       "shoppingcart",
       "post_shoppingcart_cart",
       "post",
-      `/shoppingcart/`,
+      `/shoppingcart`,
       body,
       options,
     );
@@ -2723,7 +2712,7 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * PUT /shoppingcart/{id}/paymentmethod/ - Change payment method used in shopping cart
+   * PUT /shoppingcart/{id}/paymentmethod - Change payment method used in shopping cart
    *
    * @param id - Shopping cart ID
    * @param body
@@ -2738,7 +2727,7 @@ export class ServiceClient extends BaseServiceClient {
       "shoppingcart",
       "put_shoppingcart_cart_payment",
       "put",
-      `/shoppingcart/${id}/paymentmethod/`,
+      `/shoppingcart/${id}/paymentmethod`,
       body,
       options,
     );
@@ -2767,7 +2756,7 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * PUT /shoppingcart/{id}/order/ - Store information about the order created with this shopping cart
+   * PUT /shoppingcart/{id}/order - Store information about the order created with this shopping cart
    *
    * @param id - Shopping cart ID
    * @param body
@@ -2782,7 +2771,7 @@ export class ServiceClient extends BaseServiceClient {
       "shoppingcart",
       "put_shoppingcart_cart_order",
       "put",
-      `/shoppingcart/${id}/order/`,
+      `/shoppingcart/${id}/order`,
       body,
       options,
     );
@@ -3668,7 +3657,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * PUT /promo/voucher/{id} - Update voucher
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id
    * @param body
    * @param options - additional request options
    */
@@ -3683,7 +3672,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * DELETE /promo/voucher/{id} - Delete voucher
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id
    * @param options - additional request options
    */
   delete_promo_voucher(
@@ -3703,7 +3692,7 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * POST /promo/customer/ - Add user to voucherify
+   * POST /promo/customer - Add user to voucherify
    *
    * @param body
    * @param options - additional request options
@@ -3712,11 +3701,11 @@ export class ServiceClient extends BaseServiceClient {
     body: PostPromoCustomerBody,
     options?: RequestOptions,
   ): ResponsePromise<PostPromoCustomerResponse> {
-    return this.request("promo", "post_promo_customer", "post", `/promo/customer/`, body, options);
+    return this.request("promo", "post_promo_customer", "post", `/promo/customer`, body, options);
   }
 
   /**
-   * DELETE /promo/customer/ - Delete user from voucherify
+   * DELETE /promo/customer - Delete user from voucherify
    *
    * @param body
    * @param options - additional request options
@@ -3729,7 +3718,7 @@ export class ServiceClient extends BaseServiceClient {
       "promo",
       "delete_promo_customer",
       "delete",
-      `/promo/customer/`,
+      `/promo/customer`,
       body,
       options,
     );
@@ -5768,6 +5757,90 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /menu/v3/local-menu-group/{id}/site
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_local_menu_group_site(
+    id: string,
+    options?: {
+      query?: GetMenuV3LocalMenuGroupSiteQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetMenuV3LocalMenuGroupSiteResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_local_menu_group_site",
+      "get",
+      `/menu/v3/local-menu-group/${id}/site`,
+      null,
+      options,
+    );
+  }
+
+  /**
+   * GET /menu/v3/local-menu-group/{id}/menu-group
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_local_menu_group_menu_group(
+    id: string,
+    options?: {
+      query?: GetMenuV3LocalMenuGroupMenuGroupQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetMenuV3LocalMenuGroupMenuGroupResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_local_menu_group_menu_group",
+      "get",
+      `/menu/v3/local-menu-group/${id}/menu-group`,
+      null,
+      options,
+    );
+  }
+
+  /**
+   * POST /menu/v3/local-menu-groups/site-groups
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v3_local_menu_groups_site_groups(
+    body: PostMenuV3LocalMenuGroupsSiteGroupsBody,
+    options?: RequestOptions,
+  ): ResponsePromise<PostMenuV3LocalMenuGroupsSiteGroupsResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v3_local_menu_groups_site_groups",
+      "post",
+      `/menu/v3/local-menu-groups/site-groups`,
+      body,
+      options,
+    );
+  }
+
+  /**
+   * DELETE /menu/v3/local-menu-groups/site-groups
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  delete_menu_v3_local_menu_groups_site_groups(
+    body: DeleteMenuV3LocalMenuGroupsSiteGroupsBody,
+    options?: RequestOptions,
+  ): ResponsePromise<DeleteMenuV3LocalMenuGroupsSiteGroupsResponse> {
+    return this.request(
+      "menu",
+      "delete_menu_v3_local_menu_groups_site_groups",
+      "delete",
+      `/menu/v3/local-menu-groups/site-groups`,
+      body,
+      options,
+    );
+  }
+
   /**
    * POST /menu/v3/global-menu-group
    *
@@ -9290,8 +9363,8 @@ export class ServiceClient extends BaseServiceClient {
    * @param options - additional request options
    */
   get_payment_list_by_brand(
-    options: {
-      query: GetPaymentListByBrandQuery;
+    options?: {
+      query?: GetPaymentListByBrandQuery;
     } & RequestOptions,
   ): ResponsePromise<GetPaymentListByBrandResponse> {
     return this.request(
@@ -9509,4 +9582,27 @@ export class ServiceClient extends BaseServiceClient {
       options,
     );
   }
+
+  /**
+   * GET /tax/v1/health-check - Health Check
+   *
+   * @param options - additional request options
+   */
+  tax_health_check(
+    options?: {
+      query?: TaxHealthCheckQuery;
+    } & RequestOptions,
+  ): ResponsePromise<TaxHealthCheckResponse> {
+    return this.request("tax", "tax_health_check", "get", `/tax/v1/health-check`, null, options);
+  }
+
+  /**
+   * POST /tax/quote - get tax quote from 3rd party tax library
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  quote(body: QuoteBody, options?: RequestOptions): ResponsePromise<QuoteResponse> {
+    return this.request("tax", "quote", "post", `/tax/quote`, body, options);
+  }
 }

package/src/interface/consumer.ts

@@ -93,7 +93,9 @@ export interface HealthCheckControllerExecuteRequest
 
 export interface GetPaymentListByBrandQuery {
   // Brand ID as Encoded CDL ID
-  brandID: string;
+  brandID?: string;
+  // Site ID as Encoded CDL ID
+  siteID?: string;
   // Graphql query string
   _query?: string;
 }

package/src/interface/location.ts

@@ -257,8 +257,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: Record<string, any>;
-    deliveryHours?: Record<string, any>;
+    hours?: Hours[];
+    deliveryHours?: DeliveryHours[];
     service_fee?: {
       type?: string;
       value?: number;
@@ -521,7 +521,7 @@ export interface GetLocationQuery {
   // When fetching location, brands will come with private and public configs
   include_brands_config?: boolean;
   // active cafes
-  active_cafes?: Record<string, any>[];
+  active_cafes?: string[];
   // show additional hidden properties/entities
   extended?: boolean;
   // Graphql query string

package/src/interface/menu.ts

@@ -34,7 +34,6 @@ export interface Menu {
     item_desc_edit_enabled?: boolean;
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
-    frictionless?: boolean;
   };
   meta?: {
     // User ID
@@ -645,6 +644,7 @@ export interface DraftModifierGroupDTO {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: FilterFieldDTO;
+  is_incremental?: FilterFieldDTO;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
   changes?: ModifierGroupChangeDTO[];
@@ -749,7 +749,6 @@ export interface MenuWorksDTO {
   portion_unit_name?: FilterFieldDTO;
   grams?: number;
   cost?: number;
-  calories?: number;
   id?: Record<string, any>;
   [index: string]: any;
 }
@@ -835,6 +834,23 @@ export interface BrandStatusDTO {
   [index: string]: any;
 }
 
+export interface SiteGroupWithMenuGroupNameResponseDTO {
+  site_id: string;
+  local_menu_group_id: string;
+  local_menu_group_name: string;
+  created_at?: string;
+  updated_at?: string;
+  [index: string]: any;
+}
+
+export interface SiteGroupDTO {
+  site_id: string;
+  local_menu_group_id: string;
+  created_at?: string;
+  updated_at?: string;
+  [index: string]: any;
+}
+
 export interface DraftMenuDraftMenuDTO {
   applied_diff_snapshot?: FilterFieldDTO;
   parent_id?: FilterFieldDTO;
@@ -907,6 +923,7 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
   order_type?: FilterFieldDTO;
   sizing?: FilterFieldDTO;
   is_out_of_stock?: FilterFieldDTO;
+  is_incremental?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1107,6 +1124,7 @@ export interface PublishedModifierGroupDTO {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1671,6 +1689,7 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
   order_type?: FilterFieldDTO;
   sizing?: FilterFieldDTO;
   is_out_of_stock?: FilterFieldDTO;
+  is_incremental?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1896,6 +1915,8 @@ export interface GetMenuQuery {
   show_unlinked?: boolean;
   // Show items and modifiers with weight
   include_items_with_weight?: boolean;
+  // Show out of stock entities, lower in priority to hidden and disabled
+  show_out_of_stock?: boolean;
   // Graphql query string
   _query?: string;
   nocache?: boolean;
@@ -2706,6 +2727,76 @@ export interface PostMenuV3LocalMenuGroupImportBrandsRequest
     RequestQuery<PostMenuV3LocalMenuGroupImportBrandsQuery>,
     PostMenuV3LocalMenuGroupImportBrandsPath {}
 
+// GET /menu/v3/local-menu-group/{id}/site
+
+export interface GetMenuV3LocalMenuGroupSitePath {
+  id: string;
+}
+
+export interface GetMenuV3LocalMenuGroupSiteQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3LocalMenuGroupSiteResponse {
+  results?: SiteGroupWithMenuGroupNameResponseDTO[];
+}
+
+export interface GetMenuV3LocalMenuGroupSiteRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3LocalMenuGroupSiteQuery>,
+    GetMenuV3LocalMenuGroupSitePath {}
+
+// GET /menu/v3/local-menu-group/{id}/menu-group
+
+export interface GetMenuV3LocalMenuGroupMenuGroupPath {
+  id: string;
+}
+
+export interface GetMenuV3LocalMenuGroupMenuGroupQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3LocalMenuGroupMenuGroupResponse {
+  results?: SiteGroupWithMenuGroupNameResponseDTO[];
+}
+
+export interface GetMenuV3LocalMenuGroupMenuGroupRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3LocalMenuGroupMenuGroupQuery>,
+    GetMenuV3LocalMenuGroupMenuGroupPath {}
+
+// POST /menu/v3/local-menu-groups/site-groups
+
+export type PostMenuV3LocalMenuGroupsSiteGroupsBody = {
+  site_id: string;
+  local_menu_group_id: string;
+  created_at?: string;
+  updated_at?: string;
+  [index: string]: any;
+}[];
+
+export interface PostMenuV3LocalMenuGroupsSiteGroupsResponse {
+  results?: SiteGroupDTO[];
+}
+
+export interface PostMenuV3LocalMenuGroupsSiteGroupsRequest extends BaseRequest {
+  body: PostMenuV3LocalMenuGroupsSiteGroupsBody;
+}
+
+// DELETE /menu/v3/local-menu-groups/site-groups
+
+export type DeleteMenuV3LocalMenuGroupsSiteGroupsBody = SiteGroupDTO[];
+
+export interface DeleteMenuV3LocalMenuGroupsSiteGroupsResponse {
+  results?: SiteGroupDTO[];
+}
+
+export interface DeleteMenuV3LocalMenuGroupsSiteGroupsRequest extends BaseRequest {
+  body: DeleteMenuV3LocalMenuGroupsSiteGroupsBody;
+}
+
 // POST /menu/v3/global-menu-group
 
 export interface PostMenuV3GlobalMenuGroupBody {
@@ -5396,6 +5487,7 @@ export interface PostMenuV3DraftModifierGroupBody {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5456,6 +5548,7 @@ export interface PatchMenuV3DraftModifierGroupBody {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5536,6 +5629,7 @@ export type PostMenuV3DraftModifierGroupsBody = {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5601,6 +5695,7 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -6433,19 +6528,19 @@ export interface GetMenuV3GlobalDiffsCountRequest
 
 export interface GetMenuV3MenuworksQuery {
   unit_id?: string;
-  MRN?: string;
+  MRN?: number;
   // Graphql query string
   _query?: string;
 }
 
 export interface GetMenuV3MenuworksResponse {
+  calories?: number;
   MRN?: string;
   unit_id?: string;
   portion_quantity?: number;
   portion_unit_name?: string;
   grams?: number;
   cost?: number;
-  calories?: number;
   [index: string]: any;
 }
 

package/src/interface/partner.ts

@@ -335,8 +335,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: Record<string, any>;
-    deliveryHours?: Record<string, any>;
+    hours?: Hours[];
+    deliveryHours?: DeliveryHours[];
     service_fee?: {
       type?: string;
       value?: number;
@@ -574,6 +574,7 @@ export interface Menu {
     item_desc_edit_enabled?: boolean;
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
+    frictionless?: boolean;
   };
   meta?: {
     // User ID