@compassdigital/sdk.typescript 3.49.0 → 3.50.0

package/src/interface/menu.ts

@@ -526,27 +526,24 @@ export interface CategoryDTO {
   is_active?: boolean;
   layout_id?: string;
   id?: string;
-  layout?: LayoutDTO;
-  items?: any[];
   [index: string]: any;
 }
 
 export interface LayoutDTO {
   name: string;
-  categories?: any[];
+  categories?: CategoryDTO[];
   brand_id: string;
   station_id: string;
-  id?: any;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
   brand?: BrandDTO;
-  station?: any;
+  station?: StationDTO;
   [index: string]: any;
 }
 
 export interface BrandDTO {
-  layouts?: any[];
-  items?: ItemDTO[];
-  modifier_groups?: any[];
-  modifiers?: any[];
   id?: string;
   [index: string]: any;
 }
@@ -563,13 +560,9 @@ export interface ItemDTO {
   is_in_stock?: boolean;
   posid?: string;
   tax_tags?: string[];
-  modifier_groups?: ItemToModifierGroupRelationshipDTO[];
   brand_id?: string;
   station_id?: string;
   id?: string;
-  categories?: CategoryToItemRelationshipDTO[];
-  brand?: any;
-  station?: any;
   [index: string]: any;
 }
 
@@ -578,8 +571,6 @@ export interface ItemToModifierGroupRelationshipDTO {
   item_id?: string;
   sequence?: number;
   id?: string;
-  modifier_group?: ModifierGroupDTO;
-  item?: any;
   [index: string]: any;
 }
 
@@ -590,13 +581,9 @@ export interface ModifierGroupDTO {
   max?: number;
   is_active?: boolean;
   priority?: number;
-  modifiers?: ModifierGroupToModifierRelationshipDTO[];
-  items?: any[];
   brand_id?: string;
   station_id?: string;
   id?: string;
-  brand?: any;
-  station?: any;
   [index: string]: any;
 }
 
@@ -605,8 +592,6 @@ export interface ModifierGroupToModifierRelationshipDTO {
   modifier_group_id?: string;
   sequence?: number;
   id?: string;
-  modifier?: ModifierDTO;
-  modifier_group?: any;
   [index: string]: any;
 }
 
@@ -621,21 +606,15 @@ export interface ModifierDTO {
   is_active?: boolean;
   is_in_stock?: boolean;
   posid?: string;
-  modifier_groups?: any[];
   brand_id?: string;
   station_id?: string;
   id?: string;
-  brand?: any;
-  station?: StationDTO;
   [index: string]: any;
 }
 
 export interface StationDTO {
-  layouts?: any[];
-  items?: any[];
-  modifier_groups?: any[];
-  modifiers?: any[];
   id?: string;
+  name?: string;
   [index: string]: any;
 }
 
@@ -644,8 +623,6 @@ export interface CategoryToItemRelationshipDTO {
   item_id?: string;
   sequence?: number;
   id?: string;
-  category?: any;
-  item?: any;
   [index: string]: any;
 }
 
@@ -677,7 +654,7 @@ export interface NotFoundErrorDTO {
 
 export interface FilterFieldDTO {
   // Alternatively you can pass in the value directly (like '{ key: value }' instead of '{ key : { $equal : value } }
-  $equal?: string;
+  $equals?: string;
   $more_than?: string;
   $more_than_or_equal?: string;
   $less_than?: string;
@@ -728,6 +705,78 @@ export interface PaginationMetaDTO {
   [index: string]: any;
 }
 
+export interface UnauthorizedErrorDTO {
+  number: number;
+  message: string;
+  [index: string]: any;
+}
+
+export interface ModifierEntityDTO {
+  name: string;
+  label?: string;
+  description?: string;
+  price: number;
+  calories?: number;
+  priority?: number;
+  tax_tags?: string[];
+  is_active?: boolean;
+  is_in_stock?: boolean;
+  posid: string;
+  modifier_groups?: ModifierGroupToModifierRelationshipDTO[];
+  brand_id: string;
+  station_id?: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
+
+export interface ModifierGroupEntityDTO {
+  name: string;
+  label?: string;
+  min?: number;
+  max?: number;
+  is_active?: boolean;
+  priority?: number;
+  modifiers?: ModifierGroupToModifierRelationshipDTO[];
+  items?: ItemToModifierGroupRelationshipDTO[];
+  brand_id: string;
+  station_id?: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
+
+export interface ItemEntityDTO {
+  name: string;
+  label?: string;
+  description?: string;
+  price: number;
+  calories?: number;
+  priority?: number;
+  tax_tags?: string[];
+  is_active?: boolean;
+  is_in_stock?: boolean;
+  posid: string;
+  modifier_groups?: ModifierGroupToModifierRelationshipDTO[];
+  brand_id: string;
+  station_id?: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
+
 // GET /menu/v3/modifiers
 
 export interface GetMenuV3ModifiersQuery {
@@ -871,7 +920,6 @@ export interface PostMenuV3ModifierBody {
   modifier_groups?: ModifierGroupToModifierRelationshipDTO[];
   brand_id: string;
   station_id?: string;
-  id?: any;
   brand?: BrandDTO;
   station?: StationDTO;
   [index: string]: any;
@@ -971,7 +1019,6 @@ export interface PostMenuV3ModifierGroupBody {
   items?: ItemToModifierGroupRelationshipDTO[];
   brand_id: string;
   station_id?: string;
-  id?: any;
   brand?: BrandDTO;
   station?: StationDTO;
   [index: string]: any;
@@ -1120,7 +1167,6 @@ export interface PostMenuV3ModifierGroupRelationshipsModifierBody {
   modifier_id: string;
   modifier_group_id: string;
   sequence?: number;
-  id?: any;
   modifier?: ModifierDTO;
   modifier_group?: ModifierGroupDTO;
   [index: string]: any;
@@ -1340,7 +1386,6 @@ export interface PostMenuV3ItemBody {
   modifier_groups?: ItemToModifierGroupRelationshipDTO[];
   brand_id: string;
   station_id?: string;
-  id?: any;
   categories?: CategoryToItemRelationshipDTO[];
   brand?: BrandDTO;
   station?: StationDTO;
@@ -1430,7 +1475,6 @@ export interface PostMenuV3ItemRelationshipsModifierGroupBody {
   modifier_group_id: string;
   item_id: string;
   sequence?: number;
-  id?: any;
   modifier_group?: ModifierGroupDTO;
   item?: ItemDTO;
   [index: string]: any;
@@ -1603,7 +1647,19 @@ export interface GetMenuV3LayoutQuery {
   _query?: string;
 }
 
-export type GetMenuV3LayoutResponse = LayoutDTO;
+export interface GetMenuV3LayoutResponse {
+  name: string;
+  categories?: CategoryDTO[];
+  brand_id: string;
+  station_id: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
 
 export interface GetMenuV3LayoutRequest
   extends BaseRequest,
@@ -1627,7 +1683,19 @@ export interface PatchMenuV3LayoutBody {
   [index: string]: any;
 }
 
-export type PatchMenuV3LayoutResponse = LayoutDTO;
+export interface PatchMenuV3LayoutResponse {
+  name: string;
+  categories?: CategoryDTO[];
+  brand_id: string;
+  station_id: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
 
 export interface PatchMenuV3LayoutRequest extends BaseRequest, PatchMenuV3LayoutPath {
   body: PatchMenuV3LayoutBody;
@@ -1639,7 +1707,19 @@ export interface DeleteMenuV3LayoutPath {
   id: string;
 }
 
-export type DeleteMenuV3LayoutResponse = LayoutDTO;
+export interface DeleteMenuV3LayoutResponse {
+  name: string;
+  categories?: CategoryDTO[];
+  brand_id: string;
+  station_id: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
 
 export interface DeleteMenuV3LayoutRequest extends BaseRequest, DeleteMenuV3LayoutPath {}
 
@@ -1650,13 +1730,24 @@ export interface PostMenuV3LayoutBody {
   categories?: CategoryDTO[];
   brand_id: string;
   station_id: string;
-  id?: any;
-  brand?: any;
-  station?: any;
+  brand?: BrandDTO;
+  station?: StationDTO;
   [index: string]: any;
 }
 
-export type PostMenuV3LayoutResponse = LayoutDTO;
+export interface PostMenuV3LayoutResponse {
+  name: string;
+  categories?: CategoryDTO[];
+  brand_id: string;
+  station_id: string;
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  brand?: BrandDTO;
+  station?: StationDTO;
+  [index: string]: any;
+}
 
 export interface PostMenuV3LayoutRequest extends BaseRequest {
   body: PostMenuV3LayoutBody;
@@ -1680,37 +1771,6 @@ export interface GetMenuV3LayoutsCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV3LayoutsCountQuery> {}
 
-// GET /menu/v3/categories
-
-export interface GetMenuV3CategoriesQuery {
-  // 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;
-  // 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[];
-  // Graphql query string
-  _query?: string;
-}
-
-export interface GetMenuV3CategoriesResponse {
-  meta: PaginationMetaDTO;
-  results: CategoryDTO[];
-  [index: string]: any;
-}
-
-export interface GetMenuV3CategoriesRequest
-  extends BaseRequest,
-    RequestQuery<GetMenuV3CategoriesQuery> {}
-
 // GET /menu/v3/category/{id}
 
 export interface GetMenuV3CategoryPath {
@@ -1777,7 +1837,6 @@ export interface PostMenuV3CategoryBody {
   priority?: number;
   is_active?: boolean;
   layout_id: string;
-  id?: any;
   layout?: LayoutDTO;
   items?: CategoryToItemRelationshipDTO[];
   [index: string]: any;
@@ -1866,7 +1925,6 @@ export interface PostMenuV3CategoryRelationshipsItemBody {
   category_id: string;
   item_id: string;
   sequence?: number;
-  id?: any;
   category?: CategoryDTO;
   item?: ItemDTO;
   [index: string]: any;
@@ -2154,7 +2212,6 @@ export interface PostMenuV3BrandBody {
   items?: ItemDTO[];
   modifier_groups?: ModifierGroupDTO[];
   modifiers?: ModifierDTO[];
-  id?: any;
   [index: string]: any;
 }
 
@@ -2221,6 +2278,7 @@ export type PostMenuV3StationsBody = {
   modifier_groups?: ModifierGroupDTO[];
   modifiers?: ModifierDTO[];
   id?: any;
+  name?: string;
   [index: string]: any;
 }[];
 
@@ -2268,6 +2326,7 @@ export interface PatchMenuV3StationBody {
   modifier_groups?: ModifierGroupDTO[];
   modifiers?: ModifierDTO[];
   id?: string;
+  name?: string;
   [index: string]: any;
 }
 
@@ -2294,7 +2353,7 @@ export interface PostMenuV3StationBody {
   items?: ItemDTO[];
   modifier_groups?: ModifierGroupDTO[];
   modifiers?: ModifierDTO[];
-  id?: any;
+  name?: string;
   [index: string]: any;
 }
 
@@ -2985,7 +3044,6 @@ export interface GetMenuV3StationModifiersPath {
 }
 
 export interface GetMenuV3StationModifiersQuery {
-  // The fields that filtering is allowed on
   filter?: any;
   // Number of records to load per page
   limit?: number;
@@ -3005,7 +3063,7 @@ export interface GetMenuV3StationModifiersQuery {
 
 export interface GetMenuV3StationModifiersResponse {
   meta: PaginationMetaDTO;
-  results: ModifierDTO[];
+  results: ModifierEntityDTO[];
   [index: string]: any;
 }
 
@@ -3021,7 +3079,6 @@ export interface GetMenuV3StationModifierGroupsPath {
 }
 
 export interface GetMenuV3StationModifierGroupsQuery {
-  // The fields that filtering is allowed on
   filter?: any;
   // Number of records to load per page
   limit?: number;
@@ -3041,7 +3098,7 @@ export interface GetMenuV3StationModifierGroupsQuery {
 
 export interface GetMenuV3StationModifierGroupsResponse {
   meta: PaginationMetaDTO;
-  results: ModifierGroupDTO[];
+  results: ModifierGroupEntityDTO[];
   [index: string]: any;
 }
 
@@ -3057,7 +3114,6 @@ export interface GetMenuV3StationItemsPath {
 }
 
 export interface GetMenuV3StationItemsQuery {
-  // The fields that filtering is allowed on
   filter?: any;
   // Number of records to load per page
   limit?: number;
@@ -3077,7 +3133,7 @@ export interface GetMenuV3StationItemsQuery {
 
 export interface GetMenuV3StationItemsResponse {
   meta: PaginationMetaDTO;
-  results: ItemDTO[];
+  results: ItemEntityDTO[];
   [index: string]: any;
 }
 

package/src/interface/payment.ts

@@ -202,6 +202,8 @@ export interface GetPaymentClienttokenPath {
 }
 
 export interface GetPaymentClienttokenQuery {
+  // hCaptcha response key
+  captchaResponseKey: string;
   // Graphql query string
   _query?: string;
 }

package/src/interface/user.ts

@@ -39,6 +39,11 @@ export interface User {
       send_emails_date_updated?: string;
     };
     mealplan_added_date?: string;
+    // limit set to prevent too many login attempts with incorrect password
+    login_limit?: {
+      login_attempts?: number;
+      last_attempt_date?: string;
+    };
     // forgot password verification details
     password_verification?: {
       attempts?: number;
@@ -55,6 +60,8 @@ export interface User {
   };
   is?: {
     disabled?: boolean;
+    // User locked out status
+    locked_out?: boolean;
     // If the users email is verified
     verified?: boolean;
     // User phone number verification