@compassdigital/sdk.typescript 3.0.0-rc.2 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compassdigital/sdk.typescript",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0",
   "description": "Compass Digital Labs TypeScript SDK",
   "type": "commonjs",
   "bin": "./bin/index.js",
@@ -21,11 +21,14 @@
     }
   },
   "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "transform": {
+      "^.+\\.tsx?$": "esbuild-jest"
+    }
   },
   "scripts": {
     "test": "jest",
+    "build": "",
     "gen": "ts-node gen.ts --manifest ./manifest.json && tsc",
     "prepare": "rimraf ./lib && tsc && tsc --esModuleInterop --outDir ./bin gen.ts"
   },
@@ -35,17 +38,19 @@
     "cross-fetch": "^3.1.4"
   },
   "devDependencies": {
-    "@icholy/openapi-ts": "^2.5.1",
+    "@icholy/openapi-ts": "^2.6.0",
     "@types/ejs": "^3.1.0",
     "@types/jest": "^27.0.1",
     "@types/node": "^16.7.2",
     "@types/prettier": "^2.3.2",
     "ejs": "^3.1.6",
+    "esbuild": "^0.13.15",
+    "esbuild-jest": "^0.5.0",
     "jest": "^27.1.0",
     "prettier": "^2.3.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^27.0.5",
     "ts-node": "^10.2.1",
+    "typescript": "^4.5.2",
     "yargs": "^17.1.1"
   }
 }

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";
@@ -444,6 +449,7 @@ import {
   GetCalendarResponse,
   PutCalendarBody,
   PutCalendarResponse,
+  DeleteCalendarResponse,
   GetCalendarCdlQuery,
   GetCalendarCdlResponse,
   GetCalendarSwaggerResponse,
@@ -475,7 +481,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 +2080,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 +4265,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
@@ -4746,6 +4803,16 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("calendar", "put_calendar", "put", `/calendar/${id}`, body, options);
   }
 
+  /**
+   * DELETE /calendar/{id} - Delete a calendar.
+   *
+   * @param id - brand
+   * @param options - additional request options
+   */
+  delete_calendar(id: string, options?: RequestOptions): ResponsePromise<DeleteCalendarResponse> {
+    return this.request("calendar", "delete_calendar", "delete", `/calendar/${id}`, null, options);
+  }
+
   /**
    * GET /calendar/{id}/cdl - Get the calendar events in a CDL compatible format for next 7 days
    *
@@ -4960,6 +5027,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/calendar.ts

@@ -88,6 +88,17 @@ export interface PutCalendarRequest extends PutCalendarPath {
   body: PutCalendarBody;
 }
 
+// DELETE /calendar/{id} - Delete a calendar.
+
+export interface DeleteCalendarPath {
+  // brand
+  id: string;
+}
+
+export type DeleteCalendarResponse = Success;
+
+export interface DeleteCalendarRequest extends DeleteCalendarPath {}
+
 // GET /calendar/{id}/cdl - Get the calendar events in a CDL compatible format for next 7 days
 
 export interface GetCalendarCdlPath {

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

@@ -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/partner.ts

@@ -351,6 +351,7 @@ export interface LocationGroup {
           fr?: string;
         };
       };
+      external_id?: string;
       [index: string]: any;
     }[];
     meta?: any;

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;