@compassdigital/sdk.typescript 3.14.0 → 3.16.0

package/src/index.ts

@@ -51,6 +51,8 @@ import {
   GetOrderLocationOrdersResponse,
   GetOrderGroupOrdersQuery,
   GetOrderGroupOrdersResponse,
+  GetOrderUserOrdersQuery,
+  GetOrderUserOrdersResponse,
   PatchOrderCheckinResponse,
   PostOrderApexSnsBody,
   PostOrderApexSnsResponse,
@@ -154,8 +156,6 @@ import {
   GetLocationCompanyResponse,
   PatchLocationCompanyBody,
   PatchLocationCompanyResponse,
-  GetLocationBrandExternalQuery,
-  GetLocationBrandExternalResponse,
   DeleteLocationRecordQuery,
   DeleteLocationRecordResponse,
 } from "./interface/location";
@@ -168,6 +168,7 @@ import {
   DeleteShoppingcartCartItemsBody,
   DeleteShoppingcartCartItemsResponse,
   GetShoppingcartCartResponse,
+  PatchShoppingcartCartBody,
   PatchShoppingcartCartResponse,
   PutShoppingcartCartPromoBody,
   PutShoppingcartCartPromoResponse,
@@ -190,7 +191,6 @@ import {
   PostPartnerStandardcognitionShoppingcartResponse,
   GetPartnerStandardcognitionLocationsResponse,
   GetPartnerStandardcognitionStoresResponse,
-  PostPartnerStandardcognitionMenuBody,
   PostPartnerStandardcognitionMenuResponse,
   GetPartnerCoolrLocationsResponse,
   GetPartnerCoolrImagesResponse,
@@ -327,13 +327,6 @@ import {
   GetReportAnalyticsGroupResponse,
   GetReportAnalyticsCombinedGroupQuery,
   GetReportAnalyticsCombinedGroupResponse,
-  GetReportAnalyticsExactmobileTotalsQuery,
-  GetReportAnalyticsExactmobileTotalsResponse,
-  GetReportAnalyticsExactmobileTransactionsQuery,
-  GetReportAnalyticsExactmobileTransactionsResponse,
-  GetReportAnalyticsExactmobileDiscrepanciesQuery,
-  GetReportAnalyticsExactmobileDiscrepanciesResponse,
-  GetReportAnalyticsTrackerReportResponse,
   GetReportEodGroupQuery,
   GetReportEodGroupResponse,
   GetReportEodGroupSubscribersResponse,
@@ -342,12 +335,6 @@ import {
   DeleteReportEodGroupSubscribersResponse,
   PutReportEodGroupSubscribersBody,
   PutReportEodGroupSubscribersResponse,
-  GetReportDiscrepancySubscribersQuery,
-  GetReportDiscrepancySubscribersResponse,
-  DeleteReportDiscrepancySubscribersQuery,
-  DeleteReportDiscrepancySubscribersResponse,
-  PostReportDiscrepancySubscribersBody,
-  PostReportDiscrepancySubscribersResponse,
 } from "./interface/report";
 
 import {
@@ -374,7 +361,6 @@ import {
   GetUserKdsTokenQuery,
   GetUserKdsTokenResponse,
   DeleteUserDeviceAuthResponse,
-  PatchUserAuthKdsBody,
   PatchUserAuthKdsResponse,
   PostUserChangePasswordBody,
   PostUserChangePasswordResponse,
@@ -1064,6 +1050,28 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /order/user/{id} - Get all delivery orders for a User related to the order in the details (Runner)
+   *
+   * @param id - Get orders by their associated group
+   * @param options - additional request options
+   */
+  get_order_user_orders(
+    id: string,
+    options?: {
+      query?: GetOrderUserOrdersQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetOrderUserOrdersResponse> {
+    return this.request(
+      "order",
+      "get_order_user_orders",
+      "get",
+      `/order/user/${id}`,
+      null,
+      options
+    );
+  }
+
   /**
    * PATCH /order/{id}/checkin - Accept an order by checking in
    *
@@ -2144,28 +2152,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * GET /location/brand/external/{external_id} - Get an individual Location filtered by external_id
-   *
-   * @param external_id - external location id
-   * @param options - additional request options
-   */
-  get_location_brand_external(
-    external_id: string,
-    options?: {
-      query?: GetLocationBrandExternalQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLocationBrandExternalResponse> {
-    return this.request(
-      "location",
-      "get_location_brand_external",
-      "get",
-      `/location/brand/external/${external_id}`,
-      null,
-      options
-    );
-  }
-
   /**
    * DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
    *
@@ -2276,10 +2262,12 @@ export class ServiceClient extends BaseServiceClient {
    * PATCH /shoppingcart/{id} - Update a ShoppingCart
    *
    * @param id - Shopping cart ID
+   * @param body - body accepting properties to patch
    * @param options - additional request options
    */
   patch_shoppingcart_cart(
     id: string,
+    body: PatchShoppingcartCartBody,
     options?: RequestOptions
   ): ResponsePromise<PatchShoppingcartCartResponse> {
     return this.request(
@@ -2287,7 +2275,7 @@ export class ServiceClient extends BaseServiceClient {
       "patch_shoppingcart_cart",
       "patch",
       `/shoppingcart/${id}`,
-      null,
+      body,
       options
     );
   }
@@ -2525,11 +2513,9 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
    *
-   * @param body
    * @param options - additional request options
    */
   post_partner_standardcognition_menu(
-    body: PostPartnerStandardcognitionMenuBody,
     options?: RequestOptions
   ): ResponsePromise<PostPartnerStandardcognitionMenuResponse> {
     return this.request(
@@ -2537,7 +2523,7 @@ export class ServiceClient extends BaseServiceClient {
       "post_partner_standardcognition_menu",
       "post",
       `/partner/standardcognition/menu`,
-      body,
+      null,
       options
     );
   }
@@ -3688,86 +3674,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * GET /report/analytics/exactmobile/totals
-   *
-   * @param options - additional request options
-   */
-  get_report_analytics_exactmobile_totals(
-    options: {
-      query: GetReportAnalyticsExactmobileTotalsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetReportAnalyticsExactmobileTotalsResponse> {
-    return this.request(
-      "report",
-      "get_report_analytics_exactmobile_totals",
-      "get",
-      `/report/analytics/exactmobile/totals`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /report/analytics/exactmobile/transactions
-   *
-   * @param options - additional request options
-   */
-  get_report_analytics_exactmobile_transactions(
-    options: {
-      query: GetReportAnalyticsExactmobileTransactionsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetReportAnalyticsExactmobileTransactionsResponse> {
-    return this.request(
-      "report",
-      "get_report_analytics_exactmobile_transactions",
-      "get",
-      `/report/analytics/exactmobile/transactions`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /report/analytics/exactmobile/discrepancies
-   *
-   * @param options - additional request options
-   */
-  get_report_analytics_exactmobile_discrepancies(
-    options: {
-      query: GetReportAnalyticsExactmobileDiscrepanciesQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetReportAnalyticsExactmobileDiscrepanciesResponse> {
-    return this.request(
-      "report",
-      "get_report_analytics_exactmobile_discrepancies",
-      "get",
-      `/report/analytics/exactmobile/discrepancies`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /report/analytics/tracker/report/{id}
-   *
-   * @param id
-   * @param options - additional request options
-   */
-  get_report_analytics_tracker_report(
-    id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetReportAnalyticsTrackerReportResponse> {
-    return this.request(
-      "report",
-      "get_report_analytics_tracker_report",
-      "get",
-      `/report/analytics/tracker/report/${id}`,
-      null,
-      options
-    );
-  }
-
   /**
    * GET /report/eod/group/{id} - Get reports for selected location group
    *
@@ -3874,66 +3780,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * GET /report/discrepancy/subscribers - Get subscribers for discrepency widget
-   *
-   * @param options - additional request options
-   */
-  get_report_discrepancy_subscribers(
-    options?: {
-      query?: GetReportDiscrepancySubscribersQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetReportDiscrepancySubscribersResponse> {
-    return this.request(
-      "report",
-      "get_report_discrepancy_subscribers",
-      "get",
-      `/report/discrepancy/subscribers`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * DELETE /report/discrepancy/subscribers - deletes subscriber from discrepency
-   *
-   * @param options - additional request options
-   */
-  delete_report_discrepancy_subscribers(
-    options: {
-      query: DeleteReportDiscrepancySubscribersQuery;
-    } & RequestOptions
-  ): ResponsePromise<DeleteReportDiscrepancySubscribersResponse> {
-    return this.request(
-      "report",
-      "delete_report_discrepancy_subscribers",
-      "delete",
-      `/report/discrepancy/subscribers`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * POST /report/discrepancy/subscribers - Create new discrepancy subscriber
-   *
-   * @param body
-   * @param options - additional request options
-   */
-  post_report_discrepancy_subscribers(
-    body: PostReportDiscrepancySubscribersBody,
-    options?: RequestOptions
-  ): ResponsePromise<PostReportDiscrepancySubscribersResponse> {
-    return this.request(
-      "report",
-      "post_report_discrepancy_subscribers",
-      "post",
-      `/report/discrepancy/subscribers`,
-      body,
-      options
-    );
-  }
-
   /**
    * GET /user/auth - Gets the JWT token for a user
    *
@@ -4098,12 +3944,10 @@ export class ServiceClient extends BaseServiceClient {
    * PATCH /user/device/auth/{device_id} - Endpoint for authorizing device to retrieve valid kds token
    *
    * @param device_id - KDS device ID
-   * @param body
    * @param options - additional request options
    */
   patch_user_auth_kds(
     device_id: string,
-    body: PatchUserAuthKdsBody,
     options?: RequestOptions
   ): ResponsePromise<PatchUserAuthKdsResponse> {
     return this.request(
@@ -4111,7 +3955,7 @@ export class ServiceClient extends BaseServiceClient {
       "patch_user_auth_kds",
       "patch",
       `/user/device/auth/${device_id}`,
-      body,
+      null,
       options
     );
   }

package/src/interface/location.ts

@@ -189,7 +189,6 @@ export interface Brand {
       fr?: string;
     };
   };
-  external_id?: string;
   [index: string]: any;
 }
 
@@ -317,6 +316,9 @@ export interface Sector {
     fr?: string;
   };
   companies?: Company[];
+  meta?: {
+    [index: string]: any;
+  };
 }
 
 export interface Company {
@@ -1255,23 +1257,6 @@ export interface PatchLocationCompanyRequest extends PatchLocationCompanyPath {
   body: PatchLocationCompanyBody;
 }
 
-// GET /location/brand/external/{external_id} - Get an individual Location filtered by external_id
-
-export interface GetLocationBrandExternalPath {
-  // external location id
-  external_id: string;
-}
-
-export interface GetLocationBrandExternalQuery {
-  nocache?: boolean;
-}
-
-export type GetLocationBrandExternalResponse = Location;
-
-export interface GetLocationBrandExternalRequest
-  extends RequestQuery<GetLocationBrandExternalQuery>,
-    GetLocationBrandExternalPath {}
-
 // DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
 
 export interface DeleteLocationRecordPath {

package/src/interface/order.ts

@@ -493,6 +493,30 @@ export interface GetOrderGroupOrdersRequest
   extends RequestQuery<GetOrderGroupOrdersQuery>,
     GetOrderGroupOrdersPath {}
 
+// GET /order/user/{id} - Get all delivery orders for a User related to the order in the details (Runner)
+
+export interface GetOrderUserOrdersPath {
+  // Get orders by their associated group
+  id: string;
+}
+
+export interface GetOrderUserOrdersQuery {
+  // Filter orders by their status.
+  status?: string;
+  // Filter orders by their requested date. Only return orders that have a date greater than or equal to the date. Default is all orders
+  start?: number;
+  // Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is the current time in milliseconds.
+  end?: number;
+}
+
+export interface GetOrderUserOrdersResponse {
+  orders?: Order[];
+}
+
+export interface GetOrderUserOrdersRequest
+  extends RequestQuery<GetOrderUserOrdersQuery>,
+    GetOrderUserOrdersPath {}
+
 // PATCH /order/{id}/checkin - Accept an order by checking in
 
 export interface PatchOrderCheckinPath {

package/src/interface/partner.ts

@@ -164,6 +164,8 @@ export interface ShoppingCart {
     type?: string;
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
+    // If a user's email domain is a match in a sites list of tax exempt domains
+    domain_tax_exempt?: boolean;
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
@@ -358,7 +360,6 @@ export interface LocationGroup {
           fr?: string;
         };
       };
-      external_id?: string;
       [index: string]: any;
     }[];
     meta?: any;
@@ -392,6 +393,7 @@ export interface LocationGroup {
         show_instructions?: boolean;
         runner_app_enabled?: boolean;
       };
+      delivery_destinations?: string[];
       pickup_instruction?: {
         en?: string;
         fr?: string;
@@ -691,14 +693,14 @@ export type CoolrImages = any[];
 // POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
 
 export interface PostPartnerStandardcognitionShoppingcartBody {
-  items: {
+  items?: {
     sku?: string;
     quantity?: number;
   }[];
   // brand
-  location_brand: string;
-  // CDL shoppingcart id. If provided, items will be added to this shoppingcart
-  shoppingcart: string;
+  location_brand?: string;
+  // shoppingcart
+  shoppingcart?: string;
   // Meta data from Standard Cognition shoppingcart
   meta?: any;
 }
@@ -725,22 +727,9 @@ export type GetPartnerStandardcognitionStoresRequest = {};
 
 // POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
 
-export interface PostPartnerStandardcognitionMenuBody {
-  // CDL company ID
-  company: string;
-  // CDL sector ID
-  sector: string;
-  // CDL location brand ID
-  location_brand: string;
-  // Link for S3 menu file provided by Standard Cognition
-  s3_link: string;
-}
-
 export type PostPartnerStandardcognitionMenuResponse = Menu;
 
-export interface PostPartnerStandardcognitionMenuRequest {
-  body: PostPartnerStandardcognitionMenuBody;
-}
+export type PostPartnerStandardcognitionMenuRequest = {};
 
 // GET /partner/coolr/locations - Gets the locations where Coolr is available
 

package/src/interface/report.ts

@@ -284,17 +284,6 @@ export interface SAReport {
   };
 }
 
-export interface DiscrepancySubscriber {
-  subscribers_response?: {
-    id?: string;
-    email?: string;
-    type?: string;
-  }[];
-  [index: string]: any;
-}
-
-export type DiscrepancySubscriberRequest = any[];
-
 export interface P2AnalyticsReport {
   message?: string;
   date_resolved?: string;
@@ -316,54 +305,6 @@ export interface P2AnalyticsReport {
   }[];
 }
 
-export interface DiscrepancyTotals {
-  message?: string;
-  date_resolved?: string;
-  payload?: {
-    unitid?: string;
-    date?: string;
-    exact_total?: number;
-    mobile_total?: number;
-    difference?: number;
-  }[];
-}
-
-export interface DiscrepancyCount {
-  message?: string;
-  date_resolved?: string;
-  payload?: {
-    discrepancy_count?: number;
-  };
-}
-
-export interface DiscrepancyTranscation {
-  message?: string;
-  date_resolved?: string;
-  payload?: {
-    unitid?: string;
-    exact_tag?: string;
-    exact_order_time?: string;
-    exact_card_type?: string;
-    exact_pickup_name?: string;
-    exact_transcation_type?: string;
-    exact_total?: number;
-    exact_merchant_name?: string;
-    exact_status?: string;
-    mobile_orderid?: string;
-    mobile_order_time?: string;
-    mobile_payment_type?: string;
-    mobile_pickup_name?: string;
-    mobile_total?: number;
-  }[];
-}
-
-export interface TrackerReport {
-  // Base64 encoded file
-  file?: string;
-  // Base64 encoded file format
-  format?: string;
-}
-
 // GET /report/analytics/group/{location_group}/{report_type}
 
 export interface GetReportAnalyticsGroupPath {
@@ -378,7 +319,6 @@ export interface GetReportAnalyticsGroupQuery {
   end_date: string;
   time_frame: string;
   order_type?: string;
-  nocache?: boolean;
 }
 
 export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
@@ -408,59 +348,6 @@ export interface GetReportAnalyticsCombinedGroupRequest
   extends RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
     GetReportAnalyticsCombinedGroupPath {}
 
-// GET /report/analytics/exactmobile/totals
-
-export interface GetReportAnalyticsExactmobileTotalsQuery {
-  start_date: string;
-  end_date: string;
-  unitids: number[];
-  offset: number;
-}
-
-export type GetReportAnalyticsExactmobileTotalsResponse = DiscrepancyTotals;
-
-export interface GetReportAnalyticsExactmobileTotalsRequest
-  extends RequestQuery<GetReportAnalyticsExactmobileTotalsQuery> {}
-
-// GET /report/analytics/exactmobile/transactions
-
-export interface GetReportAnalyticsExactmobileTransactionsQuery {
-  start_date: string;
-  end_date: string;
-  unitids: number[];
-  offset: number;
-}
-
-export type GetReportAnalyticsExactmobileTransactionsResponse = DiscrepancyTranscation;
-
-export interface GetReportAnalyticsExactmobileTransactionsRequest
-  extends RequestQuery<GetReportAnalyticsExactmobileTransactionsQuery> {}
-
-// GET /report/analytics/exactmobile/discrepancies
-
-export interface GetReportAnalyticsExactmobileDiscrepanciesQuery {
-  start_date: string;
-  end_date: string;
-  unitids: number[];
-  offset: number;
-}
-
-export type GetReportAnalyticsExactmobileDiscrepanciesResponse = DiscrepancyCount;
-
-export interface GetReportAnalyticsExactmobileDiscrepanciesRequest
-  extends RequestQuery<GetReportAnalyticsExactmobileDiscrepanciesQuery> {}
-
-// GET /report/analytics/tracker/report/{id}
-
-export interface GetReportAnalyticsTrackerReportPath {
-  id: string;
-}
-
-export type GetReportAnalyticsTrackerReportResponse = TrackerReport;
-
-export interface GetReportAnalyticsTrackerReportRequest
-  extends GetReportAnalyticsTrackerReportPath {}
-
 // GET /report/eod/group/{id} - Get reports for selected location group
 
 export interface GetReportEodGroupPath {
@@ -533,35 +420,3 @@ export type PutReportEodGroupSubscribersResponse = EODSubscribers;
 export interface PutReportEodGroupSubscribersRequest extends PutReportEodGroupSubscribersPath {
   body: PutReportEodGroupSubscribersBody;
 }
-
-// GET /report/discrepancy/subscribers - Get subscribers for discrepency widget
-
-export interface GetReportDiscrepancySubscribersQuery {
-  email?: string;
-}
-
-export type GetReportDiscrepancySubscribersResponse = DiscrepancySubscriber;
-
-export interface GetReportDiscrepancySubscribersRequest
-  extends RequestQuery<GetReportDiscrepancySubscribersQuery> {}
-
-// DELETE /report/discrepancy/subscribers - deletes subscriber from discrepency
-
-export interface DeleteReportDiscrepancySubscribersQuery {
-  emailid: string;
-}
-
-export type DeleteReportDiscrepancySubscribersResponse = Success;
-
-export interface DeleteReportDiscrepancySubscribersRequest
-  extends RequestQuery<DeleteReportDiscrepancySubscribersQuery> {}
-
-// POST /report/discrepancy/subscribers - Create new discrepancy subscriber
-
-export type PostReportDiscrepancySubscribersBody = DiscrepancySubscriberRequest;
-
-export type PostReportDiscrepancySubscribersResponse = DiscrepancySubscriber;
-
-export interface PostReportDiscrepancySubscribersRequest {
-  body: PostReportDiscrepancySubscribersBody;
-}

package/src/interface/shoppingcart.ts

@@ -222,6 +222,8 @@ export interface ShoppingCart {
     type?: string;
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
+    // If a user's email domain is a match in a sites list of tax exempt domains
+    domain_tax_exempt?: boolean;
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
@@ -288,9 +290,13 @@ export interface PatchShoppingcartCartPath {
   id: string;
 }
 
+export type PatchShoppingcartCartBody = ShoppingCart;
+
 export type PatchShoppingcartCartResponse = ShoppingCart;
 
-export interface PatchShoppingcartCartRequest extends PatchShoppingcartCartPath {}
+export interface PatchShoppingcartCartRequest extends PatchShoppingcartCartPath {
+  body: PatchShoppingcartCartBody;
+}
 
 // PUT /shoppingcart/{id}/promo - Put a promo in a ShoppingCart
 

package/src/interface/user.ts

@@ -372,13 +372,9 @@ export interface PatchUserAuthKdsPath {
   device_id: string;
 }
 
-export type PatchUserAuthKdsBody = KDSDevice["device"];
-
 export type PatchUserAuthKdsResponse = KDSDevice;
 
-export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {
-  body: PatchUserAuthKdsBody;
-}
+export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {}
 
 // POST /user/{id}/changepassword - Change the users password