@compassdigital/sdk.typescript 3.29.0 → 3.31.0

package/src/interface/payment.ts

@@ -114,6 +114,9 @@ export interface Options {
   pickup_id?: string;
   // user_id
   user_id?: string;
+  payment_type?: string;
+  // ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
+  tender_id?: string;
 }
 
 export interface Success {
@@ -125,6 +128,12 @@ export interface Error {
   code?: number;
 }
 
+export interface BadgePayTender {
+  balance?: number;
+  // ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
+  id?: string;
+}
+
 // POST /payment/{id}/transaction
 
 export interface PostPaymentTransactionPath {
@@ -134,7 +143,7 @@ export interface PostPaymentTransactionPath {
 
 export interface PostPaymentTransactionBody {
   // The payment method token to use for the payment
-  payment_method_token: string;
+  payment_method_token?: string;
   // The amount to charge to the payment method
   amount: string;
   options?: Options;
@@ -405,3 +414,36 @@ export interface GetPaymentHcaptchaVerifyResponse {
 export interface GetPaymentHcaptchaVerifyRequest
   extends BaseRequest,
     RequestQuery<GetPaymentHcaptchaVerifyQuery> {}
+
+// GET /payment/{id}/badgepay
+
+export interface GetPaymentBadgepayPath {
+  // TODO: add parameter to swagger.json
+  id: string;
+}
+
+export interface GetPaymentBadgepayResponse {
+  tenders?: BadgePayTender[];
+}
+
+export interface GetPaymentBadgepayRequest extends BaseRequest, GetPaymentBadgepayPath {}
+
+// POST /payment/{id}/badgepay
+
+export interface PostPaymentBadgepayPath {
+  // TODO: add parameter to swagger.json
+  id: string;
+}
+
+export interface PostPaymentBadgepayBody {
+  // The reference ID returned from FP account confirmation
+  token: string;
+}
+
+export interface PostPaymentBadgepayResponse {
+  tenders?: BadgePayTender[];
+}
+
+export interface PostPaymentBadgepayRequest extends BaseRequest, PostPaymentBadgepayPath {
+  body: PostPaymentBadgepayBody;
+}

package/src/interface/shoppingcart.ts

@@ -87,6 +87,12 @@ export interface Promo {
   email?: string;
 }
 
+export interface BadgePay {
+  id?: string;
+  total?: number;
+  tender?: string;
+}
+
 export interface Payment {
   email?: string;
   mealplan?: {
@@ -113,6 +119,11 @@ export interface Payment {
     rate?: number;
     total?: number;
   };
+  meal_exchange?: {
+    id?: string;
+    tender?: string;
+  };
+  badge_pay?: BadgePay;
 }
 
 export interface MenuID {
@@ -120,7 +131,7 @@ export interface MenuID {
 }
 
 export interface ShoppingCarts {
-  shoppingcarts?: ShoppingCart[];
+  shoppingcarts?: ShoppingCartResponse[];
 }
 
 export interface OrderId {
@@ -128,7 +139,31 @@ export interface OrderId {
   id?: string;
 }
 
-export interface ShoppingCart {
+export interface ShoppingCartRequest {
+  // location
+  location?: string;
+  // menu
+  menu?: string;
+  // brand
+  brand?: string;
+  is?: {
+    // Shoppingcart Type: delivery, pickup
+    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
+    email_tax_exempt?: boolean;
+    // Indicates to clients that a tax recalculation is required
+    tax_calculation_required?: boolean;
+  };
+  meta?: {
+    // Raw request from any vendor integrated with CDL
+    vendor?: any;
+    [index: string]: any;
+  };
+}
+
+export interface ShoppingCartResponse {
   // shoppingcart
   id?: string;
   // location
@@ -195,6 +230,7 @@ export interface ShoppingCart {
       id?: string;
       tender?: string;
     };
+    badge_pay?: BadgePay;
   };
   taxes?: taxes;
   total?: {
@@ -219,8 +255,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;
+    // If a user's email or email domain is a match in a sites list of tax exempt emails or domains
+    email_tax_exempt?: boolean;
     // Indicates to clients that a tax recalculation is required
     tax_calculation_required?: boolean;
   };
@@ -231,11 +267,13 @@ export interface ShoppingCart {
   };
 }
 
+export type ShoppingCart = ShoppingCartResponse;
+
 // POST /shoppingcart/ - Create a new ShoppingCart
 
-export type PostShoppingcartCartBody = ShoppingCart;
+export type PostShoppingcartCartBody = ShoppingCartRequest;
 
-export type PostShoppingcartCartResponse = ShoppingCart;
+export type PostShoppingcartCartResponse = ShoppingCartResponse;
 
 export interface PostShoppingcartCartRequest extends BaseRequest {
   body: PostShoppingcartCartBody;
@@ -250,7 +288,7 @@ export interface PutShoppingcartCartItemsPath {
 
 export type PutShoppingcartCartItemsBody = Items;
 
-export type PutShoppingcartCartItemsResponse = ShoppingCart;
+export type PutShoppingcartCartItemsResponse = ShoppingCartResponse;
 
 export interface PutShoppingcartCartItemsRequest extends BaseRequest, PutShoppingcartCartItemsPath {
   body: PutShoppingcartCartItemsBody;
@@ -265,7 +303,7 @@ export interface DeleteShoppingcartCartItemsPath {
 
 export type DeleteShoppingcartCartItemsBody = Items;
 
-export type DeleteShoppingcartCartItemsResponse = ShoppingCart;
+export type DeleteShoppingcartCartItemsResponse = ShoppingCartResponse;
 
 export interface DeleteShoppingcartCartItemsRequest
   extends BaseRequest,
@@ -280,7 +318,7 @@ export interface GetShoppingcartCartPath {
   id: string;
 }
 
-export type GetShoppingcartCartResponse = ShoppingCart;
+export type GetShoppingcartCartResponse = ShoppingCartResponse;
 
 export interface GetShoppingcartCartRequest extends BaseRequest, GetShoppingcartCartPath {}
 
@@ -291,9 +329,9 @@ export interface PatchShoppingcartCartPath {
   id: string;
 }
 
-export type PatchShoppingcartCartBody = ShoppingCart;
+export type PatchShoppingcartCartBody = ShoppingCartResponse;
 
-export type PatchShoppingcartCartResponse = ShoppingCart;
+export type PatchShoppingcartCartResponse = ShoppingCartResponse;
 
 export interface PatchShoppingcartCartRequest extends BaseRequest, PatchShoppingcartCartPath {
   body: PatchShoppingcartCartBody;
@@ -308,7 +346,7 @@ export interface PutShoppingcartCartPromoPath {
 
 export type PutShoppingcartCartPromoBody = Promo;
 
-export type PutShoppingcartCartPromoResponse = ShoppingCart;
+export type PutShoppingcartCartPromoResponse = ShoppingCartResponse;
 
 export interface PutShoppingcartCartPromoRequest extends BaseRequest, PutShoppingcartCartPromoPath {
   body: PutShoppingcartCartPromoBody;
@@ -321,7 +359,7 @@ export interface DeleteShoppingcartCartPromoPath {
   id: string;
 }
 
-export type DeleteShoppingcartCartPromoResponse = ShoppingCart;
+export type DeleteShoppingcartCartPromoResponse = ShoppingCartResponse;
 
 export interface DeleteShoppingcartCartPromoRequest
   extends BaseRequest,
@@ -336,7 +374,7 @@ export interface PutShoppingcartCartPaymentPath {
 
 export type PutShoppingcartCartPaymentBody = Payment;
 
-export type PutShoppingcartCartPaymentResponse = ShoppingCart;
+export type PutShoppingcartCartPaymentResponse = ShoppingCartResponse;
 
 export interface PutShoppingcartCartPaymentRequest
   extends BaseRequest,
@@ -353,7 +391,7 @@ export interface PutShoppingcartCartOrderPath {
 
 export type PutShoppingcartCartOrderBody = OrderId;
 
-export type PutShoppingcartCartOrderResponse = ShoppingCart;
+export type PutShoppingcartCartOrderResponse = ShoppingCartResponse;
 
 export interface PutShoppingcartCartOrderRequest extends BaseRequest, PutShoppingcartCartOrderPath {
   body: PutShoppingcartCartOrderBody;
@@ -371,7 +409,7 @@ export interface PostShoppingcartCloneCartBody {
   order_type?: string;
 }
 
-export type PostShoppingcartCloneCartResponse = ShoppingCart;
+export type PostShoppingcartCloneCartResponse = ShoppingCartResponse;
 
 export interface PostShoppingcartCloneCartRequest
   extends BaseRequest,
@@ -386,7 +424,7 @@ export interface PutShoppingcartCheckoutPath {
   id: string;
 }
 
-export type PutShoppingcartCheckoutResponse = ShoppingCart;
+export type PutShoppingcartCheckoutResponse = ShoppingCartResponse;
 
 export interface PutShoppingcartCheckoutRequest extends BaseRequest, PutShoppingcartCheckoutPath {}
 

package/src/interface/user.ts

@@ -74,6 +74,11 @@ export interface GuestUserCreate {
   realm?: string;
 }
 
+export interface GuestUserToken {
+  // realm
+  realm?: string;
+}
+
 export interface Changepassword {
   password?: string;
   new_password?: string;
@@ -90,6 +95,7 @@ export interface Resetpassword {
 
 export interface ResetpasswordSuccess {
   code?: number;
+  success?: boolean;
 }
 
 export interface VerifyEmail {
@@ -124,6 +130,15 @@ export interface guestAuth {
   };
   // user
   user?: string;
+  profile?: User;
+}
+
+export interface guestAuthToken {
+  token?: string;
+  access?: {
+    token?: string;
+    expires?: string;
+  };
 }
 
 export type Permission = string;
@@ -695,3 +710,13 @@ export type PostUserGuestUserResponse = guestAuth;
 export interface PostUserGuestUserRequest extends BaseRequest {
   body: PostUserGuestUserBody;
 }
+
+// POST /user/guest/token - Creates a temporary guest token
+
+export type PostUserGuestTokenBody = GuestUserToken;
+
+export type PostUserGuestTokenResponse = guestAuthToken;
+
+export interface PostUserGuestTokenRequest extends BaseRequest {
+  body: PostUserGuestTokenBody;
+}