@compassdigital/sdk.typescript 4.26.0 → 4.28.0

package/src/interface/frictionless.ts

@@ -3,43 +3,11 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
-export interface StandardCognitionEvent {
-  event_id: string;
-  event_type: string;
-  external_customer_id: string;
-  tenant_id: string;
-  order_id: string;
-}
-
-export interface AmazonJWOAuthEventDTO {
-  // Value that uniquely identifies each authorization event that occurs when a shopper interacts with a JWO gate
-  id: string;
-  // Contains the timestamp when the	authorization event took place
-  timestamp: string;
-  // Contains an enumerated string that tells the system where the authorization event took place. Current values are ENTRY for the JWO Entry Gate and EXIT for the Exit Gate
-  location: "ENTRY" | "EXIT";
-}
-
-export interface AmazonJWOIdentityKeysRequestDTO {
-  authEvent: AmazonJWOAuthEventDTO;
-  identityKey: string;
-  requestId: string;
-  storeId: string;
-}
-
-export interface VisitorDetailsDTO {
-  id: string;
-  type: "SHOPPER" | "ASSOCIATE" | "CASH_SHOPPER";
-}
-
-export interface AmazonJWOIdentityKeysResponseDTO {
-  visitorDetails: VisitorDetailsDTO;
-}
-
-export interface BadRequestErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+export interface FrictionlessSupportResponseDTO {
+  // Whether the brand supports frictionless checkins
+  supported: boolean;
+  // The version of the frictionless support
+  version?: "NFC" | "QR";
 }
 
 export interface UnauthorizedErrorDTO {
@@ -48,55 +16,6 @@ export interface UnauthorizedErrorDTO {
   data: Record<string, any>;
 }
 
-export interface ShoppingTrip {
-  // Contains a timestamp for the time the shopping trip starts. This value is not validated on our service.
-  startTime: string;
-  // Contains a timestamp for the time the shopping trip ends. This value is not validated on our service.
-  endTime: string;
-  authEvents: AmazonJWOAuthEventDTO[];
-}
-
-export interface Quantity {
-  // Contains the number of each item the shopper purchased
-  value: string;
-  // Contains the type of unique identifier your store uses to identify each item in the cart
-  unit: "unit" | "each";
-}
-
-export interface CartItem {
-  // Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
-  id: string;
-  // Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
-  type: "SKU";
-  quantity: Quantity;
-}
-
-export interface ShopperIdentity {
-  // Contains a unique identifier for each	shopper AWS sends back. Refers to our CheckIn ID.
-  id: string;
-}
-
-export interface AmazonJWOOrderingRequestDTO {
-  // Contains a UUID for each checkout request. Amazon generates this UUID for	each request. If Amazon has to send the same request more than once, the requestId will be different for each request. Compare the requestId to the idempotentShoppingTripId field, which	remains the same throughout the shopping trip.
-  requestId: string;
-  // Contains a Universally Unique ID (UUID) for the current	shopping trip. Amazon generates this UUID for each shopping trip
-  idempotentShoppingTripId: string;
-  // The storeId field contains a unique identifier for your store on AWS system
-  storeId: string;
-  shoppingTrip: ShoppingTrip;
-  cartItems: CartItem[];
-  shopperIdentity: ShopperIdentity;
-}
-
-export interface AmazonJWOOrderingResponseDTO {
-  purchaseId: string;
-}
-
-export interface FrictionlessSupportResponse {
-  supported: boolean;
-  version?: "NFC" | "QR";
-}
-
 export interface ForbiddenErrorDTO {
   message: string;
   code: number;
@@ -110,30 +29,40 @@ export interface NotFoundErrorDTO {
 }
 
 export interface MealplanDTO {
+  // The unique identifier of the mealplan tender
   tenderID: string;
+  // The name of the mealplan
   name: string;
 }
 
 export interface CreditCardDTO {
+  // The CreditCard Type. This field is not validated. It is used to enrich checkin metadata
   cardType: string;
+  // The last 4 digits of the credit card
   last4: string;
 }
 
 export interface PaymentMethodDTO {
   mealplan?: MealplanDTO;
   creditCard?: CreditCardDTO;
+  // Token used for identify the payment method
   token: string;
 }
 
-export interface CreateFrictionlessQRCodeCommand {
+export interface CreateFrictionlessQRCodeCommandDTO {
+  // The unique identifier of the brand that the checkin should be created with
   brandID: string;
+  // The unique identifier of the user that the checkin should be created with
   userID: string;
   paymentMethod: PaymentMethodDTO;
 }
 
-export interface QRCodeCreationResponse {
+export interface QRCodeCreationResponseDTO {
+  // The base64 encoded QR code
   qrcode: string;
+  // The expiration time of the QR code in unix time. Always in future.
   expiration: number;
+  // The unique identifier for the checkin created for this QR code
   id: string;
 }
 
@@ -155,14 +84,8 @@ export interface UnprocessableEntityErrorDTO {
   data: ErrorDataDTO;
 }
 
-export interface FailedCheckInDTO {
-  id: string;
-  shopperID: string;
-  brandID: string;
-  reason: string;
-}
-
 export interface GetCheckInStatusResponseDTO {
+  // The status of the checkin
   status:
     | "CREATING"
     | "ACTIVE"
@@ -173,53 +96,138 @@ export interface GetCheckInStatusResponseDTO {
     | "COMPLETED";
 }
 
-export interface CheckInPaymentRequiredDTO {
-  id: string;
-}
-
 export interface GetCheckinResponseDTO {
+  // The unique identifier for this checkin
   id: string;
-  provider: string;
-  status: string;
+  // The third-party provider that the checkin was created on. The value varies based on the technology installed in the station.
+  provider: "AWS" | "SC";
+  // The status of the checkin
+  status:
+    | "CREATING"
+    | "ACTIVE"
+    | "ERROR"
+    | "CANCELED"
+    | "PROCESSING"
+    | "UPDATE_PAYMENT_REQUIRED"
+    | "COMPLETED";
+  // The reason why the checkin failed. This field is only present when the status is 'FAILED'
   reasonOfFail?: string;
+  // The ID of the checkin that was created in the third-party system. They might call this entity with other terminology
   thirdPartyCorrelatedID?: string;
+  // The shopping cart ID for this checkin. This field is only present if the checkin was processed or is being processed but the shopping cart was already created.
   shoppingCartID?: string;
+  // The unique identifier of the brand that the checkin was created on
   brandID: string;
+  // The unique identifier of the user that created the checkin
   userID: string;
 }
 
-// POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
+export interface CheckInPaymentRequiredDTO {
+  // The unique identifier for this checkin
+  id: string;
+}
 
-export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEvent;
+export interface FailedCheckInDTO {
+  // The unique identifier for this checkin
+  id: string;
+  // The unique identifier of the user that created the checkin
+  shopperID: string;
+  // The unique identifier of the brand that the checkin was created on
+  brandID: string;
+  // The reason why the checkin failed
+  reason: string;
+}
 
-export type PostFrictionlessWebhookStandardcognitionResponse = {};
+export interface AmazonJWOAuthEventDTO {
+  // Value that uniquely identifies each authorization event that occurs when a shopper interacts with a JWO gate
+  id: string;
+  // Contains the timestamp when the authorization event took place
+  timestamp: string;
+  // Contains an enumerated string that tells the system where the authorization event took place. Current values are ENTRY for the JWO Entry Gate and EXIT for the Exit Gate
+  location: "ENTRY" | "EXIT";
+}
 
-export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
-  body: PostFrictionlessWebhookStandardcognitionBody;
+export interface AmazonJWOIdentityKeysRequestDTO {
+  authEvent: AmazonJWOAuthEventDTO;
+  // The Payload of the QR Code generated for the shopper to scan. Amazon calls this "Identity Key"
+  identityKey: string;
+  // The unique identifier for this request.
+  requestId: string;
+  // The unique identifier for the store that the shopper is interacting with on Amazon System
+  storeId: string;
 }
 
-// POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
+export interface VisitorDetailsDTO {
+  // The unique identifier for this visitor on AWS System. Coincides with our Checkin ID
+  id: string;
+  type: "SHOPPER" | "ASSOCIATE" | "CASH_SHOPPER";
+}
 
-export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
-  AmazonJWOIdentityKeysRequestDTO;
+export interface AmazonJWOIdentityKeysResponseDTO {
+  visitorDetails: VisitorDetailsDTO;
+}
 
-export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
-  AmazonJWOIdentityKeysResponseDTO;
+export interface BadRequestErrorDTO {
+  message: string;
+  code: number;
+  data: Record<string, any>;
+}
 
-export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
-  extends BaseRequest {
-  body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
+export interface ShoppingTrip {
+  // Contains a timestamp for the time the shopping trip starts. This value is not validated on our service.
+  startTime: string;
+  // Contains a timestamp for the time the shopping trip ends. This value is not validated on our service.
+  endTime: string;
+  authEvents: AmazonJWOAuthEventDTO[];
 }
 
-// POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
+export interface QuantityDTO {
+  // Contains the number of each item the shopper purchased
+  value: string;
+  // Contains the type of unique identifier your store uses to identify each item in the cart
+  unit: "unit" | "each";
+}
 
-export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
+export interface CartItemDTO {
+  // Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
+  id: string;
+  // Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
+  type: "SKU";
+  quantity: QuantityDTO;
+}
 
-export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
-  AmazonJWOOrderingResponseDTO;
+export interface ShopperIdentity {
+  // Contains a unique identifier for each	shopper AWS sends back. Refers to our CheckIn ID.
+  id: string;
+}
 
-export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
-  body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
+export interface AmazonJWOOrderingRequestDTO {
+  // Contains a UUID for each checkout request. Amazon generates this UUID for	each request. If Amazon has to send the same request more than once, the requestId will be different for each request. Compare the requestId to the idempotentShoppingTripId field, which	remains the same throughout the shopping trip.
+  requestId: string;
+  // Contains a Universally Unique ID (UUID) for the current	shopping trip. Amazon generates this UUID for each shopping trip
+  idempotentShoppingTripId: string;
+  // The storeId field contains a unique identifier for your store on AWS system
+  storeId: string;
+  shoppingTrip: ShoppingTrip;
+  cartItems: CartItemDTO[];
+  shopperIdentity: ShopperIdentity;
+}
+
+export interface AmazonJWOOrderingResponseDTO {
+  purchaseId: string;
+}
+
+export interface StandardCognitionEventDTO {
+  // Value that uniquely identifies each event that occurs in Standard Cognition's system
+  event_id: string;
+  // Contains an enumerated string that tells the system what type of event took place. Current values are external-customer-order-created for when a new order is created and external-customer-order-state-changed for when an order changes state
+  event_type: "external-customer-order-created" | "external-customer-order-state-changed";
+  // Value that uniquely identifies each customer in Standard Cognition's system. Coincides with our Checkin ID
+  external_customer_id: string;
+  // Value that uniquely identifies each store in Standard Cognition's system
+  tenant_id: string;
+  // Value that uniquely identifies each order in Standard Cognition's system
+  order_id: string;
 }
 
 // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
@@ -234,7 +242,7 @@ export interface GetFrictionlessBrandFrictionlessStatusQuery {
   _query?: string;
 }
 
-export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponse;
+export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponseDTO;
 
 export interface GetFrictionlessBrandFrictionlessStatusRequest
   extends BaseRequest,
@@ -243,56 +251,49 @@ export interface GetFrictionlessBrandFrictionlessStatusRequest
 
 // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
 
-export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommand;
+export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommandDTO;
 
-export type PostFrictionlessQrCodeResponse = QRCodeCreationResponse;
+export type PostFrictionlessQrCodeResponse = QRCodeCreationResponseDTO;
 
 export interface PostFrictionlessQrCodeRequest extends BaseRequest {
   body: PostFrictionlessQrCodeBody;
 }
 
-// GET /frictionless/failed-checkins - List check-ins on error
+// GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
 
-export interface GetFrictionlessFailedCheckinsQuery {
-  // Graphql query string
-  _query?: string;
+export interface GetFrictionlessCheckinStatusPath {
+  id_checkin: string;
 }
 
-export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
-
-export interface GetFrictionlessFailedCheckinsRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
-
-// POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
-
-export interface PostFrictionlessCheckinsReprocessPath {
-  id_checkin: string;
+export interface GetFrictionlessCheckinStatusQuery {
+  // Graphql query string
+  _query?: string;
 }
 
-export type PostFrictionlessCheckinsReprocessResponse = {};
+export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
 
-export interface PostFrictionlessCheckinsReprocessRequest
+export interface GetFrictionlessCheckinStatusRequest
   extends BaseRequest,
-    PostFrictionlessCheckinsReprocessPath {}
+    RequestQuery<GetFrictionlessCheckinStatusQuery>,
+    GetFrictionlessCheckinStatusPath {}
 
-// GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
+// GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
 
-export interface GetFrictionlessCheckinStatusPath {
+export interface GetFrictionlessCheckinPath {
   id_checkin: string;
 }
 
-export interface GetFrictionlessCheckinStatusQuery {
+export interface GetFrictionlessCheckinQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
+export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
 
-export interface GetFrictionlessCheckinStatusRequest
+export interface GetFrictionlessCheckinRequest
   extends BaseRequest,
-    RequestQuery<GetFrictionlessCheckinStatusQuery>,
-    GetFrictionlessCheckinStatusPath {}
+    RequestQuery<GetFrictionlessCheckinQuery>,
+    GetFrictionlessCheckinPath {}
 
 // GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
 
@@ -312,6 +313,31 @@ export interface GetFrictionlessUsersPaymentIssuesRequest
     RequestQuery<GetFrictionlessUsersPaymentIssuesQuery>,
     GetFrictionlessUsersPaymentIssuesPath {}
 
+// GET /frictionless/failed-checkins - List check-ins on error
+
+export interface GetFrictionlessFailedCheckinsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
+
+export interface GetFrictionlessFailedCheckinsRequest
+  extends BaseRequest,
+    RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
+
+// POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
+
+export interface PostFrictionlessCheckinsReprocessPath {
+  id_checkin: string;
+}
+
+export type PostFrictionlessCheckinsReprocessResponse = {};
+
+export interface PostFrictionlessCheckinsReprocessRequest
+  extends BaseRequest,
+    PostFrictionlessCheckinsReprocessPath {}
+
 // POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
 
 export interface PostFrictionlessCheckinReprocessPaymentPath {
@@ -328,20 +354,36 @@ export interface PostFrictionlessCheckinReprocessPaymentRequest
   body: PostFrictionlessCheckinReprocessPaymentBody;
 }
 
-// GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
+// POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
 
-export interface GetFrictionlessCheckinPath {
-  id_checkin: string;
+export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
+  AmazonJWOIdentityKeysRequestDTO;
+
+export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
+  AmazonJWOIdentityKeysResponseDTO;
+
+export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
+  extends BaseRequest {
+  body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
 }
 
-export interface GetFrictionlessCheckinQuery {
-  // Graphql query string
-  _query?: string;
+// POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
+
+export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
+
+export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
+  AmazonJWOOrderingResponseDTO;
+
+export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
+  body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
 }
 
-export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
+// POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
 
-export interface GetFrictionlessCheckinRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessCheckinQuery>,
-    GetFrictionlessCheckinPath {}
+export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEventDTO;
+
+export type PostFrictionlessWebhookStandardcognitionResponse = {};
+
+export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
+  body: PostFrictionlessWebhookStandardcognitionBody;
+}

package/src/interface/location.ts

@@ -85,7 +85,9 @@ export interface Brand {
   };
   timezone?: string;
   description?: string;
+  //@deprecated
   latitude?: number;
+  //@deprecated
   longitude?: number;
   address?: Address;
   menus?: MenuHours[];
@@ -95,10 +97,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;
@@ -141,12 +143,13 @@ export interface Brand {
   group?: string;
   // payment
   payment_provider?: string;
+  //@deprecated
   location_description?: string;
   // company
   company?: string;
   config?: {
-    private?: any;
-    public?: any;
+    private?: Record<string, any>;
+    public?: Record<string, any>;
   };
   tax_rate?: number;
   meta?: {
@@ -254,8 +257,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;
@@ -280,7 +283,7 @@ export interface Group {
   meta?: {
     [index: string]: any;
   };
-  style?: any;
+  style?: Record<string, any>;
   timezone?: string;
   [index: string]: any;
 }
@@ -300,7 +303,7 @@ export interface success {
 export interface Error {
   error?: string;
   code?: number;
-  data?: any;
+  data?: Record<string, any>;
 }
 
 export interface Sector {
@@ -341,6 +344,7 @@ export interface Locations {
 }
 
 export interface Multigroups {
+  //@deprecated
   groups?: MultiGroup[];
   multigroups?: MultiGroup[];
 }
@@ -419,7 +423,7 @@ export interface BadRequest {
   error?: string;
 }
 
-export type PartnerStatus = string;
+export type PartnerStatus = "await_partner" | "await_scout" | "completed";
 
 export interface WaitTime {
   // maxium wait time to the next time slot in minutes
@@ -430,7 +434,7 @@ export interface WaitTime {
   ready_time: number;
 }
 
-export type BrandOrMenuState = string;
+export type BrandOrMenuState = "open" | "closed" | "preorder";
 
 export interface MenuAssociations {
   menu_associations?: MenuAssociation[];
@@ -490,9 +494,9 @@ export interface GetLocationsRequest extends BaseRequest, RequestQuery<GetLocati
 // GET /location/search - Gets Location within a radius of the provided point
 
 export interface GetLocationSearchQuery {
-  // The latitude to be used
+  //@deprecated
   lat?: number;
-  // The longitude to be used
+  //@deprecated
   long?: number;
   // Operation id to be used
   operation_id?: number;
@@ -517,7 +521,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
@@ -815,8 +819,6 @@ export interface GetLocationGroupWaittimesPath {
 }
 
 export interface GetLocationGroupWaittimesQuery {
-  // show additional hidden properties/entities
-  extended?: boolean;
   // Graphql query string
   _query?: string;
   nocache?: boolean;
@@ -1273,7 +1275,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

@@ -72,8 +72,6 @@ export interface AuthPayload {
 export interface PostMealplanPath {
   // Meal plan ID
   id: string;
-  // Tender ID
-  tender: string;
 }
 
 export interface PostMealplanBody {
@@ -97,8 +95,6 @@ export interface PostMealplanRequest extends BaseRequest, PostMealplanPath {
 export interface PutMealplanPath {
   // Meal plan ID
   id: string;
-  // Tender ID
-  tender: string;
 }
 
 export interface PutMealplanBody {
@@ -118,8 +114,6 @@ export interface PutMealplanRequest extends BaseRequest, PutMealplanPath {
 export interface GetMealplanPath {
   // Meal plan ID
   id: string;
-  // Tender ID
-  tender: string;
 }
 
 export interface GetMealplanQuery {
@@ -139,8 +133,6 @@ export interface GetMealplanRequest
 export interface DeleteMealplanPath {
   // Meal plan ID
   id: string;
-  // Tender ID
-  tender: string;
 }
 
 export interface DeleteMealplanBody {
@@ -174,7 +166,7 @@ export interface PostMealplanCallbackBody {
 
 export interface PostMealplanCallbackResponse {
   token?: string;
-  // DH 1.0 format for returning the token
+  //@deprecated
   cardNumber?: string;
 }