@compassdigital/sdk.typescript 4.29.0 → 4.32.0

package/src/interface/payment.ts

@@ -204,7 +204,7 @@ export interface ApplePayMerchantSession {
 // POST /payment/{id}/transaction
 
 export interface PostPaymentTransactionPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -242,9 +242,9 @@ export interface PostPaymentTransactionRequest extends BaseRequest, PostPaymentT
 // POST /payment/{id}/transaction/{transaction_id}/refund
 
 export interface PostPaymentTransactionRefundPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
-  // TODO: add parameter to swagger.json
+  // Transaction ID
   transaction_id: string;
 }
 
@@ -266,7 +266,7 @@ export interface PostPaymentTransactionRefundRequest
 // GET /payment/{id}/clienttoken
 
 export interface GetPaymentClienttokenPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -287,7 +287,7 @@ export interface GetPaymentClienttokenRequest
 // POST /payment/{id}/paymenttoken
 
 export interface PostPaymentPaymenttokenPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -345,26 +345,6 @@ export interface PostPaymentMethodRequest extends BaseRequest {
   body: PostPaymentMethodBody;
 }
 
-// DELETE /payment/{id}/method/{method_id}
-
-export interface DeletePaymentMethodPath {
-  // TODO: add parameter to swagger.json
-  id: string;
-  // TODO: add parameter to swagger.json
-  method_id: string;
-}
-
-export interface DeletePaymentMethodBody {
-  // The user from where the payment method will be deleted
-  user: string;
-}
-
-export type DeletePaymentMethodResponse = Success;
-
-export interface DeletePaymentMethodRequest extends BaseRequest, DeletePaymentMethodPath {
-  body: DeletePaymentMethodBody;
-}
-
 // GET /payment/token
 
 export interface GetPaymentTokenQuery {
@@ -462,7 +442,7 @@ export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPayme
 // GET /payment/{id}/cashless
 
 export interface GetPaymentCashlessPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -483,7 +463,7 @@ export interface GetPaymentCashlessRequest
 // POST /payment/{id}/cashless
 
 export interface PostPaymentCashlessPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -503,7 +483,7 @@ export interface PostPaymentCashlessRequest extends BaseRequest, PostPaymentCash
 // DELETE /payment/{id}/cashless
 
 export interface DeletePaymentCashlessPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 

package/src/interface/promo.ts

@@ -427,7 +427,6 @@ export interface PostPromoVoucherRequest extends BaseRequest {
 // PUT /promo/voucher/{id} - Update voucher
 
 export interface PutPromoVoucherPath {
-  // TODO: add parameter to swagger.json
   id: string;
 }
 
@@ -442,7 +441,6 @@ export interface PutPromoVoucherRequest extends BaseRequest, PutPromoVoucherPath
 // DELETE /promo/voucher/{id} - Delete voucher
 
 export interface DeletePromoVoucherPath {
-  // TODO: add parameter to swagger.json
   id: string;
 }
 
@@ -460,7 +458,7 @@ export interface DeletePromoVoucherRequest
     RequestQuery<DeletePromoVoucherQuery>,
     DeletePromoVoucherPath {}
 
-// POST /promo/customer/ - Add user to voucherify
+// POST /promo/customer - Add user to voucherify
 
 export type PostPromoCustomerBody = VoucherifyCustomer;
 
@@ -470,7 +468,7 @@ export interface PostPromoCustomerRequest extends BaseRequest {
   body: PostPromoCustomerBody;
 }
 
-// DELETE /promo/customer/ - Delete user from voucherify
+// DELETE /promo/customer - Delete user from voucherify
 
 export interface DeletePromoCustomerBody {
   user_id?: string;

package/src/interface/shoppingcart.ts

@@ -430,7 +430,7 @@ export interface FPValidationData {
 
 export type AmountOffExclusion = "discount" | "promo";
 
-// POST /shoppingcart/ - Create a new ShoppingCart
+// POST /shoppingcart - Create a new ShoppingCart
 
 export type PostShoppingcartCartBody = ShoppingCartRequest;
 
@@ -534,7 +534,7 @@ export interface DeleteShoppingcartCartPromoRequest
   extends BaseRequest,
     DeleteShoppingcartCartPromoPath {}
 
-// PUT /shoppingcart/{id}/paymentmethod/ - Change payment method used in shopping cart
+// PUT /shoppingcart/{id}/paymentmethod - Change payment method used in shopping cart
 
 export interface PutShoppingcartCartPaymentPath {
   // Shopping cart ID
@@ -570,7 +570,7 @@ export interface GetShoppingcartPaymentMethodsRequest
     RequestQuery<GetShoppingcartPaymentMethodsQuery>,
     GetShoppingcartPaymentMethodsPath {}
 
-// PUT /shoppingcart/{id}/order/ - Store information about the order created with this shopping cart
+// PUT /shoppingcart/{id}/order - Store information about the order created with this shopping cart
 
 export interface PutShoppingcartCartOrderPath {
   // Shopping cart ID

package/src/interface/tax.ts

@@ -0,0 +1,113 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from "./util";
+
+export interface LocationData {
+  // 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 ItemDTO {
+  // unique item identifier
+  id: string;
+  // indicates a tax rule for an item
+  taxTag: 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 Refund {
+  // unique identifier of the refunded item
+  refundItemId: string;
+  // quantity amount of the item to be refunded
+  refundItemQuantity: number;
+}
+
+export interface TaxRequestDTO {
+  // the unique location code
+  id: string;
+  // the order fulfillment type
+  transactionType: "pickup" | "delivery";
+  // numeric value of service fee
+  serviceFee?: number;
+  // numeric value of delivery fee
+  deliveryFee?: number;
+  locationData: LocationData;
+  // items to calculate tax on
+  items: ItemDTO[];
+  // iso timstamp of transaction date
+  transactionDate: string;
+  // an array of items to refund
+  refunds: Refund[];
+}
+
+export interface TaxBreakdown {
+  // 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: TaxBreakdown;
+}
+
+export interface BadRequestErrorDTO {
+  message: string;
+  code: number;
+  data: Record<string, any>;
+}
+
+export interface UnauthorizedErrorDTO {
+  message: string;
+  code: number;
+  data: Record<string, any>;
+}
+
+export interface ServiceUnavailableErrorDTO {
+  message: string;
+  code: number;
+  data: Record<string, any>;
+}
+
+// GET /tax/v1/health-check - Health Check
+
+export interface TaxHealthCheckQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type TaxHealthCheckResponse = {};
+
+export interface TaxHealthCheckRequest extends BaseRequest, RequestQuery<TaxHealthCheckQuery> {}
+
+// POST /tax/quote - get tax quote from 3rd party tax library
+
+export type QuoteBody = TaxRequestDTO;
+
+export type QuoteResponse = TaxResponseDTO;
+
+export interface QuoteRequest extends BaseRequest {
+  body: QuoteBody;
+}