@compassdigital/sdk.typescript 4.66.0 → 4.68.0

package/src/interface/tax.ts

@@ -1,105 +1,105 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface TaxLocationData {
-  // unique location identifier
-  id: string;
-  // country of transaction
-  country: string;
-  // state or province of transaction
-  stateOrProvince: string;
-  // city of transaction
-  city: string;
-  // postal code of transaction
-  postalCode: string;
-  // street address of transaction
-  streetAddress: string;
+	// unique location identifier
+	id: string;
+	// country of transaction
+	country: string;
+	// state or province of transaction
+	stateOrProvince: string;
+	// city of transaction
+	city: string;
+	// postal code of transaction
+	postalCode: string;
+	// street address of transaction
+	streetAddress: string;
 }
 
 export interface TaxItemDTO {
-  // unique item identifier
-  id: string;
-  // indicates a tax rule for an item
-  taxTagCode: string;
-  // amount of an item
-  quantity: number;
-  // decimal price of an item
-  price: number;
-  // amount of tax charged on an item after funds are captured
-  taxedAmount?: number;
+	// unique item identifier
+	id: string;
+	// indicates a tax rule for an item
+	taxTagCode: string;
+	// amount of an item
+	quantity: number;
+	// decimal price of an item
+	price: number;
+	// amount of tax charged on an item after funds are captured
+	taxedAmount?: number;
 }
 
 export interface TaxRefund {
-  // unique identifier of the refunded item
-  refundItemId: string;
-  // quantity amount of the item to be refunded
-  refundItemQuantity: number;
+	// unique identifier of the refunded item
+	refundItemId: string;
+	// quantity amount of the item to be refunded
+	refundItemQuantity: number;
 }
 
 export interface TaxRequestDTO {
-  // a unique identifier representing the transaction
-  id: string;
-  // the app to associate the transaction with
-  appName: string;
-  // the order fulfillment type
-  transactionType: "pickup" | "delivery";
-  // numeric value of service fee
-  serviceFee?: number;
-  // numeric value of delivery fee
-  deliveryFee?: number;
-  locationData: TaxLocationData;
-  // items to calculate tax on
-  items: TaxItemDTO[];
-  // iso timstamp of transaction date
-  transactionDate?: string;
-  // an array of items to refund
-  refunds?: TaxRefund[];
+	// a unique identifier representing the transaction
+	id: string;
+	// the app to associate the transaction with
+	appName: string;
+	// the order fulfillment type
+	transactionType: 'pickup' | 'delivery';
+	// numeric value of service fee
+	serviceFee?: number;
+	// numeric value of delivery fee
+	deliveryFee?: number;
+	locationData: TaxLocationData;
+	// items to calculate tax on
+	items: TaxItemDTO[];
+	// iso timstamp of transaction date
+	transactionDate?: string;
+	// an array of items to refund
+	refunds?: TaxRefund[];
 }
 
 export interface TaxBreakdownDTO {
-  // amount of the total that is taxable (not tax exempt)
-  taxable_amount: number;
-  // canadian value: goods and services tax
-  gst?: number;
-  // canadian value: provincial sales tax
-  pst?: number;
-  // canadian value: quebec sales tax
-  qst?: number;
+	// amount of the total that is taxable (not tax exempt)
+	taxable_amount: number;
+	// canadian value: goods and services tax
+	gst?: number;
+	// canadian value: provincial sales tax
+	pst?: number;
+	// canadian value: quebec sales tax
+	qst?: number;
 }
 
 export interface TaxResponseDTO {
-  // the total tax calculated on a transaction
-  amount: number;
-  // the total tax rate applied to the items to determine the total tax of the transaction
-  rate: number;
-  breakdown: TaxBreakdownDTO;
+	// the total tax calculated on a transaction
+	amount: number;
+	// the total tax rate applied to the items to determine the total tax of the transaction
+	rate: number;
+	breakdown: TaxBreakdownDTO;
 }
 
 export interface BadRequestErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 export interface UnauthorizedErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 export interface ServiceUnavailableErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 // GET /tax/v1/health-check - Health Check
 
 export interface TaxHealthCheckQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type TaxHealthCheckResponse = {};
@@ -113,5 +113,5 @@ export type PostQuoteTaxBody = TaxRequestDTO;
 export type PostQuoteTaxResponse = TaxResponseDTO;
 
 export interface PostQuoteTaxRequest extends BaseRequest {
-  body: PostQuoteTaxBody;
+	body: PostQuoteTaxBody;
 }