@compassdigital/sdk.typescript 3.77.1 → 4.1.0

package/src/interface/user.ts

@@ -29,11 +29,11 @@ export interface User {
   phone_country_code?: string;
   // realm
   realm?: string;
-  gender?: string;
+  gender?: "male" | "female" | "non-binary";
   meta?: {
     marketing_opt_in?: boolean;
     marketing_opt_in_date?: string;
-    marketing_opt_in_source?: string;
+    marketing_opt_in_source?: "App" | "Web";
     // Stores notification preference for order status, opt-in/opt-out from receiving order status update notifications
     order_status_notification?: {
       send_emails?: boolean;
@@ -106,7 +106,7 @@ export interface Changepassword {
 
 export interface Forgotpassword {
   email: string;
-  type?: string;
+  type?: "forgot_password" | "new_user";
 }
 
 export interface Resetpassword {
@@ -230,7 +230,7 @@ export interface Checkin {
   user_id?: string;
   date_queued?: string;
   // The state of the user association process (attaching). Present for NFC check-ins only
-  state?: string;
+  state?: "new" | "unconfirmed" | "associated" | "failed";
   meta?: CheckinMeta;
 }
 
@@ -238,41 +238,23 @@ export interface PatchCheckin {
   // Date when the checkin was put into the queue to be processed.
   date_queued?: number;
   // The state of the user association process (attaching). Present for NFC check-ins only
-  state?: string;
+  state?: "new" | "unconfirmed" | "associated" | "failed";
   meta?: CheckinMeta;
 }
 
 export interface CheckinMeta {
   order_id?: string;
-  status?: string;
+  status?: "processed" | "failed";
   logs?: {
     code?: number;
     date?: string;
     message?: string;
-    type?: string;
+    type?: "error" | "log";
     [index: string]: any;
   }[];
   [index: string]: any;
 }
 
-export interface postOMS {
-  in?: any;
-  name?: any;
-  required?: any;
-  schema?: postOMSBody;
-}
-
-export interface postOMSBody {
-  // OMS code from commpass sso
-  code?: string;
-  // the oms url for compass
-  oms_url?: string;
-  // the return uri for compassconnect
-  callback_uri?: string;
-  // the id of the application for compassconnect
-  client_id?: string;
-}
-
 export interface RefreshToken {
   refresh_token?: string;
 }
@@ -358,7 +340,16 @@ export interface PostUserAuthRequest extends BaseRequest {
 
 // POST /user/oauth - Fetches a jwt token containing a compass token
 
-export type PostUserOauthBody = postOMS;
+export interface PostUserOauthBody {
+  // OMS code from commpass sso
+  code?: string;
+  // the oms url for compass
+  oms_url?: string;
+  // the return uri for compassconnect
+  callback_uri?: string;
+  // the id of the application for compassconnect
+  client_id?: string;
+}
 
 export type PostUserOauthResponse = omsauth;
 
@@ -790,7 +781,10 @@ export interface PostUserGuestTokenRequest extends BaseRequest {
 
 // POST /user/looker/embedurl - Create looker embed url
 
-export type PostUserEmbedurlBody = any;
+export interface PostUserEmbedurlBody {
+  // Url to be embedded
+  url?: string;
+}
 
 export interface PostUserEmbedurlResponse {
   // Embed url

package/src/interface/vendor.ts

@@ -46,7 +46,7 @@ export interface ApplicationPatchBody {
     };
     [index: string]: any;
   };
-  status?: string;
+  status?: "pending" | "approved" | "rejected";
 }
 
 export interface Application {
@@ -71,7 +71,7 @@ export interface Application {
     vendor_id?: string;
     [index: string]: any;
   };
-  status?: string;
+  status?: "pending" | "approved" | "rejected";
 }
 
 export interface Applications {
@@ -146,7 +146,7 @@ export interface Key {
   client_password?: string;
   // Date the key becomes expired
   date_expires?: string;
-  environment?: string;
+  environment?: "dev" | "staging" | "v1";
   permissions?: string[];
   // Flag identifying if the key is latest
   active?: boolean;
@@ -158,7 +158,7 @@ export interface KeyPostBody {
   vendor_id: string;
   // Date the key becomes expired
   date_expires: string;
-  environment: string;
+  environment: "dev" | "staging" | "v1";
   permissions: string[];
 }
 
@@ -211,7 +211,7 @@ export interface PostVendorApplicationRequest extends BaseRequest {
 // GET /vendor/application - Get a list of all applications
 
 export interface GetVendorApplicationQuery {
-  status?: string;
+  status?: "pending" | "approved" | "rejected";
   // Pagination token to start query from
   last_evaluated_key?: string;
   // Graphql query string