@compassdigital/sdk.typescript 3.0.0-beta.19 → 3.0.0-beta.21

package/src/index.ts

@@ -51,6 +51,7 @@ import {
   GetOrderLocationOrdersResponse,
   GetOrderGroupOrdersQuery,
   GetOrderGroupOrdersResponse,
+  PatchOrderCheckinResponse,
 } from "./interface/order";
 
 import {
@@ -97,10 +98,11 @@ import {
   GetLocationGroupDeliverydestinationsResponse,
   PostLocationGroupDeliverydestinationBody,
   PostLocationGroupDeliverydestinationResponse,
-  GetLocationGroupDeliverydestinationResponse,
   PatchLocationGroupDeliverydestinationBody,
   PatchLocationGroupDeliverydestinationResponse,
+  DeleteLocationGroupDeliverydestinationBody,
   DeleteLocationGroupDeliverydestinationResponse,
+  GetLocationGroupDeliverydestinationResponse,
   GetLocationUserGroupQuery,
   GetLocationUserGroupResponse,
   GetLocationBrandsResponse,
@@ -180,11 +182,15 @@ import {
   PostPartnerStandardcognitionShoppingcartResponse,
   GetPartnerStandardcognitionLocationsResponse,
   GetPartnerStandardcognitionStoresResponse,
+  PostPartnerStandardcognitionMenuBody,
+  PostPartnerStandardcognitionMenuResponse,
   GetPartnerCoolrLocationsResponse,
   GetPartnerCoolrImagesResponse,
   GetPartnerSwaggerResponse,
 } from "./interface/partner";
 
+import { PostEmailBody, PostEmailResponse } from "./interface/email";
+
 import {
   PostTaskBody,
   PostTaskResponse,
@@ -386,6 +392,8 @@ import {
   PostUserSendEmailVerificationResponse,
   PutUserVerifyUserEmailBody,
   PutUserVerifyUserEmailResponse,
+  PutUserVerificationPhoneBody,
+  PutUserVerificationPhoneResponse,
 } from "./interface/user";
 
 import {
@@ -966,6 +974,26 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * PATCH /order/{id}/checkin - Accept an order by checking in
+   *
+   * @param id - The order ID
+   * @param options - additional request options
+   */
+  patch_order_checkin(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<PatchOrderCheckinResponse> {
+    return this.request(
+      "order",
+      "patch_order_checkin",
+      "patch",
+      `/order/${id}/checkin`,
+      null,
+      options
+    );
+  }
+
   /**
    * POST /location - Create a new location
    *
@@ -1410,67 +1438,65 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
+   * PATCH /location/group/{id}/deliverydestination - Patch single or multiple delivery destinations
    *
    * @param id - Group ID
-   * @param delivery_destination - Delivery Destination ID
+   * @param body
    * @param options - additional request options
    */
-  get_location_group_deliverydestination(
+  patch_location_group_deliverydestination(
     id: string,
-    delivery_destination: string,
+    body: PatchLocationGroupDeliverydestinationBody,
     options?: RequestOptions
-  ): ResponsePromise<GetLocationGroupDeliverydestinationResponse> {
+  ): ResponsePromise<PatchLocationGroupDeliverydestinationResponse> {
     return this.request(
       "location",
-      "get_location_group_deliverydestination",
-      "get",
-      `/location/group/${id}/deliverydestination/${delivery_destination}`,
-      null,
+      "patch_location_group_deliverydestination",
+      "patch",
+      `/location/group/${id}/deliverydestination`,
+      body,
       options
     );
   }
 
   /**
-   * PATCH /location/group/{id}/deliverydestination/{delivery_destination} - Patch a delivery destination
+   * DELETE /location/group/{id}/deliverydestination - Delete single or multiple delivery destinations
    *
    * @param id - Group ID
-   * @param delivery_destination - Delivery Destination ID
    * @param body
    * @param options - additional request options
    */
-  patch_location_group_deliverydestination(
+  delete_location_group_deliverydestination(
     id: string,
-    delivery_destination: string,
-    body: PatchLocationGroupDeliverydestinationBody,
+    body: DeleteLocationGroupDeliverydestinationBody,
     options?: RequestOptions
-  ): ResponsePromise<PatchLocationGroupDeliverydestinationResponse> {
+  ): ResponsePromise<DeleteLocationGroupDeliverydestinationResponse> {
     return this.request(
       "location",
-      "patch_location_group_deliverydestination",
-      "patch",
-      `/location/group/${id}/deliverydestination/${delivery_destination}`,
+      "delete_location_group_deliverydestination",
+      "delete",
+      `/location/group/${id}/deliverydestination`,
       body,
       options
     );
   }
 
   /**
-   * DELETE /location/group/{id}/deliverydestination/{delivery_destination} - Delete a delivery destination
+   * GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
    *
    * @param id - Group ID
    * @param delivery_destination - Delivery Destination ID
    * @param options - additional request options
    */
-  delete_location_group_deliverydestination(
+  get_location_group_deliverydestination(
     id: string,
     delivery_destination: string,
     options?: RequestOptions
-  ): ResponsePromise<DeleteLocationGroupDeliverydestinationResponse> {
+  ): ResponsePromise<GetLocationGroupDeliverydestinationResponse> {
     return this.request(
       "location",
-      "delete_location_group_deliverydestination",
-      "delete",
+      "get_location_group_deliverydestination",
+      "get",
       `/location/group/${id}/deliverydestination/${delivery_destination}`,
       null,
       options
@@ -2343,6 +2369,26 @@ 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(
+      "partner",
+      "post_partner_standardcognition_menu",
+      "post",
+      `/partner/standardcognition/menu`,
+      body,
+      options
+    );
+  }
+
   /**
    * GET /partner/coolr/locations - Gets the locations where Coolr is available
    *
@@ -2397,6 +2443,16 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * POST /email - Send an email
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_email(body: PostEmailBody, options?: RequestOptions): ResponsePromise<PostEmailResponse> {
+    return this.request("email", "post_email", "post", `/email`, body, options);
+  }
+
   /**
    * POST /task/ - Create new Task
    *
@@ -4141,6 +4197,28 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * PUT /user/{id}/verification/phone - Send phone verification to user
+   *
+   * @param id - realm
+   * @param body
+   * @param options - additional request options
+   */
+  put_user_verification_phone(
+    id: string,
+    body: PutUserVerificationPhoneBody,
+    options?: RequestOptions
+  ): ResponsePromise<PutUserVerificationPhoneResponse> {
+    return this.request(
+      "user",
+      "put_user_verification_phone",
+      "put",
+      `/user/${id}/verification/phone`,
+      body,
+      options
+    );
+  }
+
   /**
    * POST /loyalty/{id}/enroll/{user_id} - Enroll logged in user in Loyalty program
    *

package/src/interface/email.ts

@@ -4,3 +4,27 @@ export interface Error {
   message?: string;
   code?: number;
 }
+
+export interface Success {
+  success?: boolean;
+}
+
+export interface EmailPayload {
+  from: string;
+  to: string;
+  subject?: string;
+  // Text of an email instead of template_id/data
+  text?: string;
+  template_id?: string;
+  data?: any;
+}
+
+// POST /email - Send an email
+
+export type PostEmailBody = EmailPayload;
+
+export type PostEmailResponse = Success;
+
+export interface PostEmailRequest {
+  body: PostEmailBody;
+}

package/src/interface/location.ts

@@ -135,6 +135,8 @@ export interface Brand {
   brand?: string;
   // location
   location?: string;
+  // location group
+  group?: string;
   // payment
   payment_provider?: string;
   location_description?: string;
@@ -341,7 +343,7 @@ export interface PostOrPatchDeliveryDestination {
 }
 
 export interface DeliveryDestination {
-  // ID of the delivery destination
+  // delivery_destination
   id?: string;
   // Name of the delivery destination
   name: string;
@@ -751,53 +753,59 @@ export interface PostLocationGroupDeliverydestinationRequest
   body: PostLocationGroupDeliverydestinationBody;
 }
 
-// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
+// PATCH /location/group/{id}/deliverydestination - Patch single or multiple delivery destinations
 
-export interface GetLocationGroupDeliverydestinationPath {
+export interface PatchLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
-  // Delivery Destination ID
-  delivery_destination: string;
 }
 
-export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
+export interface PatchLocationGroupDeliverydestinationBody {
+  delivery_destinations?: PostOrPatchDeliveryDestination;
+}
 
-export interface GetLocationGroupDeliverydestinationRequest
-  extends GetLocationGroupDeliverydestinationPath {}
+export interface PatchLocationGroupDeliverydestinationResponse {
+  delivery_destinations?: DeliveryDestination;
+}
 
-// PATCH /location/group/{id}/deliverydestination/{delivery_destination} - Patch a delivery destination
+export interface PatchLocationGroupDeliverydestinationRequest
+  extends PatchLocationGroupDeliverydestinationPath {
+  body: PatchLocationGroupDeliverydestinationBody;
+}
 
-export interface PatchLocationGroupDeliverydestinationPath {
+// DELETE /location/group/{id}/deliverydestination - Delete single or multiple delivery destinations
+
+export interface DeleteLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
-  // Delivery Destination ID
-  delivery_destination: string;
 }
 
-export type PatchLocationGroupDeliverydestinationBody = PostOrPatchDeliveryDestination;
+export interface DeleteLocationGroupDeliverydestinationBody {
+  delivery_destination_ids?: string[];
+}
 
-export type PatchLocationGroupDeliverydestinationResponse = DeliveryDestination;
+export interface DeleteLocationGroupDeliverydestinationResponse {
+  deleted_delivery_destinations?: DeliveryDestination;
+}
 
-export interface PatchLocationGroupDeliverydestinationRequest
-  extends PatchLocationGroupDeliverydestinationPath {
-  body: PatchLocationGroupDeliverydestinationBody;
+export interface DeleteLocationGroupDeliverydestinationRequest
+  extends DeleteLocationGroupDeliverydestinationPath {
+  body: DeleteLocationGroupDeliverydestinationBody;
 }
 
-// DELETE /location/group/{id}/deliverydestination/{delivery_destination} - Delete a delivery destination
+// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
 
-export interface DeleteLocationGroupDeliverydestinationPath {
+export interface GetLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
   // Delivery Destination ID
   delivery_destination: string;
 }
 
-export interface DeleteLocationGroupDeliverydestinationResponse {
-  deleted_delivery_destination?: DeliveryDestination;
-}
+export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
-export interface DeleteLocationGroupDeliverydestinationRequest
-  extends DeleteLocationGroupDeliverydestinationPath {}
+export interface GetLocationGroupDeliverydestinationRequest
+  extends GetLocationGroupDeliverydestinationPath {}
 
 // GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
 
@@ -1147,15 +1155,13 @@ export interface PatchLocationSectorRequest
 // POST /location/company - Create a new company
 
 export interface PostLocationCompanyBody {
-  name: {
-    // Sector name
-    name: string;
-    // sector
-    sector: string;
-    label?: any;
-    is?: {
-      global_images_enabled?: boolean;
-    };
+  // Sector name
+  name: string;
+  // sector
+  sector: string;
+  label?: any;
+  is?: {
+    global_images_enabled?: boolean;
   };
 }
 

package/src/interface/menu.ts

@@ -127,6 +127,10 @@ export interface Item {
         end?: string;
       };
     };
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
   };
   category?: {
     en?: string;
@@ -162,7 +166,13 @@ export interface Group {
     disabled?: boolean;
     hidden?: boolean;
   };
-  meta?: any;
+  meta?: {
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
+    [index: string]: any;
+  };
 }
 
 export interface Option {
@@ -187,7 +197,13 @@ export interface Option {
     category?: string;
     list?: string[];
   }[];
-  meta?: any;
+  meta?: {
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
+    [index: string]: any;
+  };
   is?: {
     disabled?: boolean;
     hidden?: boolean;
@@ -211,7 +227,13 @@ export interface OptionsGroup {
     hidden?: boolean;
     out_of_stock?: boolean;
   };
-  meta?: any;
+  meta?: {
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
+    [index: string]: any;
+  };
   [index: string]: any;
 }
 

package/src/interface/order.ts

@@ -452,6 +452,8 @@ export interface GetOrderGroupOrdersQuery {
   end?: number;
   // Filter orders by their order type
   order_type?: string;
+  // Filter orders by brand ID. Only return orders that involve brand ID, either as the only brand, or as part of a market place order.
+  brand?: string;
 }
 
 export interface GetOrderGroupOrdersResponse {
@@ -461,3 +463,14 @@ export interface GetOrderGroupOrdersResponse {
 export interface GetOrderGroupOrdersRequest
   extends GetOrderGroupOrdersQuery,
     GetOrderGroupOrdersPath {}
+
+// PATCH /order/{id}/checkin - Accept an order by checking in
+
+export interface PatchOrderCheckinPath {
+  // The order ID
+  id: string;
+}
+
+export type PatchOrderCheckinResponse = Order;
+
+export interface PatchOrderCheckinRequest extends PatchOrderCheckinPath {}