@compassdigital/sdk.typescript 4.30.0 → 4.32.0

package/lib/interface/tax.d.ts

@@ -0,0 +1,67 @@
+import { RequestQuery, BaseRequest } from "./util";
+export interface LocationData {
+    id: string;
+    country: string;
+    stateOrProvince: string;
+    city: string;
+    postalCode: string;
+    streetAddress: string;
+}
+export interface ItemDTO {
+    id: string;
+    taxTag: string;
+    quantity: number;
+    price: number;
+    taxedAmount?: number;
+}
+export interface Refund {
+    refundItemId: string;
+    refundItemQuantity: number;
+}
+export interface TaxRequestDTO {
+    id: string;
+    transactionType: "pickup" | "delivery";
+    serviceFee?: number;
+    deliveryFee?: number;
+    locationData: LocationData;
+    items: ItemDTO[];
+    transactionDate: string;
+    refunds: Refund[];
+}
+export interface TaxBreakdown {
+    gst?: number;
+    pst?: number;
+    qst?: number;
+}
+export interface TaxResponseDTO {
+    amount: number;
+    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>;
+}
+export interface TaxHealthCheckQuery {
+    _query?: string;
+}
+export type TaxHealthCheckResponse = {};
+export interface TaxHealthCheckRequest extends BaseRequest, RequestQuery<TaxHealthCheckQuery> {
+}
+export type QuoteBody = TaxRequestDTO;
+export type QuoteResponse = TaxResponseDTO;
+export interface QuoteRequest extends BaseRequest {
+    body: QuoteBody;
+}
+//# sourceMappingURL=tax.d.ts.map

package/lib/interface/tax.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax.d.ts","sourceRoot":"","sources":["../../src/interface/tax.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,YAAY;IAE3B,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,eAAe,EAAE,MAAM,CAAC;IAExB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,OAAO;IAEtB,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,MAAM;IAErB,YAAY,EAAE,MAAM,CAAC;IAErB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAE5B,EAAE,EAAE,MAAM,CAAC;IAEX,eAAe,EAAE,QAAQ,GAAG,UAAU,CAAC;IAEvC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAE3B,KAAK,EAAE,OAAO,EAAE,CAAC;IAEjB,eAAe,EAAE,MAAM,CAAC;IAExB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAE3B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAE7B,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAID,MAAM,WAAW,mBAAmB;IAElC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAExC,MAAM,WAAW,qBAAsB,SAAQ,WAAW,EAAE,YAAY,CAAC,mBAAmB,CAAC;CAAG;AAIhG,MAAM,MAAM,SAAS,GAAG,aAAa,CAAC;AAEtC,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;AAE3C,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,SAAS,CAAC;CACjB"}

package/lib/interface/tax.js

@@ -0,0 +1,5 @@
+"use strict";
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tax.js.map

package/lib/interface/tax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax.js","sourceRoot":"","sources":["../../src/interface/tax.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,sDAAsD"}

package/manifest.json

@@ -103,6 +103,10 @@
         {
             "name": "centricos",
             "swagger": "../../platform2/edges/centricos/swagger.json"
+        },
+		{
+            "name": "tax",
+            "swagger": "../../platform2/external-integrations/tax/swagger.json"
         }
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.30.0",
+	"version": "4.32.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -937,6 +937,13 @@ import {
   GetCentricosLookerEmbedurlResponse,
 } from "./interface/centricos";
 
+import {
+  TaxHealthCheckQuery,
+  TaxHealthCheckResponse,
+  QuoteBody,
+  QuoteResponse,
+} from "./interface/tax";
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
 
@@ -9575,4 +9582,27 @@ export class ServiceClient extends BaseServiceClient {
       options,
     );
   }
+
+  /**
+   * GET /tax/v1/health-check - Health Check
+   *
+   * @param options - additional request options
+   */
+  tax_health_check(
+    options?: {
+      query?: TaxHealthCheckQuery;
+    } & RequestOptions,
+  ): ResponsePromise<TaxHealthCheckResponse> {
+    return this.request("tax", "tax_health_check", "get", `/tax/v1/health-check`, null, options);
+  }
+
+  /**
+   * POST /tax/quote - get tax quote from 3rd party tax library
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  quote(body: QuoteBody, options?: RequestOptions): ResponsePromise<QuoteResponse> {
+    return this.request("tax", "quote", "post", `/tax/quote`, body, options);
+  }
 }

package/src/interface/menu.ts

@@ -644,6 +644,7 @@ export interface DraftModifierGroupDTO {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: FilterFieldDTO;
+  is_incremental?: FilterFieldDTO;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
   changes?: ModifierGroupChangeDTO[];
@@ -833,6 +834,15 @@ export interface BrandStatusDTO {
   [index: string]: any;
 }
 
+export interface SiteGroupWithMenuGroupNameResponseDTO {
+  site_id: string;
+  local_menu_group_id: string;
+  local_menu_group_name: string;
+  created_at?: string;
+  updated_at?: string;
+  [index: string]: any;
+}
+
 export interface SiteGroupDTO {
   site_id: string;
   local_menu_group_id: string;
@@ -913,6 +923,7 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
   order_type?: FilterFieldDTO;
   sizing?: FilterFieldDTO;
   is_out_of_stock?: FilterFieldDTO;
+  is_incremental?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1113,6 +1124,7 @@ export interface PublishedModifierGroupDTO {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1677,6 +1689,7 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
   order_type?: FilterFieldDTO;
   sizing?: FilterFieldDTO;
   is_out_of_stock?: FilterFieldDTO;
+  is_incremental?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -2726,7 +2739,7 @@ export interface GetMenuV3LocalMenuGroupSiteQuery {
 }
 
 export interface GetMenuV3LocalMenuGroupSiteResponse {
-  results?: SiteGroupDTO[];
+  results?: SiteGroupWithMenuGroupNameResponseDTO[];
 }
 
 export interface GetMenuV3LocalMenuGroupSiteRequest
@@ -2746,7 +2759,7 @@ export interface GetMenuV3LocalMenuGroupMenuGroupQuery {
 }
 
 export interface GetMenuV3LocalMenuGroupMenuGroupResponse {
-  results?: SiteGroupDTO[];
+  results?: SiteGroupWithMenuGroupNameResponseDTO[];
 }
 
 export interface GetMenuV3LocalMenuGroupMenuGroupRequest
@@ -2756,7 +2769,13 @@ export interface GetMenuV3LocalMenuGroupMenuGroupRequest
 
 // POST /menu/v3/local-menu-groups/site-groups
 
-export type PostMenuV3LocalMenuGroupsSiteGroupsBody = SiteGroupDTO[];
+export type PostMenuV3LocalMenuGroupsSiteGroupsBody = {
+  site_id: string;
+  local_menu_group_id: string;
+  created_at?: string;
+  updated_at?: string;
+  [index: string]: any;
+}[];
 
 export interface PostMenuV3LocalMenuGroupsSiteGroupsResponse {
   results?: SiteGroupDTO[];
@@ -5468,6 +5487,7 @@ export interface PostMenuV3DraftModifierGroupBody {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5528,6 +5548,7 @@ export interface PatchMenuV3DraftModifierGroupBody {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5608,6 +5629,7 @@ export type PostMenuV3DraftModifierGroupsBody = {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5673,6 +5695,7 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
   order_type?: "selection" | "option" | "quantity";
   sizing?: string;
   is_out_of_stock?: boolean;
+  is_incremental?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;

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;
+}