@compassdigital/sdk.typescript 3.66.0 → 3.68.0

package/src/interface/menu.ts

@@ -1,4 +1,4 @@
-// /* eslint-disable */
+/* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
 import { RequestQuery, BaseRequest } from "./util";
@@ -501,7 +501,7 @@ export interface BrandChangeDTO {
 }
 
 export interface POSIDSegmentDTO {
-  value?: string;
+  value?: FilterFieldDTO;
   modifier_id?: string;
   published_modifier?: PublishedModifierDTO;
   draft_modifier?: DraftModifierDTO;
@@ -533,9 +533,9 @@ export interface PublishedModifierDTO {
   tax_tags?: FilterFieldDTO[];
   is_active?: boolean;
   posid?: FilterFieldDTO;
+  reporting?: any;
   brand_id?: string;
   brand?: PublishedBrandDTO;
-  reporting?: any;
   weight?: any;
   permissions?: FilterFieldDTO;
   [index: string]: any;
@@ -601,6 +601,7 @@ export interface PublishedItemDTO {
   name?: string;
   label?: string;
   description?: string;
+  reporting?: ReportingMetadataDTO;
   price?: number;
   barcode?: string;
   calories?: number;
@@ -608,9 +609,9 @@ export interface PublishedItemDTO {
   posid?: FilterFieldDTO;
   tax_tags?: FilterFieldDTO[];
   brand_id?: string;
+  line_route?: FilterFieldDTO;
   brand?: PublishedBrandDTO;
   categories?: PublishedCategoryToItemRelationshipDTO[];
-  reporting?: ReportingMetadataDTO;
   attachments?: FileAttachmentsDTO;
   weight?: WeightDTO;
   permissions?: FilterFieldDTO;
@@ -705,11 +706,11 @@ export interface DraftModifierDTO {
   tax_tags?: FilterFieldDTO[];
   is_active?: boolean;
   posid?: FilterFieldDTO;
+  reporting?: any;
   brand_id?: string;
   brand?: any;
   changes?: ModifierChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: any;
   weight?: any;
   permissions?: FilterFieldDTO;
   [index: string]: any;
@@ -781,6 +782,7 @@ export interface DraftItemDTO {
   name?: string;
   label?: string;
   description?: string;
+  reporting?: any;
   price?: number;
   barcode?: string;
   calories?: number;
@@ -788,11 +790,11 @@ export interface DraftItemDTO {
   posid?: FilterFieldDTO;
   tax_tags?: FilterFieldDTO[];
   brand_id?: string;
+  line_route?: FilterFieldDTO;
   brand?: any;
   categories?: DraftCategoryToItemRelationshipDTO[];
   changes?: ItemChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: any;
   attachments?: any;
   weight?: any;
   permissions?: FilterFieldDTO;
@@ -1026,6 +1028,7 @@ export interface DraftItemDraftItemDTO {
   posid?: FilterFieldDTO;
   tax_tags?: FilterFieldDTO[];
   brand_id?: FilterFieldDTO;
+  line_route?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1051,45 +1054,45 @@ export interface ReportingCategorySuggestion {
   occurrences?: number;
 }
 
-export interface DiffDTO {
-  action: string;
-  id?: string;
-  created_at?: string;
-  updated_at?: string;
-  deleted_at?: string;
-  child_nodes?: any[];
-  name?: string;
-  entity_type?: string;
-  local_id?: string;
-  changes?: any;
-  local_snapshot?: any;
-  global_id?: string;
-  global_snapshot?: any;
-  brand_id?: string;
-  version?: number;
-  depends_on?: GlobalDiffDependencyDTO[];
-  is_depended_by?: any[];
-  brand?: DraftBrandDTO;
-  permissions?: any;
-  [index: string]: any;
-}
-
 export interface GlobalDiffDependencyDTO {
   depends_on_id?: string;
   is_depended_by_id?: string;
   id?: string;
-  depends_on?: GlobalDiffDTO;
+  depends_on?: GlobalDiffGlobalDiffDTO;
   is_depended_by?: any;
-  permissions?: any;
+  permissions?: FilterFieldDTO;
   [index: string]: any;
 }
 
-export interface GlobalDiffDTO {
+export interface GlobalDiffGlobalDiffDTO {
+  action?: FilterFieldDTO;
+  entity_type?: FilterFieldDTO;
+  local_id?: FilterFieldDTO;
+  changes?: FilterFieldDTO;
+  local_snapshot?: FilterFieldDTO;
+  global_id?: FilterFieldDTO;
+  global_snapshot?: FilterFieldDTO;
+  brand_id?: FilterFieldDTO;
+  id?: FilterFieldDTO;
+  version?: FilterFieldDTO;
+  created_at?: FilterFieldDTO;
+  updated_at?: FilterFieldDTO;
+  deleted_at?: FilterFieldDTO;
+  depends_on?: any[];
+  is_depended_by?: any[];
+  brand?: DraftBrandDTO;
+  permissions?: FilterFieldDTO;
+  [index: string]: any;
+}
+
+export interface DiffDTO {
   action: string;
   id?: string;
   created_at?: string;
   updated_at?: string;
   deleted_at?: string;
+  child_nodes?: any[];
+  name?: string;
   entity_type?: string;
   local_id?: string;
   changes?: any;
@@ -1098,8 +1101,8 @@ export interface GlobalDiffDTO {
   global_snapshot?: any;
   brand_id?: string;
   version?: number;
-  depends_on?: any[];
-  is_depended_by?: any[];
+  depends_on?: GlobalDiffDependencyDTO[];
+  is_depended_by?: GlobalDiffDependencyDTO[];
   brand?: DraftBrandDTO;
   permissions?: any;
   [index: string]: any;
@@ -1253,6 +1256,7 @@ export interface PublishedItemPublishedItemDTO {
   posid?: FilterFieldDTO;
   tax_tags?: FilterFieldDTO[];
   brand_id?: FilterFieldDTO;
+  line_route?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1404,6 +1408,27 @@ export interface PublishedModifierPublishedModifierDTO {
   [index: string]: any;
 }
 
+export interface GlobalDiffDTO {
+  action: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  entity_type?: string;
+  local_id?: string;
+  changes?: any;
+  local_snapshot?: any;
+  global_id?: string;
+  global_snapshot?: any;
+  brand_id?: string;
+  version?: number;
+  depends_on?: GlobalDiffDependencyDTO[];
+  is_depended_by?: GlobalDiffDependencyDTO[];
+  brand?: DraftBrandDTO;
+  permissions?: any;
+  [index: string]: any;
+}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {
@@ -2939,6 +2964,20 @@ export interface GetMenuV3DraftBrandDiffsPath {
 }
 
 export interface GetMenuV3DraftBrandDiffsQuery {
+  // If specified, only the selected fields will be returned
+  select?: string[];
+  // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
+  relationships?: string[];
+  // The fields that filtering is allowed on
+  filter?: any;
+  // Number of records to load per page
+  limit?: number;
+  page?: number;
+  // A field to sort the results based on
+  sort_by?: string;
+  sort_order?: string;
+  // How soft deleted records should be shown in the list
+  soft_deleted?: string;
   // Graphql query string
   _query?: string;
 }
@@ -4165,6 +4204,7 @@ export interface PostMenuV3DraftItemBody {
   name: string;
   label?: string;
   description?: string;
+  reporting: ReportingMetadataDTO;
   price: number;
   barcode?: string;
   calories?: number;
@@ -4172,12 +4212,12 @@ export interface PostMenuV3DraftItemBody {
   posid?: string;
   tax_tags?: any[];
   brand_id: string;
+  line_route?: string;
   id?: any;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
   changes?: ItemChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: ReportingMetadataDTO;
   attachments?: FileAttachmentsDTO;
   weight?: WeightDTO;
   permissions?: any;
@@ -4228,6 +4268,7 @@ export interface PatchMenuV3DraftItemBody {
   name?: string;
   label?: string;
   description?: string;
+  reporting?: ReportingMetadataDTO;
   price?: number;
   barcode?: string;
   calories?: number;
@@ -4235,11 +4276,11 @@ export interface PatchMenuV3DraftItemBody {
   posid?: string;
   tax_tags?: any[];
   brand_id?: string;
+  line_route?: string;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
   changes?: ItemChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: ReportingMetadataDTO;
   attachments?: FileAttachmentsDTO;
   weight?: WeightDTO;
   permissions?: any;
@@ -4304,6 +4345,7 @@ export type PostMenuV3DraftItemsBody = {
   name: string;
   label?: string;
   description?: string;
+  reporting: ReportingMetadataDTO;
   price: number;
   barcode?: string;
   calories?: number;
@@ -4311,12 +4353,12 @@ export type PostMenuV3DraftItemsBody = {
   posid?: string;
   tax_tags?: any[];
   brand_id: string;
+  line_route?: string;
   id?: any;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
   changes?: ItemChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: ReportingMetadataDTO;
   attachments?: FileAttachmentsDTO;
   weight?: WeightDTO;
   permissions?: any;
@@ -4351,6 +4393,47 @@ export interface GetMenuV3DraftItemsCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV3DraftItemsCountQuery> {}
 
+// PATCH /menu/v3/draft/items/bulk-update
+
+export interface PatchMenuV3DraftItemsBulkUpdateBody {
+  id_list: any[];
+  parent?: DraftItemDTO;
+  children?: DraftItemDTO[];
+  posid_segment?: POSIDSegmentDTO;
+  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
+  id?: string;
+  parent_id?: string;
+  name?: string;
+  label?: string;
+  description?: string;
+  reporting?: ReportingMetadataDTO;
+  price?: number;
+  barcode?: string;
+  calories?: number;
+  is_active?: boolean;
+  posid?: string;
+  tax_tags?: any[];
+  brand_id?: string;
+  line_route?: string;
+  brand?: DraftBrandDTO;
+  categories?: DraftCategoryToItemRelationshipDTO[];
+  changes?: ItemChangeDTO[];
+  vendor_metadata?: VendorMetadataDTO[];
+  attachments?: FileAttachmentsDTO;
+  weight?: WeightDTO;
+  permissions?: any;
+  [index: string]: any;
+}
+
+export interface PatchMenuV3DraftItemsBulkUpdateResponse {
+  results: any[];
+  [index: string]: any;
+}
+
+export interface PatchMenuV3DraftItemsBulkUpdateRequest extends BaseRequest {
+  body: PatchMenuV3DraftItemsBulkUpdateBody;
+}
+
 // POST /menu/v3/item/{id}/attachment/{name}
 
 export interface PostMenuV3ItemAttachmentPath {
@@ -4371,6 +4454,22 @@ export interface PostMenuV3ItemAttachmentRequest
     RequestQuery<PostMenuV3ItemAttachmentQuery>,
     PostMenuV3ItemAttachmentPath {}
 
+// POST /menu/v3/items/import
+
+export interface PostMenuV3ItemsImportQuery {
+  "body.brand_id"?: string;
+  "body.data"?: string;
+}
+
+export interface PostMenuV3ItemsImportResponse {
+  results: any[];
+  [index: string]: any;
+}
+
+export interface PostMenuV3ItemsImportRequest
+  extends BaseRequest,
+    RequestQuery<PostMenuV3ItemsImportQuery> {}
+
 // GET /menu/v3/item/{id}
 
 export interface GetMenuV3ItemPath {
@@ -5210,12 +5309,12 @@ export interface PostMenuV3DraftModifierBody {
   tax_tags?: any[];
   is_active?: boolean;
   posid?: string;
+  reporting: ReportingMetadataDTO;
   brand_id: string;
   id?: any;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: ReportingMetadataDTO;
   weight?: WeightDTO;
   permissions?: any;
   [index: string]: any;
@@ -5270,11 +5369,11 @@ export interface PatchMenuV3DraftModifierBody {
   tax_tags?: any[];
   is_active?: boolean;
   posid?: string;
+  reporting?: ReportingMetadataDTO;
   brand_id?: string;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: ReportingMetadataDTO;
   weight?: WeightDTO;
   permissions?: any;
   [index: string]: any;
@@ -5345,12 +5444,12 @@ export type PostMenuV3DraftModifiersBody = {
   tax_tags?: any[];
   is_active?: boolean;
   posid?: string;
+  reporting: ReportingMetadataDTO;
   brand_id: string;
   id?: any;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
   vendor_metadata?: VendorMetadataDTO[];
-  reporting?: ReportingMetadataDTO;
   weight?: WeightDTO;
   permissions?: any;
   [index: string]: any;
@@ -5384,6 +5483,43 @@ export interface GetMenuV3DraftModifiersCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV3DraftModifiersCountQuery> {}
 
+// PATCH /menu/v3/draft/modifiers/bulk-update
+
+export interface PatchMenuV3DraftModifiersBulkUpdateBody {
+  id_list: any[];
+  parent?: DraftModifierDTO;
+  children?: DraftModifierDTO[];
+  posid_segment?: POSIDSegmentDTO;
+  modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
+  id?: string;
+  parent_id?: string;
+  name?: string;
+  label?: string;
+  description?: string;
+  price?: number;
+  calories?: number;
+  tax_tags?: any[];
+  is_active?: boolean;
+  posid?: string;
+  reporting?: ReportingMetadataDTO;
+  brand_id?: string;
+  brand?: DraftBrandDTO;
+  changes?: ModifierChangeDTO[];
+  vendor_metadata?: VendorMetadataDTO[];
+  weight?: WeightDTO;
+  permissions?: any;
+  [index: string]: any;
+}
+
+export interface PatchMenuV3DraftModifiersBulkUpdateResponse {
+  results: any[];
+  [index: string]: any;
+}
+
+export interface PatchMenuV3DraftModifiersBulkUpdateRequest extends BaseRequest {
+  body: PatchMenuV3DraftModifiersBulkUpdateBody;
+}
+
 // GET /menu/v3/modifier/{id}
 
 export interface GetMenuV3ModifierPath {
@@ -5488,7 +5624,26 @@ export interface GetMenuV3GlobalDiffQuery {
   _query?: string;
 }
 
-export type GetMenuV3GlobalDiffResponse = GlobalDiffDTO;
+export interface GetMenuV3GlobalDiffResponse {
+  action: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  entity_type?: string;
+  local_id?: string;
+  changes?: any;
+  local_snapshot?: any;
+  global_id?: string;
+  global_snapshot?: any;
+  brand_id?: string;
+  version?: number;
+  depends_on?: GlobalDiffDependencyDTO[];
+  is_depended_by?: GlobalDiffDependencyDTO[];
+  brand?: DraftBrandDTO;
+  permissions?: any;
+  [index: string]: any;
+}
 
 export interface GetMenuV3GlobalDiffRequest
   extends BaseRequest,

package/src/interface/notification.ts

@@ -1,4 +1,4 @@
-// /* eslint-disable */
+/* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
 import { RequestQuery, BaseRequest } from "./util";

package/src/interface/payment.ts

@@ -118,6 +118,7 @@ export interface Options {
   submitForSettlement?: boolean;
   exact_gateway_id?: string;
   exact_gateway_password?: string;
+  invoice_number?: string;
   // brand
   brand?: string;
   // location

package/src/interface/promo.ts

@@ -186,11 +186,7 @@ export interface UpdateVoucher {
 export interface Voucher {
   code?: string;
   valid?: boolean;
-  discount?: {
-    amount_off?: number;
-    percent_off?: number;
-    amount_limit?: number;
-  };
+  discount?: AppliedDiscount;
   app?: string;
   provider_data?: FPValidationData;
   [index: string]: any;
@@ -202,11 +198,7 @@ export interface Redemption {
   id?: string;
   date?: string;
   result?: boolean;
-  discount?: {
-    amount_off?: number;
-    percent_off?: number;
-    amount_limit?: number;
-  };
+  discount?: AppliedDiscount;
   type?: string;
   app?: string;
   [index: string]: any;
@@ -281,6 +273,13 @@ export interface FPValidationData {
   [index: string]: any;
 }
 
+export interface AppliedDiscount {
+  type?: string;
+  amount_off?: number;
+  percent_off?: number;
+  amount_limit?: number;
+}
+
 export type VoucherCode = PromoValidateRequest;
 
 // POST /promo - Create a new promotion

package/src/interface/shoppingcart.ts

@@ -154,23 +154,27 @@ export interface CashlessTender {
   total?: MonetaryValue;
   tender?: string;
   name?: string;
+  type?: PaymentType;
 }
 
 export interface Mealplan {
   id?: string;
   tender?: string;
   total?: MonetaryValue;
+  type?: PaymentType;
 }
 
 export interface CreditCard {
   card_type?: string;
   last4?: string;
   total?: MonetaryValue;
+  type?: PaymentType;
 }
 
 export interface DigitalWalletPay {
   wallet_type?: string;
   total?: MonetaryValue;
+  type?: PaymentType;
 }
 
 export interface MealSwipes {
@@ -181,11 +185,13 @@ export interface MealSwipes {
   swipes?: MonetaryValue;
   rate?: MonetaryValue;
   total?: MonetaryValue;
+  type?: PaymentType;
 }
 
 export interface MealExchange {
   id?: string;
   tender?: string;
+  type?: PaymentType;
 }
 
 export interface Payment {
@@ -405,6 +411,8 @@ export type IntegerValue = number;
 
 export type Quantity = IntegerValue;
 
+export type PaymentType = string;
+
 // POST /shoppingcart/ - Create a new ShoppingCart
 
 export type PostShoppingcartCartBody = ShoppingCartRequest;

package/src/interface/user.ts

@@ -1,4 +1,4 @@
-// /* eslint-disable */
+/* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
 import { RequestQuery, BaseRequest } from "./util";
@@ -57,6 +57,12 @@ export interface User {
       failed_attempts?: number;
       consecutive_failed_attempts?: number;
     };
+    cashless?: {
+      stipend?: CashlessLog;
+      voucher?: CashlessLog;
+      badge_pay?: CashlessLog;
+      coupon_voucher?: CashlessLog;
+    };
     [index: string]: any;
   };
   is?: {
@@ -73,6 +79,11 @@ export interface User {
   location_group?: string;
 }
 
+export interface CashlessLog {
+  added?: string;
+  deleted?: string;
+}
+
 export interface GuestUserCreate {
   email?: string;
   name?: {
@@ -784,7 +795,6 @@ export type PostUserEmbedurlBody = any;
 export interface PostUserEmbedurlResponse {
   // Embed url
   embed_url?: string;
-  oauth?: string;
 }
 
 export interface PostUserEmbedurlRequest extends BaseRequest {

package/src/interface/vendor.ts

@@ -1,4 +1,4 @@
-// /* eslint-disable */
+/* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
 import { RequestQuery, BaseRequest } from "./util";