@compassdigital/sdk.typescript 4.32.0 → 4.34.0

package/src/index.ts

@@ -940,10 +940,17 @@ import {
 import {
   TaxHealthCheckQuery,
   TaxHealthCheckResponse,
-  QuoteBody,
-  QuoteResponse,
+  PostQuoteTaxBody,
+  PostQuoteTaxResponse,
 } from "./interface/tax";
 
+import {
+  GetSearchOrderQuery,
+  GetSearchOrderResponse,
+  GetSearchLocationQuery,
+  GetSearchLocationResponse,
+} from "./interface/search";
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
 
@@ -9602,7 +9609,36 @@ export class ServiceClient extends BaseServiceClient {
    * @param body
    * @param options - additional request options
    */
-  quote(body: QuoteBody, options?: RequestOptions): ResponsePromise<QuoteResponse> {
-    return this.request("tax", "quote", "post", `/tax/quote`, body, options);
+  post_quote_tax(
+    body: PostQuoteTaxBody,
+    options?: RequestOptions,
+  ): ResponsePromise<PostQuoteTaxResponse> {
+    return this.request("tax", "post_quote_tax", "post", `/tax/quote`, body, options);
+  }
+
+  /**
+   * GET /search/order
+   *
+   * @param options - additional request options
+   */
+  get_search_order(
+    options?: {
+      query?: GetSearchOrderQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetSearchOrderResponse> {
+    return this.request("search", "get_search_order", "get", `/search/order`, null, options);
+  }
+
+  /**
+   * GET /search/location
+   *
+   * @param options - additional request options
+   */
+  get_search_location(
+    options?: {
+      query?: GetSearchLocationQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetSearchLocationResponse> {
+    return this.request("search", "get_search_location", "get", `/search/location`, null, options);
   }
 }

package/src/interface/search.ts

@@ -0,0 +1,180 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from "./util";
+
+export interface MetaResultsDto {
+  limit: number;
+  page: number;
+  sortBy?: Record<string, any>;
+  sortOrder?: Record<string, any>;
+  totalResults: number;
+  totalPages: number;
+  resultsCount: number;
+}
+
+export interface GetShoppingcartDto {
+  id: string;
+  source_id: string;
+  menu: string;
+  location: string;
+  meta: {
+    [index: string]: any;
+  };
+  sub_total: Record<string, any>;
+  payment_method: Record<string, any>;
+  loyalty: Record<string, any>;
+  total: Record<string, any>;
+  exemptions: Record<string, any>;
+  brand: string;
+  is: Record<string, any>;
+  source_order_id: string;
+  items: Record<string, any>;
+  discount: Record<string, any>;
+  delivery_fee: Record<string, any>;
+  source_date_created: string;
+  source_date_modified: string;
+  promo: Record<string, any>;
+  taxes: Record<string, any>;
+  service_fee: Record<string, any>;
+}
+
+export interface OrderGroupDetails {
+  source_id?: string;
+  name?: string;
+}
+
+export interface OrderBrandDetails {
+  source_id?: string;
+  name?: string;
+}
+
+export interface GetOrderDto {
+  source_id: string;
+  requested_date: string;
+  pickup_id: string;
+  pickup: string;
+  is: Record<string, any>;
+  mealplan: Record<string, any>;
+  shoppingcart: GetShoppingcartDto;
+  date: Record<string, any>;
+  pickup_name: string;
+  details: Record<string, any>;
+  payment: Record<string, any>;
+  meal_swipes: Record<string, any>;
+  meal_exchange: Record<string, any>;
+  issue: Record<string, any>;
+  source_group: OrderGroupDetails;
+  source_brand: OrderBrandDetails;
+  date_created: string;
+  refund_status: string;
+  payment_type: string;
+  payment_category: string;
+  market_place_stations: OrderBrandDetails[];
+  // Order original cart amount before refunds
+  total: string;
+  // Customer email
+  email: string;
+  // Order type: pickup/delivery/etc
+  order_type: string;
+  // Order status: accepted/in_progress/ready/etc
+  status: string;
+}
+
+export interface GetOrderPaginatedResult {
+  meta: MetaResultsDto;
+  results: GetOrderDto[];
+}
+
+export interface GetLocationDto {
+  source_id: string;
+  source_type: string;
+  name: string;
+}
+
+export interface GetLocationPaginatedResult {
+  meta: MetaResultsDto;
+  results: GetLocationDto[];
+}
+
+// GET /search/order
+
+export interface GetSearchOrderQuery {
+  // Items to return in response
+  limit?: number;
+  // Pagination param
+  page?: number;
+  // Return items sorted by this column
+  sortBy?:
+    | "date_created"
+    | "destination"
+    | "id"
+    | "pickup"
+    | "pickup_id"
+    | "pickup_name"
+    | "source_id"
+    | "sub_total"
+    | "total"
+    | "site_name"
+    | "status"
+    | "order_type"
+    | "fulfillment_date";
+  sortOrder?: "ASC" | "DESC";
+  // Filter orders by site id
+  source_group_id?: string;
+  // Filter orders by station id
+  source_brand_id?: string;
+  // Filter orders with created date not earlier than
+  date_created_start?: string;
+  // Filter orders with created date not later than this date
+  date_created_end?: string;
+  // Filter orders having specific order number
+  pickup_id?: string;
+  // Filter orders by user pickup name
+  pickup_name?: string;
+  // Search order by order ID
+  source_id?: string;
+  // Search order by refund_status
+  refund_status?: ("" | "partial" | "full")[];
+  // Filter orders by payment type
+  payment_type?: string;
+  // Filter orders by payment category
+  payment_category?: ("digital wallet" | "badge pay" | "credit card" | "mealplan")[];
+  // Filter orders by customer email
+  email?: string;
+  // Filter orders by order type
+  order_type?: "frictionless" | "delivery" | "pickup" | "scan_and_go";
+  // Filter orders by order status/progress
+  status?: "ready" | "accepted" | "delivered" | "in_progress" | "out_for_delivery" | "created";
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetSearchOrderResponse = GetOrderPaginatedResult;
+
+export interface GetSearchOrderRequest extends BaseRequest, RequestQuery<GetSearchOrderQuery> {}
+
+// GET /search/location
+
+export interface GetSearchLocationQuery {
+  // Items to return in response
+  limit?: number;
+  // Pagination param
+  page?: number;
+  // Filter entities with names containing this value
+  name?: string;
+  // Filter entities with specific type
+  source_type?: "brand" | "location" | "group" | "multigroup" | "sector" | "company";
+  // Filter entities with specific group id as a parent
+  source_group_parent?: string;
+  // Filter entities with specific multigroup id as a parent
+  source_multigroup_parent?: string;
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetSearchLocationResponse = GetLocationPaginatedResult;
+
+export interface GetSearchLocationRequest
+  extends BaseRequest,
+    RequestQuery<GetSearchLocationQuery> {}

package/src/interface/tax.ts

@@ -3,7 +3,7 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
-export interface LocationData {
+export interface TaxLocationData {
   // unique location identifier
   id: string;
   // country of transaction
@@ -18,11 +18,11 @@ export interface LocationData {
   streetAddress: string;
 }
 
-export interface ItemDTO {
+export interface TaxItemDTO {
   // unique item identifier
   id: string;
   // indicates a tax rule for an item
-  taxTag: string;
+  taxTagCode: string;
   // amount of an item
   quantity: number;
   // decimal price of an item
@@ -31,7 +31,7 @@ export interface ItemDTO {
   taxedAmount?: number;
 }
 
-export interface Refund {
+export interface TaxRefund {
   // unique identifier of the refunded item
   refundItemId: string;
   // quantity amount of the item to be refunded
@@ -39,7 +39,7 @@ export interface Refund {
 }
 
 export interface TaxRequestDTO {
-  // the unique location code
+  // a unique identifier representing the transaction
   id: string;
   // the order fulfillment type
   transactionType: "pickup" | "delivery";
@@ -47,16 +47,16 @@ export interface TaxRequestDTO {
   serviceFee?: number;
   // numeric value of delivery fee
   deliveryFee?: number;
-  locationData: LocationData;
+  locationData: TaxLocationData;
   // items to calculate tax on
-  items: ItemDTO[];
+  items: TaxItemDTO[];
   // iso timstamp of transaction date
-  transactionDate: string;
+  transactionDate?: string;
   // an array of items to refund
-  refunds: Refund[];
+  refunds?: TaxRefund[];
 }
 
-export interface TaxBreakdown {
+export interface TaxBreakdownDTO {
   // canadian value: goods and services tax
   gst?: number;
   // canadian value: provincial sales tax
@@ -70,7 +70,9 @@ export interface TaxResponseDTO {
   amount: number;
   // the total tax rate applied to the items to determine the total tax of the transaction
   rate: number;
-  breakdown: TaxBreakdown;
+  // items with calculated tax data added
+  items: TaxItemDTO[];
+  breakdown: TaxBreakdownDTO;
 }
 
 export interface BadRequestErrorDTO {
@@ -104,10 +106,10 @@ export interface TaxHealthCheckRequest extends BaseRequest, RequestQuery<TaxHeal
 
 // POST /tax/quote - get tax quote from 3rd party tax library
 
-export type QuoteBody = TaxRequestDTO;
+export type PostQuoteTaxBody = TaxRequestDTO;
 
-export type QuoteResponse = TaxResponseDTO;
+export type PostQuoteTaxResponse = TaxResponseDTO;
 
-export interface QuoteRequest extends BaseRequest {
-  body: QuoteBody;
+export interface PostQuoteTaxRequest extends BaseRequest {
+  body: PostQuoteTaxBody;
 }

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  "conventionalCommits.scopes": [
-    "typescript.sdk"
-  ]
-}