@compassdigital/sdk.typescript 3.0.0-rc.1 → 3.0.0-rc.3

package/src/index.ts

@@ -154,6 +154,8 @@ import {
   PatchLocationCompanyResponse,
   GetLocationBrandExternalQuery,
   GetLocationBrandExternalResponse,
+  DeleteLocationRecordQuery,
+  DeleteLocationRecordResponse,
 } from "./interface/location";
 
 import {
@@ -396,6 +398,9 @@ import {
   PostUserSendEmailVerificationResponse,
   PutUserVerifyUserEmailBody,
   PutUserVerifyUserEmailResponse,
+  PostUserVerificationPhoneQuery,
+  PostUserVerificationPhoneBody,
+  PostUserVerificationPhoneResponse,
   PutUserVerificationPhoneBody,
   PutUserVerificationPhoneResponse,
 } from "./interface/user";
@@ -475,7 +480,12 @@ import {
   GetVoteIdfaResponse,
 } from "./interface/vote";
 
-import { PostFileBody, PostFileResponse } from "./interface/file";
+import {
+  PostFileBody,
+  PostFileResponse,
+  DeleteFileBody,
+  DeleteFileResponse,
+} from "./interface/file";
 
 import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "./interface/message";
 
@@ -2069,6 +2079,28 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
+   *
+   * @param id - brand, location, group, or multigroup id
+   * @param options - additional request options
+   */
+  delete_location_record(
+    id: string,
+    options?: {
+      query?: DeleteLocationRecordQuery;
+    } & RequestOptions
+  ): ResponsePromise<DeleteLocationRecordResponse> {
+    return this.request(
+      "location",
+      "delete_location_record",
+      "delete",
+      `/location/record/${id}`,
+      null,
+      options
+    );
+  }
+
   /**
    * POST /shoppingcart/ - Create a new ShoppingCart
    *
@@ -4232,7 +4264,31 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * PUT /user/{id}/verification/phone - Send phone verification to user
+   * POST /user/{id}/verification/phone - Send phone verification to user
+   *
+   * @param id - realm
+   * @param body - User phone number to be verified
+   * @param options - additional request options
+   */
+  post_user_verification_phone(
+    id: string,
+    body: PostUserVerificationPhoneBody,
+    options?: {
+      query?: PostUserVerificationPhoneQuery;
+    } & RequestOptions
+  ): ResponsePromise<PostUserVerificationPhoneResponse> {
+    return this.request(
+      "user",
+      "post_user_verification_phone",
+      "post",
+      `/user/${id}/verification/phone`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * PUT /user/{id}/verification/phone - Attempt phone verification for user
    *
    * @param id - realm
    * @param body
@@ -4960,6 +5016,16 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("file", "post_file", "post", `/file`, body, options);
   }
 
+  /**
+   * DELETE /file - Delete a file from CDL S3
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  delete_file(body: DeleteFileBody, options?: RequestOptions): ResponsePromise<DeleteFileResponse> {
+    return this.request("file", "delete_file", "delete", `/file`, body, options);
+  }
+
   /**
    * POST /message - Create a Message
    *

package/src/interface/file.ts

@@ -25,3 +25,20 @@ export type PostFileResponse = File;
 export interface PostFileRequest {
   body: PostFileBody;
 }
+
+// DELETE /file - Delete a file from CDL S3
+
+export interface DeleteFileBody {
+  // Specify the bucket name
+  bucket_name: string;
+  // Specify the full S3 file path
+  file_path: string;
+}
+
+export interface DeleteFileResponse {
+  success?: boolean;
+}
+
+export interface DeleteFileRequest {
+  body: DeleteFileBody;
+}

package/src/interface/location.ts

@@ -333,7 +333,7 @@ export interface Groups {
   groups?: Group[];
 }
 
-export interface PostOrPatchDeliveryDestination {
+export interface PostDeliveryDestination {
   // Name of the delivery destination
   name: string;
   // Boolean to indicate whether the delivery destination is a foodlocker or not
@@ -345,7 +345,7 @@ export interface PostOrPatchDeliveryDestination {
 
 export interface DeliveryDestination {
   // delivery_destination
-  id?: string;
+  id: string;
   // Name of the delivery destination
   name: string;
   // Boolean to indicate whether the delivery destination is a foodlocker or not
@@ -753,7 +753,7 @@ export interface PostLocationGroupDeliverydestinationPath {
   id: string;
 }
 
-export type PostLocationGroupDeliverydestinationBody = PostOrPatchDeliveryDestination;
+export type PostLocationGroupDeliverydestinationBody = PostDeliveryDestination;
 
 export type PostLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
@@ -770,11 +770,11 @@ export interface PatchLocationGroupDeliverydestinationPath {
 }
 
 export interface PatchLocationGroupDeliverydestinationBody {
-  delivery_destinations?: PostOrPatchDeliveryDestination;
+  delivery_destinations: DeliveryDestination[];
 }
 
 export interface PatchLocationGroupDeliverydestinationResponse {
-  delivery_destinations?: DeliveryDestination;
+  delivery_destinations: DeliveryDestination[];
 }
 
 export interface PatchLocationGroupDeliverydestinationRequest
@@ -790,11 +790,11 @@ export interface DeleteLocationGroupDeliverydestinationPath {
 }
 
 export interface DeleteLocationGroupDeliverydestinationBody {
-  delivery_destination_ids?: string[];
+  delivery_destination_ids: string[];
 }
 
 export interface DeleteLocationGroupDeliverydestinationResponse {
-  deleted_delivery_destinations?: DeliveryDestination;
+  deleted_delivery_destinations: DeliveryDestination[];
 }
 
 export interface DeleteLocationGroupDeliverydestinationRequest
@@ -1235,3 +1235,21 @@ export type GetLocationBrandExternalResponse = Location;
 export interface GetLocationBrandExternalRequest
   extends GetLocationBrandExternalQuery,
     GetLocationBrandExternalPath {}
+
+// DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
+
+export interface DeleteLocationRecordPath {
+  // brand, location, group, or multigroup id
+  id: string;
+}
+
+export interface DeleteLocationRecordQuery {
+  // Don't delete the record
+  dryrun?: boolean;
+}
+
+export type DeleteLocationRecordResponse = any;
+
+export interface DeleteLocationRecordRequest
+  extends DeleteLocationRecordQuery,
+    DeleteLocationRecordPath {}

package/src/interface/order.ts

@@ -98,14 +98,17 @@ export interface Order {
     ready?: boolean;
     out_for_delivery?: boolean;
     delivered?: boolean;
+    checkin_order?: boolean;
   };
   date?: {
+    accepted?: string;
     created?: string;
     modified?: string;
     should_start?: string;
     completion_warning?: string;
     ready?: string;
     started?: string;
+    show_as_active_until?: string;
   };
   pickup?: string;
   pickup_name?: string;

package/src/interface/user.ts

@@ -19,6 +19,7 @@ export interface User {
   };
   birthday?: string;
   password?: string;
+  // User phone number
   phone?: number;
   // realm
   realm?: string;
@@ -596,7 +597,31 @@ export interface PutUserVerifyUserEmailRequest extends PutUserVerifyUserEmailPat
   body: PutUserVerifyUserEmailBody;
 }
 
-// PUT /user/{id}/verification/phone - Send phone verification to user
+// POST /user/{id}/verification/phone - Send phone verification to user
+
+export interface PostUserVerificationPhonePath {
+  // realm
+  id: string;
+}
+
+export interface PostUserVerificationPhoneQuery {
+  // The language of the sms, currently en, fr supported.
+  lang?: string;
+}
+
+export interface PostUserVerificationPhoneBody {
+  phone: string;
+}
+
+export type PostUserVerificationPhoneResponse = success;
+
+export interface PostUserVerificationPhoneRequest
+  extends PostUserVerificationPhoneQuery,
+    PostUserVerificationPhonePath {
+  body: PostUserVerificationPhoneBody;
+}
+
+// PUT /user/{id}/verification/phone - Attempt phone verification for user
 
 export interface PutUserVerificationPhonePath {
   // realm
@@ -604,8 +629,8 @@ export interface PutUserVerificationPhonePath {
 }
 
 export interface PutUserVerificationPhoneBody {
-  // User phone number to be verified
-  phone: string;
+  // Phone verification code
+  verification_code: string;
 }
 
 export type PutUserVerificationPhoneResponse = success;