@compassdigital/sdk.typescript 4.67.0 → 4.68.0

package/src/interface/payment.ts

@@ -1,363 +1,363 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface Transaction {
-  success?: boolean;
-  // the total amount available for refund on the transaction - the transaction remainder amount
-  amount?: string;
-  requestDateTime?: string;
-  // cdl encoded transaction id
-  id?: string;
-  reasonCode?: number;
-  decision?: string;
-  status?: string;
-  creditCard?: CreditCard;
-  digital_wallet_pay?: DigitalWalletPay;
-  requestID?: string;
-  [index: string]: any;
+	success?: boolean;
+	// the total amount available for refund on the transaction - the transaction remainder amount
+	amount?: string;
+	requestDateTime?: string;
+	// cdl encoded transaction id
+	id?: string;
+	reasonCode?: number;
+	decision?: string;
+	status?: string;
+	creditCard?: CreditCard;
+	digital_wallet_pay?: DigitalWalletPay;
+	requestID?: string;
+	[index: string]: any;
 }
 
 export interface Refund {
-  success?: boolean;
-  // attempted amount for refund in current request
-  amount?: number;
-  // amount refunded in current request
-  refund_amount?: number;
-  // remaining amount available for refund
-  transaction_remainder_amount?: number;
-  decision?: string;
-  [index: string]: any;
+	success?: boolean;
+	// attempted amount for refund in current request
+	amount?: number;
+	// amount refunded in current request
+	refund_amount?: number;
+	// remaining amount available for refund
+	transaction_remainder_amount?: number;
+	decision?: string;
+	[index: string]: any;
 }
 
 export interface ClientToken {
-  // Client token (BrainTree)
-  clienttoken?: string;
-  // Client token (FreedomPay)
-  access_token?: string;
-  // Bearer token (FreedomPay)
-  token_type?: string;
-  // Token expiry (FreedomPay)
-  expires_in?: number;
+	// Client token (BrainTree)
+	clienttoken?: string;
+	// Client token (FreedomPay)
+	access_token?: string;
+	// Bearer token (FreedomPay)
+	token_type?: string;
+	// Token expiry (FreedomPay)
+	expires_in?: number;
 }
 
 export interface PaymentMethod {
-  type?: string;
-  card_type?: string;
-  expiration?: {
-    month?: number;
-    year?: number;
-    expired?: boolean;
-  };
-  last4?: string;
-  // payment
-  token?: string;
-  date?: {
-    created?: string;
-    modified?: string;
-    last_used?: number;
-  };
-  image?: string;
-  cardholder_name?: string;
-  postal_code?: string;
+	type?: string;
+	card_type?: string;
+	expiration?: {
+		month?: number;
+		year?: number;
+		expired?: boolean;
+	};
+	last4?: string;
+	// payment
+	token?: string;
+	date?: {
+		created?: string;
+		modified?: string;
+		last_used?: number;
+	};
+	image?: string;
+	cardholder_name?: string;
+	postal_code?: string;
 }
 
 export interface ConsumerSessionToken {
-  access_token?: string;
-  token_type?: string;
-  expires_in?: number;
+	access_token?: string;
+	token_type?: string;
+	expires_in?: number;
 }
 
 export interface ConsumerId {
-  consumerId?: string;
-  [index: string]: any;
+	consumerId?: string;
+	[index: string]: any;
 }
 
 export interface TokenInformation {
-  token?: string;
-  accountNumberMasked?: string;
-  cardExpirationMonth?: string;
-  cardExpirationYear?: string;
-  brand?: string;
-  posCardType?: string;
-  cardType?: string;
-  tokenExpiration?: string;
-  posData?: string;
-  newToken?: string;
-  sessionKey?: string;
-  [index: string]: any;
+	token?: string;
+	accountNumberMasked?: string;
+	cardExpirationMonth?: string;
+	cardExpirationYear?: string;
+	brand?: string;
+	posCardType?: string;
+	cardType?: string;
+	tokenExpiration?: string;
+	posData?: string;
+	newToken?: string;
+	sessionKey?: string;
+	[index: string]: any;
 }
 
 export interface UpdateTokenInformation {
-  nickname?: string;
-  isPreferred?: boolean;
-  expiryYear?: string;
-  expiryMonth?: string;
-  nameOnCard?: string;
-  token?: string;
-  tokenExpirationDate?: string;
-  billingAddress?: {
-    street1?: string;
-    street2?: string;
-    city?: string;
-    state?: string;
-    postalCode?: string;
-    country?: string;
-  };
+	nickname?: string;
+	isPreferred?: boolean;
+	expiryYear?: string;
+	expiryMonth?: string;
+	nameOnCard?: string;
+	token?: string;
+	tokenExpirationDate?: string;
+	billingAddress?: {
+		street1?: string;
+		street2?: string;
+		city?: string;
+		state?: string;
+		postalCode?: string;
+		country?: string;
+	};
 }
 
 export interface PaymentCard {
-  maskedCardNumber?: string;
-  cardType?: string;
-  nickname?: string;
-  isPreferred?: boolean;
-  expiryYear?: number;
-  expiryMonth?: number;
-  nameOnCard?: string;
-  token?: string;
-  tokenExpirationDate?: string;
-  billingAddress?: {
-    postalCode?: string;
-  };
-  [index: string]: any;
+	maskedCardNumber?: string;
+	cardType?: string;
+	nickname?: string;
+	isPreferred?: boolean;
+	expiryYear?: number;
+	expiryMonth?: number;
+	nameOnCard?: string;
+	token?: string;
+	tokenExpirationDate?: string;
+	billingAddress?: {
+		postalCode?: string;
+	};
+	[index: string]: any;
 }
 
 export interface Options {
-  submitForSettlement?: boolean;
-  exact_gateway_id?: string;
-  exact_gateway_password?: string;
-  invoice_number?: string;
-  // brand
-  brand?: string;
-  // location
-  location?: string;
-  // pickup_id
-  pickup_id?: string;
-  // user_id
-  user_id?: string;
-  payment_type?: "credit_card" | "badge_pay" | "stipend" | "voucher" | "coupon_voucher";
-  // ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
-  tender?: string;
-  digital_wallet_pay?: DigitalWalletPay;
+	submitForSettlement?: boolean;
+	exact_gateway_id?: string;
+	exact_gateway_password?: string;
+	invoice_number?: string;
+	// brand
+	brand?: string;
+	// location
+	location?: string;
+	// pickup_id
+	pickup_id?: string;
+	// user_id
+	user_id?: string;
+	payment_type?: 'credit_card' | 'badge_pay' | 'stipend' | 'voucher' | 'coupon_voucher';
+	// ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
+	tender?: string;
+	digital_wallet_pay?: DigitalWalletPay;
 }
 
 export interface Success {
-  success?: boolean;
+	success?: boolean;
 }
 
 export interface Error {
-  error?: string;
-  code?: number;
-  data?: Record<string, any>;
+	error?: string;
+	code?: number;
+	data?: Record<string, any>;
 }
 
 export interface CashlessTender {
-  balance?: number;
-  // ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
-  id?: string;
-  // name associated with badgepay tender, stored in site public config
-  name?: string;
-  // account type associated with badgepay tender, stored in site public config
-  type?: "badge_pay" | "stipend" | "voucher" | "coupon_voucher";
+	balance?: number;
+	// ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
+	id?: string;
+	// name associated with badgepay tender, stored in site public config
+	name?: string;
+	// account type associated with badgepay tender, stored in site public config
+	type?: 'badge_pay' | 'stipend' | 'voucher' | 'coupon_voucher';
 }
 
 export type BadgePayTender = CashlessTender;
 
 export interface DigitalWalletPay {
-  wallet_type?: string;
-  total?: number;
+	wallet_type?: string;
+	total?: number;
 }
 
 export interface CreditCard {
-  cardType?: string;
-  last4?: string;
+	cardType?: string;
+	last4?: string;
 }
 
 export interface PaymentCards {
-  data?: PaymentCard[];
-  recordsTotal?: number;
+	data?: PaymentCard[];
+	recordsTotal?: number;
 }
 
 export interface HpcIframe {
-  iframe?: string;
-  sessionKey?: string;
+	iframe?: string;
+	sessionKey?: string;
 }
 
 export interface ApplePayMerchantSession {
-  merchant_session?: {
-    epochTimestamp?: number;
-    expiresAt?: number;
-    nonce?: string;
-    merchantIdentifier?: string;
-    merchantSessionIdentifier?: string;
-    operationalAnalyticsIdentifier?: string;
-    domainName?: string;
-    displayName?: string;
-    signature?: string;
-    retries?: number;
-    pspId?: string;
-    [index: string]: any;
-  };
+	merchant_session?: {
+		epochTimestamp?: number;
+		expiresAt?: number;
+		nonce?: string;
+		merchantIdentifier?: string;
+		merchantSessionIdentifier?: string;
+		operationalAnalyticsIdentifier?: string;
+		domainName?: string;
+		displayName?: string;
+		signature?: string;
+		retries?: number;
+		pspId?: string;
+		[index: string]: any;
+	};
 }
 
 // POST /payment/{id}/transaction
 
 export interface PostPaymentTransactionPath {
-  // Payment ID
-  id: string;
+	// Payment ID
+	id: string;
 }
 
 export interface PostPaymentTransactionBody {
-  // The payment method token to use for the payment
-  payment_method_token?: string;
-  // The amount to charge to the payment method
-  amount: string;
-  options?: Options;
-  // The braintree merchant account id to use
-  merchant_account_id?: string;
-  digital_wallet_token?: string;
-  account_number?: string;
-  cv_number?: string;
-  expiration_month?: number;
-  expiration_year?: number;
-  cart_items?: {
-    id?: string;
-    label?: {
-      en?: string;
-    };
-    price?: {
-      amount?: number;
-    };
-    quantity?: number;
-  }[];
+	// The payment method token to use for the payment
+	payment_method_token?: string;
+	// The amount to charge to the payment method
+	amount: string;
+	options?: Options;
+	// The braintree merchant account id to use
+	merchant_account_id?: string;
+	digital_wallet_token?: string;
+	account_number?: string;
+	cv_number?: string;
+	expiration_month?: number;
+	expiration_year?: number;
+	cart_items?: {
+		id?: string;
+		label?: {
+			en?: string;
+		};
+		price?: {
+			amount?: number;
+		};
+		quantity?: number;
+	}[];
 }
 
 export type PostPaymentTransactionResponse = Transaction;
 
 export interface PostPaymentTransactionRequest extends BaseRequest, PostPaymentTransactionPath {
-  body: PostPaymentTransactionBody;
+	body: PostPaymentTransactionBody;
 }
 
 // POST /payment/{id}/transaction/{transaction_id}/refund
 
 export interface PostPaymentTransactionRefundPath {
-  // Payment ID
-  id: string;
-  // Transaction ID
-  transaction_id: string;
+	// Payment ID
+	id: string;
+	// Transaction ID
+	transaction_id: string;
 }
 
 export interface PostPaymentTransactionRefundBody {
-  // The amount to refund for the transaction
-  amount: string;
-  transaction: Transaction;
-  options: Options;
+	// The amount to refund for the transaction
+	amount: string;
+	transaction: Transaction;
+	options: Options;
 }
 
 export type PostPaymentTransactionRefundResponse = Refund;
 
 export interface PostPaymentTransactionRefundRequest
-  extends BaseRequest,
-    PostPaymentTransactionRefundPath {
-  body: PostPaymentTransactionRefundBody;
+	extends BaseRequest,
+		PostPaymentTransactionRefundPath {
+	body: PostPaymentTransactionRefundBody;
 }
 
 // GET /payment/{id}/clienttoken
 
 export interface GetPaymentClienttokenPath {
-  // Payment ID
-  id: string;
+	// Payment ID
+	id: string;
 }
 
 export interface GetPaymentClienttokenQuery {
-  // hCaptcha response key
-  captchaResponseKey: string;
-  // Graphql query string
-  _query?: string;
+	// hCaptcha response key
+	captchaResponseKey: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetPaymentClienttokenResponse = ClientToken;
 
 export interface GetPaymentClienttokenRequest
-  extends BaseRequest,
-    RequestQuery<GetPaymentClienttokenQuery>,
-    GetPaymentClienttokenPath {}
+	extends BaseRequest,
+		RequestQuery<GetPaymentClienttokenQuery>,
+		GetPaymentClienttokenPath {}
 
 // POST /payment/{id}/paymenttoken
 
 export interface PostPaymentPaymenttokenPath {
-  // Payment ID
-  id: string;
+	// Payment ID
+	id: string;
 }
 
 export interface PostPaymentPaymenttokenBody {
-  // The credit card number (Exact)
-  cc_number: string;
-  // The credit card expiry (Exact)
-  cc_expiry: string;
-  // The credit card CVV (Exact)
-  cc_verification_str2: string;
-  // The credit card holder's name (Exact)
-  cardholder_name: string;
-  // A reference identifier for the transaction
-  reference_no?: string;
-  options?: Options;
-  // postal or zip code
-  postal_code?: string;
-  // flag to determine if the card should be saved or used once
-  use_card_once?: boolean;
+	// The credit card number (Exact)
+	cc_number: string;
+	// The credit card expiry (Exact)
+	cc_expiry: string;
+	// The credit card CVV (Exact)
+	cc_verification_str2: string;
+	// The credit card holder's name (Exact)
+	cardholder_name: string;
+	// A reference identifier for the transaction
+	reference_no?: string;
+	options?: Options;
+	// postal or zip code
+	postal_code?: string;
+	// flag to determine if the card should be saved or used once
+	use_card_once?: boolean;
 }
 
 export type PostPaymentPaymenttokenResponse = PaymentMethod;
 
 export interface PostPaymentPaymenttokenRequest extends BaseRequest, PostPaymentPaymenttokenPath {
-  body: PostPaymentPaymenttokenBody;
+	body: PostPaymentPaymenttokenBody;
 }
 
 // POST /payment/consumer
 
 export interface PostPaymentConsumerBody {
-  // The user id
-  user_id: string;
+	// The user id
+	user_id: string;
 }
 
 export type PostPaymentConsumerResponse = ConsumerId;
 
 export interface PostPaymentConsumerRequest extends BaseRequest {
-  body: PostPaymentConsumerBody;
+	body: PostPaymentConsumerBody;
 }
 
 // POST /payment/method
 
 export interface PostPaymentMethodBody {
-  // The user id
-  user_id: string;
-  // The payment nonce provided for the payment method
-  payment_method_nonce: string;
+	// The user id
+	user_id: string;
+	// The payment nonce provided for the payment method
+	payment_method_nonce: string;
 }
 
 export interface PostPaymentMethodResponse {
-  payment_method?: PaymentMethod;
+	payment_method?: PaymentMethod;
 }
 
 export interface PostPaymentMethodRequest extends BaseRequest {
-  body: PostPaymentMethodBody;
+	body: PostPaymentMethodBody;
 }
 
 // GET /payment/token
 
 export interface GetPaymentTokenQuery {
-  // Payment Key
-  paymentKey: string;
-  // Session key
-  sessionKey: string;
-  // CDL Site Id
-  siteId: string;
-  // name on card
-  nameOnCard: string;
-  // Graphql query string
-  _query?: string;
+	// Payment Key
+	paymentKey: string;
+	// Session key
+	sessionKey: string;
+	// CDL Site Id
+	siteId: string;
+	// name on card
+	nameOnCard: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetPaymentTokenResponse = TokenInformation;
@@ -367,72 +367,72 @@ export interface GetPaymentTokenRequest extends BaseRequest, RequestQuery<GetPay
 // POST /payment/token
 
 export interface PostPaymentTokenBody {
-  tokenInfo: TokenInformation;
-  // Name on credit card
-  nameOnCard: string;
-  // CDL Site Id
-  siteId: string;
+	tokenInfo: TokenInformation;
+	// Name on credit card
+	nameOnCard: string;
+	// CDL Site Id
+	siteId: string;
 }
 
 export type PostPaymentTokenResponse = PaymentCard;
 
 export interface PostPaymentTokenRequest extends BaseRequest {
-  body: PostPaymentTokenBody;
+	body: PostPaymentTokenBody;
 }
 
 // PUT /payment/token
 
 export interface PutPaymentTokenBody {
-  updatedTokenInfo: UpdateTokenInformation;
-  // CDL Site Id
-  siteId: string;
+	updatedTokenInfo: UpdateTokenInformation;
+	// CDL Site Id
+	siteId: string;
 }
 
 export type PutPaymentTokenResponse = PaymentCard;
 
 export interface PutPaymentTokenRequest extends BaseRequest {
-  body: PutPaymentTokenBody;
+	body: PutPaymentTokenBody;
 }
 
 // DELETE /payment/token
 
 export interface DeletePaymentTokenBody {
-  // Token string to be deleted
-  token: string;
-  // CDL Site Id
-  siteId: string;
+	// Token string to be deleted
+	token: string;
+	// CDL Site Id
+	siteId: string;
 }
 
 export type DeletePaymentTokenResponse = Success;
 
 export interface DeletePaymentTokenRequest extends BaseRequest {
-  body: DeletePaymentTokenBody;
+	body: DeletePaymentTokenBody;
 }
 
 // GET /payment/methods
 
 export interface GetPaymentMethodsQuery {
-  // CDL Site Id
-  siteId: string;
-  // Graphql query string
-  _query?: string;
+	// CDL Site Id
+	siteId: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetPaymentMethodsResponse = PaymentCards;
 
 export interface GetPaymentMethodsRequest
-  extends BaseRequest,
-    RequestQuery<GetPaymentMethodsQuery> {}
+	extends BaseRequest,
+		RequestQuery<GetPaymentMethodsQuery> {}
 
 // GET /payment/hpc
 
 export interface GetPaymentHpcQuery {
-  // CDL Site Id
-  siteId: string;
-  // hCaptcha response key
-  captchaResponseKey: string;
-  // Graphql query string
-  _query?: string;
+	// CDL Site Id
+	siteId: string;
+	// hCaptcha response key
+	captchaResponseKey: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetPaymentHpcResponse = HpcIframe;
@@ -442,86 +442,86 @@ export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPayme
 // GET /payment/{id}/cashless
 
 export interface GetPaymentCashlessPath {
-  // Payment ID
-  id: string;
+	// Payment ID
+	id: string;
 }
 
 export interface GetPaymentCashlessQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export interface GetPaymentCashlessResponse {
-  tenders?: CashlessTender[];
+	tenders?: CashlessTender[];
 }
 
 export interface GetPaymentCashlessRequest
-  extends BaseRequest,
-    RequestQuery<GetPaymentCashlessQuery>,
-    GetPaymentCashlessPath {}
+	extends BaseRequest,
+		RequestQuery<GetPaymentCashlessQuery>,
+		GetPaymentCashlessPath {}
 
 // POST /payment/{id}/cashless
 
 export interface PostPaymentCashlessPath {
-  // Payment ID
-  id: string;
+	// Payment ID
+	id: string;
 }
 
 export interface PostPaymentCashlessBody {
-  // The reference ID returned from FP account confirmation
-  token: string;
+	// The reference ID returned from FP account confirmation
+	token: string;
 }
 
 export interface PostPaymentCashlessResponse {
-  tenders?: CashlessTender[];
+	tenders?: CashlessTender[];
 }
 
 export interface PostPaymentCashlessRequest extends BaseRequest, PostPaymentCashlessPath {
-  body: PostPaymentCashlessBody;
+	body: PostPaymentCashlessBody;
 }
 
 // DELETE /payment/{id}/cashless
 
 export interface DeletePaymentCashlessPath {
-  // Payment ID
-  id: string;
+	// Payment ID
+	id: string;
 }
 
 export interface DeletePaymentCashlessBody {
-  // An optional array of tenders to delete
-  tenders?: string[];
+	// An optional array of tenders to delete
+	tenders?: string[];
 }
 
 export interface DeletePaymentCashlessResponse {
-  tenders?: CashlessTender[];
+	tenders?: CashlessTender[];
 }
 
 export interface DeletePaymentCashlessRequest extends BaseRequest, DeletePaymentCashlessPath {
-  body: DeletePaymentCashlessBody;
+	body: DeletePaymentCashlessBody;
 }
 
 // POST /payment/configvalidate
 
 export interface PostPaymentConfigvalidateBody {
-  store_id: string;
-  terminal_id: string;
+	store_id: string;
+	terminal_id: string;
 }
 
 export type PostPaymentConfigvalidateResponse = Success;
 
 export interface PostPaymentConfigvalidateRequest extends BaseRequest {
-  body: PostPaymentConfigvalidateBody;
+	body: PostPaymentConfigvalidateBody;
 }
 
 // POST /payment/validatemerchant
 
 export interface PostPaymentValidatemerchantBody {
-  validation_url: string;
-  display_name: string;
+	validation_url: string;
+	display_name: string;
 }
 
 export type PostPaymentValidatemerchantResponse = ApplePayMerchantSession;
 
 export interface PostPaymentValidatemerchantRequest extends BaseRequest {
-  body: PostPaymentValidatemerchantBody;
+	body: PostPaymentValidatemerchantBody;
 }