@compassdigital/sdk.typescript 4.6.0 → 4.7.0

package/src/interface/frictionless.ts

@@ -11,31 +11,102 @@ export interface StandardCognitionEvent {
   order_id: string;
 }
 
+export interface AmazonJWOAuthEventDTO {
+  id: string;
+  timestamp: string;
+  location: "ENTRY" | "EXIT";
+}
+
+export interface AmazonJWOIdentityKeysRequestDTO {
+  authEvent: AmazonJWOAuthEventDTO;
+  identityKey: string;
+  requestId: string;
+  storeId: string;
+}
+
+export interface VisitDetailsDTO {
+  id: string;
+  type: "SHOPPER" | "ASSOCIATE" | "CASH_SHOPPER";
+}
+
+export interface AmazonJWOIdentityKeysResponseDTO {
+  visitDetails: VisitDetailsDTO;
+}
+
+export interface BadRequestErrorDTO {
+  message: string;
+  code: number;
+  data: Record<string, any>;
+}
+
+export interface UnauthorizedErrorDTO {
+  message: string;
+  code: number;
+  data: Record<string, any>;
+}
+
+export interface ShoppingTrip {
+  startTime: string;
+  endTime: string;
+  authEvents: AmazonJWOAuthEventDTO[];
+}
+
+export interface Quantity {
+  value: string;
+  unit: string;
+}
+
+export interface CartItem {
+  id: string;
+  type: string;
+  quantity: Quantity;
+}
+
+export interface ShopperIdentity {
+  id: string;
+}
+
+export interface AmazonJWOOrderingRequestDTO {
+  requestId: string;
+  idempotentShoppingTripId: string;
+  storeId: string;
+  shoppingTrip: ShoppingTrip;
+  cartItems: CartItem[];
+  shopperIdentity: ShopperIdentity;
+}
+
+export interface AmazonJWOOrderingResponseDTO {
+  purchaseId: string;
+}
+
 export interface FrictionlessSupportResponse {
   supported: boolean;
   version?: "NFC" | "QR";
 }
 
 export interface ForbiddenErrorDTO {
-  statusCode: number;
-  timestamp: string;
   message: string;
+  code: number;
+  data: Record<string, any>;
 }
 
 export interface NotFoundErrorDTO {
-  statusCode: number;
-  timestamp: string;
   message: string;
+  code: number;
+  data: Record<string, any>;
 }
 
-export type MealplanDTO = Record<string, any>;
+export interface MealplanDTO {
+  tenderID: string;
+  name: string;
+}
 
 export interface CreditCardDTO {
   cardType: string;
   last4: string;
 }
 
-export interface PaymentMethod {
+export interface PaymentMethodDTO {
   mealplan?: MealplanDTO;
   creditCard?: CreditCardDTO;
   token: string;
@@ -44,7 +115,7 @@ export interface PaymentMethod {
 export interface CreateFrictionlessQRCodeCommand {
   brandID: string;
   userID: string;
-  paymentMethod: PaymentMethod;
+  paymentMethod: PaymentMethodDTO;
 }
 
 export interface QRCodeCreationResponse {
@@ -53,10 +124,22 @@ export interface QRCodeCreationResponse {
   id: string;
 }
 
-export interface UnprocessableEntityErrorDTO {
-  statusCode: number;
+export interface DisplayMessageDTO {
+  title: string;
+  description: string;
+}
+
+export interface ErrorDataDTO {
+  description: string;
   timestamp: string;
+  statusCode: number;
+  displayMessage: DisplayMessageDTO;
+}
+
+export interface UnprocessableEntityErrorDTO {
+  code: number;
   message: string;
+  data: ErrorDataDTO;
 }
 
 export interface FailedCheckInDTO {
@@ -66,90 +149,157 @@ export interface FailedCheckInDTO {
   reason: string;
 }
 
-export interface CheckCheckInStatusResponseDTO {
-  status: "CREATING" | "ACTIVE" | "ERROR" | "CANCELED" | "PROCESSING" | "COMPLETED";
+export interface GetCheckInStatusResponseDTO {
+  status:
+    | "CREATING"
+    | "ACTIVE"
+    | "ERROR"
+    | "CANCELED"
+    | "PROCESSING"
+    | "UPDATE_PAYMENT_REQUIRED"
+    | "COMPLETED";
+}
+
+export interface CheckInPaymentRequiredDTO {
+  id: string;
 }
 
 // POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
 
-export type StandardCognitionEventWebhookControllerExecuteBody = StandardCognitionEvent;
+export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEvent;
+
+export type PostFrictionlessWebhookStandardcognitionResponse = {};
+
+export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
+  body: PostFrictionlessWebhookStandardcognitionBody;
+}
+
+// POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
+
+export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
+  AmazonJWOIdentityKeysRequestDTO;
+
+export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
+  AmazonJWOIdentityKeysResponseDTO;
+
+export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
+  extends BaseRequest {
+  body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
+}
+
+// POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
+
+export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
 
-export type StandardCognitionEventWebhookControllerExecuteResponse = {};
+export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
+  AmazonJWOOrderingResponseDTO;
 
-export interface StandardCognitionEventWebhookControllerExecuteRequest extends BaseRequest {
-  body: StandardCognitionEventWebhookControllerExecuteBody;
+export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
+  body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
 }
 
 // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
 
-export interface CheckFrictionlessSupportControllerExecutePath {
+export interface GetFrictionlessBrandFrictionlessStatusPath {
   // Brand ID as Encoded CDL ID
   id_brand: string;
 }
 
-export interface CheckFrictionlessSupportControllerExecuteQuery {
+export interface GetFrictionlessBrandFrictionlessStatusQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type CheckFrictionlessSupportControllerExecuteResponse = FrictionlessSupportResponse;
+export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponse;
 
-export interface CheckFrictionlessSupportControllerExecuteRequest
+export interface GetFrictionlessBrandFrictionlessStatusRequest
   extends BaseRequest,
-    RequestQuery<CheckFrictionlessSupportControllerExecuteQuery>,
-    CheckFrictionlessSupportControllerExecutePath {}
+    RequestQuery<GetFrictionlessBrandFrictionlessStatusQuery>,
+    GetFrictionlessBrandFrictionlessStatusPath {}
 
 // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
 
-export type CreateQRCodeUserCheckInControllerExecuteBody = CreateFrictionlessQRCodeCommand;
+export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommand;
 
-export type CreateQRCodeUserCheckInControllerExecuteResponse = {};
+export type PostFrictionlessQrCodeResponse = {};
 
-export interface CreateQRCodeUserCheckInControllerExecuteRequest extends BaseRequest {
-  body: CreateQRCodeUserCheckInControllerExecuteBody;
+export interface PostFrictionlessQrCodeRequest extends BaseRequest {
+  body: PostFrictionlessQrCodeBody;
 }
 
 // GET /frictionless/failed-checkins - List check-ins on error
 
-export interface ListFailedCheckinsControllerExecuteQuery {
+export interface GetFrictionlessFailedCheckinsQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type ListFailedCheckinsControllerExecuteResponse = FailedCheckInDTO[];
+export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
 
-export interface ListFailedCheckinsControllerExecuteRequest
+export interface GetFrictionlessFailedCheckinsRequest
   extends BaseRequest,
-    RequestQuery<ListFailedCheckinsControllerExecuteQuery> {}
+    RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
 
-// POST /frictionless/checkin/{id_checkin}/reprocess - Reprocess checkin on error
+// POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
 
-export interface ReprocessCheckinOnErrorControllerExecutePath {
-  // TODO: add parameter to swagger.json
+export interface PostFrictionlessCheckinsReprocessPath {
   id_checkin: string;
 }
 
-export type ReprocessCheckinOnErrorControllerExecuteResponse = {};
+export type PostFrictionlessCheckinsReprocessResponse = {};
 
-export interface ReprocessCheckinOnErrorControllerExecuteRequest
+export interface PostFrictionlessCheckinsReprocessRequest
   extends BaseRequest,
-    ReprocessCheckinOnErrorControllerExecutePath {}
+    PostFrictionlessCheckinsReprocessPath {}
 
-// GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn status
+// GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
 
-export interface CheckCheckinStatusControllerExecutePath {
-  // TODO: add parameter to swagger.json
+export interface GetFrictionlessCheckinStatusPath {
   id_checkin: string;
 }
 
-export interface CheckCheckinStatusControllerExecuteQuery {
+export interface GetFrictionlessCheckinStatusQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type CheckCheckinStatusControllerExecuteResponse = CheckCheckInStatusResponseDTO;
+export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
 
-export interface CheckCheckinStatusControllerExecuteRequest
+export interface GetFrictionlessCheckinStatusRequest
   extends BaseRequest,
-    RequestQuery<CheckCheckinStatusControllerExecuteQuery>,
-    CheckCheckinStatusControllerExecutePath {}
+    RequestQuery<GetFrictionlessCheckinStatusQuery>,
+    GetFrictionlessCheckinStatusPath {}
+
+// GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
+
+export interface GetFrictionlessUsersPaymentIssuesPath {
+  user_id: string;
+}
+
+export interface GetFrictionlessUsersPaymentIssuesQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetFrictionlessUsersPaymentIssuesResponse = CheckInPaymentRequiredDTO[];
+
+export interface GetFrictionlessUsersPaymentIssuesRequest
+  extends BaseRequest,
+    RequestQuery<GetFrictionlessUsersPaymentIssuesQuery>,
+    GetFrictionlessUsersPaymentIssuesPath {}
+
+// POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
+
+export interface PostFrictionlessCheckinReprocessPaymentPath {
+  checkin_id: string;
+}
+
+export type PostFrictionlessCheckinReprocessPaymentBody = PaymentMethodDTO;
+
+export type PostFrictionlessCheckinReprocessPaymentResponse = {};
+
+export interface PostFrictionlessCheckinReprocessPaymentRequest
+  extends BaseRequest,
+    PostFrictionlessCheckinReprocessPaymentPath {
+  body: PostFrictionlessCheckinReprocessPaymentBody;
+}

package/src/interface/mealplan.ts

@@ -81,6 +81,7 @@ export interface PostMealplanBody {
   password?: string;
   // Used for email domain validation, if enabled for current mealplan.
   email?: string;
+  lang?: string;
 }
 
 export interface PostMealplanResponse {