@compassdigital/sdk.typescript 3.44.2 → 3.45.0

package/src/interface/menu.ts

@@ -17,6 +17,31 @@ export interface ItemsListResponse {
   results?: LocalItem[];
 }
 
+export interface MenuV2ListResponse {
+  meta?: Meta;
+  results?: MenuV2[];
+}
+
+export interface LayoutListResponse {
+  meta?: Meta;
+  results?: Layout[];
+}
+
+export interface CategoryListResponse {
+  meta?: Meta;
+  results?: Category[];
+}
+
+export interface ItemToModifierGroupRelationshipListResponse {
+  meta?: Meta;
+  results?: ItemToModifierGroupRelationship[];
+}
+
+export interface CategoryToItemRelationshipListResponse {
+  meta?: Meta;
+  results?: CategoryToItemRelationship[];
+}
+
 export interface ModifierGroupToModifierRelationshipListResponse {
   meta?: Meta;
   results?: ModifierGroupToModifierRelationship[];
@@ -82,6 +107,62 @@ export interface LocalItem {
   [index: string]: any;
 }
 
+export interface MenuV2 {
+  id?: string;
+  name?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface Layout {
+  id?: string;
+  name?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface Category {
+  id?: string;
+  name?: string;
+  label?: string;
+  sequence?: number;
+  is_active?: boolean;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface ItemToModifierGroupRelationship {
+  id?: string;
+  item?: Item;
+  item_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 CategoryToItemRelationship {
+  id?: string;
+  item?: Item;
+  item_id?: string;
+  category?: Category;
+  category_id?: string;
+  sequence?: number;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
 export interface ModifierGroupToModifierRelationship {
   id?: string;
   modifier?: Modifier;
@@ -661,6 +742,345 @@ export interface GetMenuV2ItemsCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV2ItemsCountQuery> {}
 
+// GET /menu/v2/item/relationships/modifier-groups
+
+export interface GetMenuV2ItemRelationshipsModifierGroupsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ItemRelationshipsModifierGroupsResponse =
+  ItemToModifierGroupRelationshipListResponse;
+
+export interface GetMenuV2ItemRelationshipsModifierGroupsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ItemRelationshipsModifierGroupsQuery> {}
+
+// POST /menu/v2/item/relationships/modifier-group
+
+export type PostMenuV2ItemRelationshipsModifierGroupBody = ItemToModifierGroupRelationship;
+
+export type PostMenuV2ItemRelationshipsModifierGroupResponse = ItemToModifierGroupRelationship;
+
+export interface PostMenuV2ItemRelationshipsModifierGroupRequest extends BaseRequest {
+  body: PostMenuV2ItemRelationshipsModifierGroupBody;
+}
+
+// PATCH /menu/v2/item/relationships/modifier-group/{id}
+
+export interface PatchMenuV2ItemRelationshipsModifierGroupPath {
+  id: string;
+}
+
+export type PatchMenuV2ItemRelationshipsModifierGroupBody = ItemToModifierGroupRelationship;
+
+export type PatchMenuV2ItemRelationshipsModifierGroupResponse = ItemToModifierGroupRelationship;
+
+export interface PatchMenuV2ItemRelationshipsModifierGroupRequest
+  extends BaseRequest,
+    PatchMenuV2ItemRelationshipsModifierGroupPath {
+  body: PatchMenuV2ItemRelationshipsModifierGroupBody;
+}
+
+// DELETE /menu/v2/item/relationships/modifier-group/{id}
+
+export interface DeleteMenuV2ItemRelationshipsModifierGroupPath {
+  id: string;
+}
+
+export type DeleteMenuV2ItemRelationshipsModifierGroupResponse = ItemToModifierGroupRelationship;
+
+export interface DeleteMenuV2ItemRelationshipsModifierGroupRequest
+  extends BaseRequest,
+    DeleteMenuV2ItemRelationshipsModifierGroupPath {}
+
+// GET /menu/v2/menus
+
+export interface GetMenuV2MenusQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2MenusResponse = MenuV2ListResponse;
+
+export interface GetMenuV2MenusRequest extends BaseRequest, RequestQuery<GetMenuV2MenusQuery> {}
+
+// GET /menu/v2/menu/{id}
+
+export interface GetMenuV2MenuPath {
+  id: string;
+}
+
+export interface GetMenuV2MenuQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2MenuResponse = MenuV2;
+
+export interface GetMenuV2MenuRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2MenuQuery>,
+    GetMenuV2MenuPath {}
+
+// PATCH /menu/v2/menu/{id}
+
+export interface PatchMenuV2MenuPath {
+  id: string;
+}
+
+export type PatchMenuV2MenuBody = MenuV2;
+
+export type PatchMenuV2MenuResponse = MenuV2;
+
+export interface PatchMenuV2MenuRequest extends BaseRequest, PatchMenuV2MenuPath {
+  body: PatchMenuV2MenuBody;
+}
+
+// DELETE /menu/v2/menu/{id}
+
+export interface DeleteMenuV2MenuPath {
+  id: string;
+}
+
+export type DeleteMenuV2MenuResponse = MenuV2;
+
+export interface DeleteMenuV2MenuRequest extends BaseRequest, DeleteMenuV2MenuPath {}
+
+// POST /menu/v2/menu
+
+export type PostMenuV2MenuBody = MenuV2;
+
+export type PostMenuV2MenuResponse = MenuV2;
+
+export interface PostMenuV2MenuRequest extends BaseRequest {
+  body: PostMenuV2MenuBody;
+}
+
+// GET /menu/v2/menus/count
+
+export interface GetMenuV2MenusCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2MenusCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2MenusCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2MenusCountQuery> {}
+
+// GET /menu/v2/layouts
+
+export interface GetMenuV2LayoutsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2LayoutsResponse = LayoutListResponse;
+
+export interface GetMenuV2LayoutsRequest extends BaseRequest, RequestQuery<GetMenuV2LayoutsQuery> {}
+
+// GET /menu/v2/layout/{id}
+
+export interface GetMenuV2LayoutPath {
+  id: string;
+}
+
+export interface GetMenuV2LayoutQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2LayoutResponse = Layout;
+
+export interface GetMenuV2LayoutRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2LayoutQuery>,
+    GetMenuV2LayoutPath {}
+
+// PATCH /menu/v2/layout/{id}
+
+export interface PatchMenuV2LayoutPath {
+  id: string;
+}
+
+export type PatchMenuV2LayoutBody = Layout;
+
+export type PatchMenuV2LayoutResponse = Layout;
+
+export interface PatchMenuV2LayoutRequest extends BaseRequest, PatchMenuV2LayoutPath {
+  body: PatchMenuV2LayoutBody;
+}
+
+// DELETE /menu/v2/layout/{id}
+
+export interface DeleteMenuV2LayoutPath {
+  id: string;
+}
+
+export type DeleteMenuV2LayoutResponse = Layout;
+
+export interface DeleteMenuV2LayoutRequest extends BaseRequest, DeleteMenuV2LayoutPath {}
+
+// POST /menu/v2/layout
+
+export type PostMenuV2LayoutBody = Layout;
+
+export type PostMenuV2LayoutResponse = Layout;
+
+export interface PostMenuV2LayoutRequest extends BaseRequest {
+  body: PostMenuV2LayoutBody;
+}
+
+// GET /menu/v2/layouts/count
+
+export interface GetMenuV2LayoutsCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2LayoutsCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2LayoutsCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2LayoutsCountQuery> {}
+
+// GET /menu/v2/categories
+
+export interface GetMenuV2CategoriesQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2CategoriesResponse = CategoryListResponse;
+
+export interface GetMenuV2CategoriesRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoriesQuery> {}
+
+// GET /menu/v2/category/{id}
+
+export interface GetMenuV2CategoryPath {
+  id: string;
+}
+
+export interface GetMenuV2CategoryQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2CategoryResponse = Category;
+
+export interface GetMenuV2CategoryRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoryQuery>,
+    GetMenuV2CategoryPath {}
+
+// PATCH /menu/v2/category/{id}
+
+export interface PatchMenuV2CategoryPath {
+  id: string;
+}
+
+export type PatchMenuV2CategoryBody = Category;
+
+export type PatchMenuV2CategoryResponse = Category;
+
+export interface PatchMenuV2CategoryRequest extends BaseRequest, PatchMenuV2CategoryPath {
+  body: PatchMenuV2CategoryBody;
+}
+
+// DELETE /menu/v2/category/{id}
+
+export interface DeleteMenuV2CategoryPath {
+  id: string;
+}
+
+export type DeleteMenuV2CategoryResponse = Category;
+
+export interface DeleteMenuV2CategoryRequest extends BaseRequest, DeleteMenuV2CategoryPath {}
+
+// POST /menu/v2/category
+
+export type PostMenuV2CategoryBody = Category;
+
+export type PostMenuV2CategoryResponse = Category;
+
+export interface PostMenuV2CategoryRequest extends BaseRequest {
+  body: PostMenuV2CategoryBody;
+}
+
+// GET /menu/v2/categories/count
+
+export interface GetMenuV2CategoriesCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2CategoriesCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2CategoriesCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoriesCountQuery> {}
+
+// GET /menu/v2/category/relationships/items
+
+export interface GetMenuV2CategoryRelationshipsItemsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2CategoryRelationshipsItemsResponse = CategoryToItemRelationshipListResponse;
+
+export interface GetMenuV2CategoryRelationshipsItemsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoryRelationshipsItemsQuery> {}
+
+// POST /menu/v2/category/relationships/item
+
+export type PostMenuV2CategoryRelationshipsItemBody = CategoryToItemRelationship;
+
+export type PostMenuV2CategoryRelationshipsItemResponse = CategoryToItemRelationship;
+
+export interface PostMenuV2CategoryRelationshipsItemRequest extends BaseRequest {
+  body: PostMenuV2CategoryRelationshipsItemBody;
+}
+
+// PATCH /menu/v2/category/relationships/item/{id}
+
+export interface PatchMenuV2CategoryRelationshipsItemPath {
+  id: string;
+}
+
+export type PatchMenuV2CategoryRelationshipsItemBody = CategoryToItemRelationship;
+
+export type PatchMenuV2CategoryRelationshipsItemResponse = CategoryToItemRelationship;
+
+export interface PatchMenuV2CategoryRelationshipsItemRequest
+  extends BaseRequest,
+    PatchMenuV2CategoryRelationshipsItemPath {
+  body: PatchMenuV2CategoryRelationshipsItemBody;
+}
+
+// DELETE /menu/v2/category/relationships/item/{id}
+
+export interface DeleteMenuV2CategoryRelationshipsItemPath {
+  id: string;
+}
+
+export type DeleteMenuV2CategoryRelationshipsItemResponse = CategoryToItemRelationship;
+
+export interface DeleteMenuV2CategoryRelationshipsItemRequest
+  extends BaseRequest,
+    DeleteMenuV2CategoryRelationshipsItemPath {}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {

package/src/interface/order.ts

@@ -159,6 +159,8 @@ export interface Order {
       };
       [index: string]: any;
     };
+    // Indicate whether the order is active or inactive
+    active?: boolean;
     [index: string]: any;
   };
   issue?: Issue;

package/src/interface/partner.ts

@@ -186,6 +186,7 @@ export interface ItemResponse {
   added_on?: string;
   meal_value?: IntegerValue;
   category?: Label;
+  tax_rate?: MonetaryValue;
 }
 
 export type MonetaryValue = number;
@@ -742,22 +743,10 @@ export interface CognitionStore {
   longitude?: number;
 }
 
-export interface CoolrLocations {
-  // location
-  id?: string;
-  name?: string;
-  code?: string;
-  timezone?: string;
-  address?: string;
-  date?: {
-    created?: string;
-    modified?: string;
-  };
-  [index: string]: any;
+export interface Success {
+  success?: boolean;
 }
 
-export type CoolrImages = any[];
-
 // POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
 
 export interface PostPartnerStandardcognitionShoppingcartBody {
@@ -828,6 +817,21 @@ export interface PostPartnerStandardcognitionMenuRequest extends BaseRequest {
   body: PostPartnerStandardcognitionMenuBody;
 }
 
+// POST /partner/event/{id} - Send an event from 3rd party to our system
+
+export interface PostPartnerEventPath {
+  // provider
+  id: string;
+}
+
+export type PostPartnerEventBody = any;
+
+export type PostPartnerEventResponse = Success;
+
+export interface PostPartnerEventRequest extends BaseRequest, PostPartnerEventPath {
+  body: PostPartnerEventBody;
+}
+
 // GET /partner/swagger.json
 
 export interface GetPartnerSwaggerQuery {

package/src/interface/payment.ts

@@ -4,11 +4,21 @@ import { RequestQuery, BaseRequest } from "./util";
 
 export interface Transaction {
   success?: boolean;
+  // the total amount available for refund on the transaction - the transaction remainder amount
+  amount?: string;
+  // cdl encoded transaction id
+  id?: string;
   [index: string]: any;
 }
 
 export interface Refund {
   success?: boolean;
+  // attempted amount for refund in current request
+  amount?: number;
+  // amount refunded in current request
+  refund_amount?: number;
+  // remaining amount available for refund
+  transaction_remainder_amount?: number;
   [index: string]: any;
 }