@compassdigital/sdk.typescript 4.67.0 → 4.69.0

package/src/interface/frictionless.ts

@@ -1,240 +1,240 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface FrictionlessSupportResponseDTO {
-  // Whether the brand supports frictionless checkins
-  supported: boolean;
-  // The version of the frictionless support
-  version?: "NFC" | "QR";
+	// Whether the brand supports frictionless checkins
+	supported: boolean;
+	// The version of the frictionless support
+	version?: 'NFC' | 'QR';
 }
 
 export interface UnauthorizedErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 export interface ForbiddenErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 export interface NotFoundErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 export interface MealplanDTO {
-  // The unique identifier of the mealplan tender
-  tenderID: string;
-  // The name of the mealplan
-  name: string;
+	// 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;
+	// 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;
+	mealplan?: MealplanDTO;
+	creditCard?: CreditCardDTO;
+	// Token used for identify the payment method
+	token: string;
 }
 
 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;
+	// 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 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;
+	// 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;
 }
 
 export interface DisplayMessageDTO {
-  title: string;
-  description: string;
+	title: string;
+	description: string;
 }
 
 export interface ErrorDataDTO {
-  description: string;
-  timestamp: string;
-  statusCode: number;
-  displayMessage: DisplayMessageDTO;
+	description: string;
+	timestamp: string;
+	statusCode: number;
+	displayMessage: DisplayMessageDTO;
 }
 
 export interface UnprocessableEntityErrorDTO {
-  code: number;
-  message: string;
-  data: ErrorDataDTO;
+	code: number;
+	message: string;
+	data: ErrorDataDTO;
 }
 
 export interface GetCheckInStatusResponseDTO {
-  // The status of the checkin
-  status:
-    | "CREATING"
-    | "ACTIVE"
-    | "ERROR"
-    | "CANCELED"
-    | "PROCESSING"
-    | "UPDATE_PAYMENT_REQUIRED"
-    | "COMPLETED";
+	// The status of the checkin
+	status:
+		| 'CREATING'
+		| 'ACTIVE'
+		| 'ERROR'
+		| 'CANCELED'
+		| 'PROCESSING'
+		| 'UPDATE_PAYMENT_REQUIRED'
+		| 'COMPLETED';
 }
 
 export interface GetCheckinResponseDTO {
-  // The unique identifier for this checkin
-  id: 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;
+	// The unique identifier for this checkin
+	id: 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;
 }
 
 export interface CheckInPaymentRequiredDTO {
-  // The unique identifier for this checkin
-  id: string;
+	// The unique identifier for this checkin
+	id: string;
 }
 
 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;
+	// 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 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";
+	// 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;
-  // 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;
+	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;
 }
 
 export interface VisitorDetailsDTO {
-  // The unique identifier for this visitor on AWS System. Coincides with our Checkin ID
-  id: string;
-  type: "SHOPPER" | "ASSOCIATE" | "CASH_SHOPPER";
+	// The unique identifier for this visitor on AWS System. Coincides with our Checkin ID
+	id: string;
+	type: 'SHOPPER' | 'ASSOCIATE' | 'CASH_SHOPPER';
 }
 
 export interface AmazonJWOIdentityKeysResponseDTO {
-  visitorDetails: VisitorDetailsDTO;
+	visitorDetails: VisitorDetailsDTO;
 }
 
 export interface BadRequestErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	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[];
+	// 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 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";
+	// 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 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;
+	// 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 interface ShopperIdentity {
-  // Contains a unique identifier for each	shopper AWS sends back. Refers to our CheckIn ID.
-  id: string;
+	// 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: CartItemDTO[];
-  shopperIdentity: ShopperIdentity;
+	// 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;
+	purchaseId: string;
 }
 
 // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
 
 export interface GetFrictionlessBrandFrictionlessStatusPath {
-  // Brand ID as Encoded CDL ID
-  id_brand: string;
+	// Brand ID as Encoded CDL ID
+	id_brand: string;
 }
 
 export interface GetFrictionlessBrandFrictionlessStatusQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponseDTO;
 
 export interface GetFrictionlessBrandFrictionlessStatusRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessBrandFrictionlessStatusQuery>,
-    GetFrictionlessBrandFrictionlessStatusPath {}
+	extends BaseRequest,
+		RequestQuery<GetFrictionlessBrandFrictionlessStatusQuery>,
+		GetFrictionlessBrandFrictionlessStatusPath {}
 
 // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
 
@@ -243,92 +243,92 @@ export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommandDTO;
 export type PostFrictionlessQrCodeResponse = QRCodeCreationResponseDTO;
 
 export interface PostFrictionlessQrCodeRequest extends BaseRequest {
-  body: PostFrictionlessQrCodeBody;
+	body: PostFrictionlessQrCodeBody;
 }
 
 // GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
 
 export interface GetFrictionlessCheckinStatusPath {
-  id_checkin: string;
+	id_checkin: string;
 }
 
 export interface GetFrictionlessCheckinStatusQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
 
 export interface GetFrictionlessCheckinStatusRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessCheckinStatusQuery>,
-    GetFrictionlessCheckinStatusPath {}
+	extends BaseRequest,
+		RequestQuery<GetFrictionlessCheckinStatusQuery>,
+		GetFrictionlessCheckinStatusPath {}
 
 // GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
 
 export interface GetFrictionlessCheckinPath {
-  id_checkin: string;
+	id_checkin: string;
 }
 
 export interface GetFrictionlessCheckinQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
 
 export interface GetFrictionlessCheckinRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessCheckinQuery>,
-    GetFrictionlessCheckinPath {}
+	extends BaseRequest,
+		RequestQuery<GetFrictionlessCheckinQuery>,
+		GetFrictionlessCheckinPath {}
 
 // GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
 
 export interface GetFrictionlessUsersPaymentIssuesPath {
-  user_id: string;
+	user_id: string;
 }
 
 export interface GetFrictionlessUsersPaymentIssuesQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetFrictionlessUsersPaymentIssuesResponse = CheckInPaymentRequiredDTO[];
 
 export interface GetFrictionlessUsersPaymentIssuesRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessUsersPaymentIssuesQuery>,
-    GetFrictionlessUsersPaymentIssuesPath {}
+	extends BaseRequest,
+		RequestQuery<GetFrictionlessUsersPaymentIssuesQuery>,
+		GetFrictionlessUsersPaymentIssuesPath {}
 
 // GET /frictionless/failed-checkins - List check-ins on error
 
 export interface GetFrictionlessFailedCheckinsQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
 
 export interface GetFrictionlessFailedCheckinsRequest
-  extends BaseRequest,
-    RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
+	extends BaseRequest,
+		RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
 
 // POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
 
 export interface PostFrictionlessCheckinsReprocessPath {
-  id_checkin: string;
+	id_checkin: string;
 }
 
 export type PostFrictionlessCheckinsReprocessResponse = {};
 
 export interface PostFrictionlessCheckinsReprocessRequest
-  extends BaseRequest,
-    PostFrictionlessCheckinsReprocessPath {}
+	extends BaseRequest,
+		PostFrictionlessCheckinsReprocessPath {}
 
 // POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
 
 export interface PostFrictionlessCheckinReprocessPaymentPath {
-  checkin_id: string;
+	checkin_id: string;
 }
 
 export type PostFrictionlessCheckinReprocessPaymentBody = PaymentMethodDTO;
@@ -336,22 +336,22 @@ export type PostFrictionlessCheckinReprocessPaymentBody = PaymentMethodDTO;
 export type PostFrictionlessCheckinReprocessPaymentResponse = {};
 
 export interface PostFrictionlessCheckinReprocessPaymentRequest
-  extends BaseRequest,
-    PostFrictionlessCheckinReprocessPaymentPath {
-  body: PostFrictionlessCheckinReprocessPaymentBody;
+	extends BaseRequest,
+		PostFrictionlessCheckinReprocessPaymentPath {
+	body: PostFrictionlessCheckinReprocessPaymentBody;
 }
 
 // POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
 
 export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
-  AmazonJWOIdentityKeysRequestDTO;
+	AmazonJWOIdentityKeysRequestDTO;
 
 export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
-  AmazonJWOIdentityKeysResponseDTO;
+	AmazonJWOIdentityKeysResponseDTO;
 
 export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
-  extends BaseRequest {
-  body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
+	extends BaseRequest {
+	body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
 }
 
 // POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
@@ -359,8 +359,8 @@ export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
 export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
 
 export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
-  AmazonJWOOrderingResponseDTO;
+	AmazonJWOOrderingResponseDTO;
 
 export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
-  body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
+	body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
 }