@compassdigital/sdk.typescript 4.5.0 → 4.7.0

package/src/interface/config.ts

@@ -3,7 +3,7 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
-export type CreateConfig = any;
+export type CreateConfig = Record<string, any>;
 
 export interface Config {
   [index: string]: any;
@@ -12,7 +12,7 @@ export interface Config {
 export interface Error {
   error?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface Success {
@@ -42,7 +42,7 @@ export interface PublicBrandConfig {
 }
 
 export interface PublicLocationConfig {
-  mealplan?: MealplanConfig[];
+  mealplan?: PublicMealplanConfig[];
   badge_pay?: {
     id?: string;
     type?: string;
@@ -75,7 +75,13 @@ export interface AppConfig {
 export interface PrivateConfig {
   payment?: {
     refund?: boolean;
-    freedompay?: any;
+    freedompay?: {
+      id?: string;
+      // backwards compatibility placeholder for mobile
+      freedompay_store_id?: string;
+      // backwards compatibility placeholder for mobile
+      freedompay_terminal_id?: string;
+    };
   };
   loyalty?: {
     provider_id?: string;
@@ -84,26 +90,86 @@ export interface PrivateConfig {
       email?: string;
     }[];
   };
-  mealplan?: MealplanConfig[];
+  mealplan?: PrivateMealplanConfig[];
+  keystore?: {
+    schema?: Keystore;
+  };
   [index: string]: any;
 }
 
-export interface MealplanConfig {
+export interface PublicMealplanConfig {
   id?: string;
   type?: string;
   name?: string;
-  tenders?: {
-    max_swipes_per_transaction?: number;
-    name?: string;
-    rates?: {
-      amount?: any;
-      hours?: any;
-    }[];
-    tender_number?: string;
-    type?: string;
-    id?: string;
-    tax_exempt?: boolean;
+  tenders?: Tender[];
+}
+
+export interface PrivateMealplanConfig {
+  id?: string;
+  name?: string;
+  type?: string;
+  version?: number;
+  config?: {
+    tenders?: Tender[];
+    terminal_id?: string;
+    version?: string;
+  };
+  keystore?: {
+    API_URL?: string;
+    api_url?: string;
+    key?: string;
+    operator_id?: string;
+    operator_password?: string;
+    certificate?: {
+      name?: string;
+      encoded_file?: string;
+      password?: string;
+    };
+    device_id?: number;
+    endpoint?: string;
+    vendor_id?: string;
+    webview?: string;
+    aes_key?: string;
+    host?: string;
+    manual_id_entry?: string;
+    port?: number;
+    vendor_number?: number;
+  };
+}
+
+export interface Keystore {
+  mealplan?: CbordMealplanConfig;
+  payment?: {
+    freedompay?: {
+      id?: string;
+      freedompay_store_id?: string;
+      freedompay_terminal_id?: string;
+    };
+  };
+}
+
+export interface CbordMealplanConfig {
+  auth_type?: number;
+  auth_url?: string;
+  name?: string;
+  type?: string;
+  uuid?: string;
+  short_name?: string;
+  primary_color?: string;
+  [index: string]: any;
+}
+
+export interface Tender {
+  max_swipes_per_transaction?: number;
+  name?: string;
+  rates?: {
+    amount?: number;
+    hours?: string;
   }[];
+  tender_number?: string;
+  type?: string;
+  id?: string;
+  tax_exempt?: boolean;
 }
 
 // GET /config/appconfig - get appconfig - an object with data for clients including minimum versions apps (boost, thrive, J&J) should be running and a link to the respective app store

package/src/interface/datalake.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   error?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface QueryBody {
@@ -34,7 +34,7 @@ export interface GetDatalakeSwaggerQuery {
   _query?: string;
 }
 
-export type GetDatalakeSwaggerResponse = any;
+export type GetDatalakeSwaggerResponse = Record<string, any>;
 
 export interface GetDatalakeSwaggerRequest
   extends BaseRequest,

package/src/interface/delivery.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface Delivery {
@@ -81,8 +81,8 @@ export interface Available {
 
 export interface PostAvailabilityBody {
   destination: {
-    latitude: any;
-    longitude: any;
+    latitude: Record<string, any>;
+    longitude: Record<string, any>;
   };
   brand_id: string;
 }

package/src/interface/email.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface Success {
@@ -20,7 +20,7 @@ export interface EmailPayload {
   // Text of an email instead of template_id/data
   text?: string;
   template_id?: string;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 // POST /email - Send an email

package/src/interface/file.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface File {

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 = 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/kds.ts

@@ -11,7 +11,7 @@ export interface Error {
   error?: string;
   message?: string;
   code: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface Device {

package/src/interface/location.ts

@@ -95,10 +95,10 @@ export interface Brand {
   };
   hours?: Hours[];
   deliveryHours?: DeliveryHours[];
-  style?: any;
+  style?: Record<string, any>;
   // pos
   pos?: string;
-  terminals?: any[];
+  terminals?: Record<string, any>[];
   timeslots?: {
     time?: string;
     averagePrepTime?: string;
@@ -143,8 +143,8 @@ export interface Brand {
   // company
   company?: string;
   config?: {
-    private?: any;
-    public?: any;
+    private?: Record<string, any>;
+    public?: Record<string, any>;
   };
   tax_rate?: number;
   meta?: {
@@ -252,8 +252,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: any;
-    deliveryHours?: any;
+    hours?: Record<string, any>;
+    deliveryHours?: Record<string, any>;
     service_fee?: {
       type?: string;
       value?: number;
@@ -278,7 +278,7 @@ export interface Group {
   meta?: {
     [index: string]: any;
   };
-  style?: any;
+  style?: Record<string, any>;
   [index: string]: any;
 }
 
@@ -297,7 +297,7 @@ export interface success {
 export interface Error {
   error?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface Sector {
@@ -497,7 +497,7 @@ export interface GetLocationQuery {
   // When fetching location, brands will come with private and public configs
   include_brands_config?: boolean;
   // active cafes
-  active_cafes?: any[];
+  active_cafes?: Record<string, any>[];
   // show additional hidden properties/entities
   extended?: boolean;
   // Graphql query string
@@ -1211,7 +1211,7 @@ export interface PostLocationCompanyBody {
   name: string;
   // sector
   sector: string;
-  label?: any;
+  label?: Record<string, any>;
   is?: {
     global_images_enabled?: boolean;
   };

package/src/interface/mealplan.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
-  data?: any;
+  data?: Record<string, any>;
   headers?: {
     Location?: string;
   };
@@ -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 {