@compassdigital/sdk.typescript 3.51.0 → 3.52.0

package/manifest.json

@@ -2,63 +2,63 @@
     "services": [
         {
             "name": "payment",
-            "swagger": "../../platform2/compassdigital.service.payment/swagger.json"
+            "swagger": "../../platform2/payment/service/swagger.json"
         },
         {
             "name": "order",
-            "swagger": "../../platform2/compassdigital.service.order/swagger.json"
+            "swagger": "../../platform2/order/service/swagger.json"
         },
         {
             "name": "location",
-            "swagger": "../../platform2/compassdigital.service.location/swagger.json"
+            "swagger": "../../platform2/location/service/swagger.json"
         },
         {
             "name": "shoppingcart",
-            "swagger": "../../platform2/compassdigital.service.shoppingcart/swagger.json"
+            "swagger": "../../platform2/shoppingcart/swagger.json"
         },
         {
             "name": "partner",
-            "swagger": "../../platform2/compassdigital.service.partner/swagger.json"
+            "swagger": "../../platform2/partner/swagger.json"
         },
         {
             "name": "email",
-            "swagger": "../../platform2/compassdigital.service.email/swagger.json"
+            "swagger": "../../platform2/email/swagger.json"
         },
         {
             "name": "task",
-            "swagger": "../../platform2/compassdigital.service.task/swagger.json"
+            "swagger": "../../platform2/task/swagger.json"
         },
         {
             "name": "kds",
-            "swagger": "../../platform2/compassdigital.service.kds/swagger.json"
+            "swagger": "../../platform2/kds/swagger.json"
         },
         {
             "name": "mealplan",
-            "swagger": "../../platform2/compassdigital.service.mealplan/swagger.json"
+            "swagger": "../../platform2/mealplan/service/swagger.json"
         },
         {
             "name": "datalake",
-            "swagger": "../../platform2/compassdigital.service.datalake/swagger.json"
+            "swagger": "../../platform2/datalake/swagger.json"
         },
         {
             "name": "promo",
-            "swagger": "../../platform2/compassdigital.service.promo/swagger.json"
+            "swagger": "../../platform2/promo/service/swagger.json"
         },
         {
             "name": "config",
-            "swagger": "../../platform2/compassdigital.service.config/swagger.json"
+            "swagger": "../../platform2/config/service/swagger.json"
         },
         {
             "name": "announcement",
-            "swagger": "../../platform2/compassdigital.service.announcement/swagger.json"
+            "swagger": "../../platform2/announcement/service/swagger.json"
         },
         {
             "name": "report",
-            "swagger": "../../platform2/compassdigital.service.report/swagger.json"
+            "swagger": "../../platform2/report/service/swagger.json"
         },
         {
             "name": "user",
-            "swagger": "../../platform2/compassdigital.service.user/swagger.json"
+            "swagger": "../../platform2/user/service/swagger.json"
         },
         {
             "name": "calendar",
@@ -66,7 +66,7 @@
         },
         {
             "name": "file",
-            "swagger": "../../platform2/compassdigital.service.file/swagger.json"
+            "swagger": "../../platform2/file/swagger.json"
         },
         {
             "name": "menu",
@@ -74,31 +74,31 @@
         },
         {
             "name": "notification",
-            "swagger": "../../platform2/compassdigital.service.notification/swagger.json"
-        },
-		{
-			"name": "compassconnect",
-			"swagger": "../../platform2/compassdigital.service.compassconnect/swagger.json"
-		},
-		{
-			"name": "vendor",
-			"swagger": "../../platform2/compassdigital.service.vendor/swagger.json"
-		},
-		{
-			"name": "sms",
-			"swagger": "../../platform2/compassdigital.service.sms/swagger.json"
-		},
-		{
-			"name": "permission",
-			"swagger": "../../platform2/compassdigital.service.permission/swagger.json"
-		},
+            "swagger": "../../platform2/notification/swagger.json"
+        },
+        {
+            "name": "compassconnect",
+            "swagger": "../../platform2/compassconnect/swagger.json"
+        },
+        {
+            "name": "vendor",
+            "swagger": "../../platform2/vendor/swagger.json"
+        },
+        {
+            "name": "sms",
+            "swagger": "../../platform2/sms/swagger.json"
+        },
+        {
+            "name": "permission",
+            "swagger": "../../platform2/permission/swagger.json"
+        },
         {
             "name": "delivery",
-            "swagger": "../../platform2/compassdigital.service.delivery/swagger.json"
+            "swagger": "../../platform2/delivery/swagger.json"
         },
-		{
-			"name": "loyalty",
-			"swagger": "https://api.compassdigital.org/dev/loyalty/swagger.json"
-		}
+        {
+            "name": "loyalty",
+            "swagger": "https://api.compassdigital.org/dev/loyalty/swagger.json"
+        }
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compassdigital/sdk.typescript",
-  "version": "3.51.0",
+  "version": "3.52.0",
   "description": "Compass Digital Labs TypeScript SDK",
   "type": "commonjs",
   "main": "./lib/index.js",
@@ -44,7 +44,7 @@
   "devDependencies": {
     "@compassdigital/sdk.typescript.cli": "^3.27.2",
     "@types/jest": "^29.2.4",
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.1.0",
     "esbuild": "^0.17.0",
     "esbuild-jest": "^0.5.0",
     "jest": "^29.3.1",

package/src/index.ts

@@ -779,6 +779,29 @@ import {
   GetMenuV3CategorysCountQuery,
   GetMenuV3CategorysCountResponse,
   PostMenuV3BrandLocalResponse,
+  PostMenuV3ItemAttachmentQuery,
+  PostMenuV3ItemAttachmentResponse,
+  PostMenuV3BrandAttachmentQuery,
+  PostMenuV3BrandAttachmentResponse,
+  PostMenuV3BrandGroupBody,
+  PostMenuV3BrandGroupResponse,
+  GetMenuV3BrandGroupQuery,
+  GetMenuV3BrandGroupResponse,
+  PatchMenuV3BrandGroupBody,
+  PatchMenuV3BrandGroupResponse,
+  DeleteMenuV3BrandGroupResponse,
+  GetMenuV3BrandGroupsQuery,
+  GetMenuV3BrandGroupsResponse,
+  PostMenuV3BrandGroupsBody,
+  PostMenuV3BrandGroupsResponse,
+  GetMenuV3BrandGroupsCountQuery,
+  GetMenuV3BrandGroupsCountResponse,
+  GetMenuV3BrandGroupDraftBrandsQuery,
+  GetMenuV3BrandGroupDraftBrandsResponse,
+  GetMenuV3BrandGroupBrandsQuery,
+  GetMenuV3BrandGroupBrandsResponse,
+  GetMenuV3DraftBrandGroupBrandsQuery,
+  GetMenuV3DraftBrandGroupBrandsResponse,
 } from "./interface/menu";
 
 import {
@@ -861,6 +884,8 @@ import {
   GetDeliveryOrderResponse,
   GetDeliveryQuery,
   GetDeliveryResponse,
+  PostDeliveryAvailabilityBody,
+  PostDeliveryAvailabilityResponse,
 } from "./interface/delivery";
 
 import {
@@ -8250,6 +8275,264 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * POST /menu/v3/item/{id}/attachment/{name}
+   *
+   * @param id
+   * @param name
+   * @param options - additional request options
+   */
+  post_menu_v3_item_attachment(
+    id: string,
+    name: string,
+    options?: {
+      query?: PostMenuV3ItemAttachmentQuery;
+    } & RequestOptions
+  ): ResponsePromise<PostMenuV3ItemAttachmentResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v3_item_attachment",
+      "post",
+      `/menu/v3/item/${id}/attachment/${name}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v3/brand/{id}/attachment/{name}
+   *
+   * @param id
+   * @param name
+   * @param options - additional request options
+   */
+  post_menu_v3_brand_attachment(
+    id: string,
+    name: string,
+    options?: {
+      query?: PostMenuV3BrandAttachmentQuery;
+    } & RequestOptions
+  ): ResponsePromise<PostMenuV3BrandAttachmentResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v3_brand_attachment",
+      "post",
+      `/menu/v3/brand/${id}/attachment/${name}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v3/brand-group
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v3_brand_group(
+    body: PostMenuV3BrandGroupBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV3BrandGroupResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v3_brand_group",
+      "post",
+      `/menu/v3/brand-group`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand-group/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_group(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandGroupQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandGroupResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_group",
+      "get",
+      `/menu/v3/brand-group/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PATCH /menu/v3/brand-group/{id}
+   *
+   * @param id
+   * @param body - A partially populated BrandGroupEntity
+   * @param options - additional request options
+   */
+  patch_menu_v3_brand_group(
+    id: string,
+    body: PatchMenuV3BrandGroupBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV3BrandGroupResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v3_brand_group",
+      "patch",
+      `/menu/v3/brand-group/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * DELETE /menu/v3/brand-group/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  delete_menu_v3_brand_group(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeleteMenuV3BrandGroupResponse> {
+    return this.request(
+      "menu",
+      "delete_menu_v3_brand_group",
+      "delete",
+      `/menu/v3/brand-group/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand-groups
+   *
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_groups(
+    options?: {
+      query?: GetMenuV3BrandGroupsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandGroupsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_groups",
+      "get",
+      `/menu/v3/brand-groups`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v3/brand-groups
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v3_brand_groups(
+    body: PostMenuV3BrandGroupsBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV3BrandGroupsResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v3_brand_groups",
+      "post",
+      `/menu/v3/brand-groups`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand-groups/count
+   *
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_groups_count(
+    options?: {
+      query?: GetMenuV3BrandGroupsCountQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandGroupsCountResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_groups_count",
+      "get",
+      `/menu/v3/brand-groups/count`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand-group/{id}/draft/brands
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_group_draft_brands(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandGroupDraftBrandsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandGroupDraftBrandsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_group_draft_brands",
+      "get",
+      `/menu/v3/brand-group/${id}/draft/brands`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand-group/{id}/brands
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_group_brands(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandGroupBrandsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandGroupBrandsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_group_brands",
+      "get",
+      `/menu/v3/brand-group/${id}/brands`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/draft/brand-group/{id}/brands
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_draft_brand_group_brands(
+    id: string,
+    options?: {
+      query?: GetMenuV3DraftBrandGroupBrandsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3DraftBrandGroupBrandsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_draft_brand_group_brands",
+      "get",
+      `/menu/v3/draft/brand-group/${id}/brands`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /notification - Get all notifications
    *
@@ -8916,6 +9199,28 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("delivery", "get_delivery", "get", `/delivery/${id}`, null, options);
   }
 
+  /**
+   * POST /delivery/{id}/availability - Get delivery availability for provided brand and coordinates
+   *
+   * @param id - delivery provider id
+   * @param body - Order object that needs to be created
+   * @param options - additional request options
+   */
+  post_delivery_availability(
+    id: string,
+    body: PostDeliveryAvailabilityBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostDeliveryAvailabilityResponse> {
+    return this.request(
+      "delivery",
+      "post_delivery_availability",
+      "post",
+      `/delivery/${id}/availability`,
+      body,
+      options
+    );
+  }
+
   /**
    * POST /loyalty/{id}/enroll/{user_id} - Enroll logged in user in Loyalty program
    *

package/src/interface/announcement.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
+  data?: any;
 }
 
 export interface Success {

package/src/interface/calendar.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
+  data?: any;
 }
 
 export interface Event {

package/src/interface/compassconnect.ts

@@ -13,6 +13,7 @@ export interface OMSRequest {
 export interface Error {
   message?: string;
   code?: number;
+  data?: any;
 }
 
 export interface Auth {

package/src/interface/config.ts

@@ -12,6 +12,7 @@ export interface Config {
 export interface Error {
   error?: string;
   code?: number;
+  data?: any;
 }
 
 export interface Success {

package/src/interface/datalake.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   error?: string;
   code?: number;
+  data?: any;
 }
 
 export interface QueryBody {

package/src/interface/delivery.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
+  data?: any;
 }
 
 export interface Delivery {
@@ -61,6 +62,18 @@ export interface Delivery {
   tracker_url?: string;
 }
 
+export interface Available {
+  deliverable: boolean;
+}
+
+export interface PostAvailabilityBody {
+  destination: {
+    latitude: any;
+    longitude: any;
+  };
+  brand_id: string;
+}
+
 // GET /delivery/{id}/order/{order_id} - get delivery for order
 
 export interface GetDeliveryOrderPath {
@@ -100,3 +113,18 @@ export interface GetDeliveryRequest
   extends BaseRequest,
     RequestQuery<GetDeliveryQuery>,
     GetDeliveryPath {}
+
+// POST /delivery/{id}/availability - Get delivery availability for provided brand and coordinates
+
+export interface PostDeliveryAvailabilityPath {
+  // delivery provider id
+  id: string;
+}
+
+export type PostDeliveryAvailabilityBody = PostAvailabilityBody;
+
+export type PostDeliveryAvailabilityResponse = Available;
+
+export interface PostDeliveryAvailabilityRequest extends BaseRequest, PostDeliveryAvailabilityPath {
+  body: PostDeliveryAvailabilityBody;
+}

package/src/interface/email.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
+  data?: any;
 }
 
 export interface Success {

package/src/interface/file.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
+  data?: any;
 }
 
 export interface File {

package/src/interface/kds.ts

@@ -11,6 +11,7 @@ export interface Error {
   error?: string;
   message?: string;
   code: number;
+  data?: any;
 }
 
 export interface Device {

package/src/interface/location.ts

@@ -317,6 +317,7 @@ export interface success {
 export interface Error {
   error?: string;
   code?: number;
+  data?: any;
 }
 
 export interface Sector {

package/src/interface/mealplan.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
+  data?: any;
   headers?: {
     Location?: string;
   };