@compassdigital/sdk.typescript 3.45.1 → 3.45.2

package/src/index.ts

@@ -507,19 +507,10 @@ import {
   PatchMenuV3ItemRelationshipsModifierGroupBody,
   PatchMenuV3ItemRelationshipsModifierGroupResponse,
   DeleteMenuV3ItemRelationshipsModifierGroupResponse,
-  GetMenuV3MenusQuery,
-  GetMenuV3MenusResponse,
-  GetMenuV3MenuQuery,
-  GetMenuV3MenuResponse,
-  PatchMenuV3MenuBody,
-  PatchMenuV3MenuResponse,
-  DeleteMenuV3MenuResponse,
-  PostMenuV3MenuBody,
-  PostMenuV3MenuResponse,
-  GetMenuV3MenusCountQuery,
-  GetMenuV3MenusCountResponse,
   GetMenuV3LayoutsQuery,
   GetMenuV3LayoutsResponse,
+  GetMenuV3LayoutCategoriesQuery,
+  GetMenuV3LayoutCategoriesResponse,
   GetMenuV3LayoutQuery,
   GetMenuV3LayoutResponse,
   PatchMenuV3LayoutBody,
@@ -549,6 +540,34 @@ import {
   PatchMenuV3CategoryRelationshipsItemBody,
   PatchMenuV3CategoryRelationshipsItemResponse,
   DeleteMenuV3CategoryRelationshipsItemResponse,
+  GetMenuV3BrandsQuery,
+  GetMenuV3BrandsResponse,
+  GetMenuV3BrandModifiersQuery,
+  GetMenuV3BrandModifiersResponse,
+  GetMenuV3BrandModifier_groupsQuery,
+  GetMenuV3BrandModifier_groupsResponse,
+  GetMenuV3BrandItemsQuery,
+  GetMenuV3BrandItemsResponse,
+  GetMenuV3BrandQuery,
+  GetMenuV3BrandResponse,
+  PatchMenuV3BrandBody,
+  PatchMenuV3BrandResponse,
+  DeleteMenuV3BrandResponse,
+  PostMenuV3BrandBody,
+  PostMenuV3BrandResponse,
+  GetMenuV3BrandsCountQuery,
+  GetMenuV3BrandsCountResponse,
+  GetMenuV3StationsQuery,
+  GetMenuV3StationsResponse,
+  GetMenuV3StationQuery,
+  GetMenuV3StationResponse,
+  PatchMenuV3StationBody,
+  PatchMenuV3StationResponse,
+  DeleteMenuV3StationResponse,
+  PostMenuV3StationBody,
+  PostMenuV3StationResponse,
+  GetMenuV3StationsCountQuery,
+  GetMenuV3StationsCountResponse,
   GetMenuClientQuery,
   GetMenuClientResponse,
   GetMenusQuery,
@@ -682,6 +701,13 @@ import {
   DeletePermissionRoleUserResponse,
 } from "./interface/permission";
 
+import {
+  GetDeliveryOrderQuery,
+  GetDeliveryOrderResponse,
+  GetDeliveryQuery,
+  GetDeliveryResponse,
+} from "./interface/delivery";
+
 import {
   PostLoyaltyEnrollQuery,
   PostLoyaltyEnrollResponse,
@@ -5229,121 +5255,40 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * GET /menu/v3/menus
-   *
-   * @param options - additional request options
-   */
-  get_menu_v3_menus(
-    options?: {
-      query?: GetMenuV3MenusQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetMenuV3MenusResponse> {
-    return this.request("menu", "get_menu_v3_menus", "get", `/menu/v3/menus`, null, options);
-  }
-
-  /**
-   * GET /menu/v3/menu/{id}
+   * GET /menu/v3/layouts
    *
-   * @param id
    * @param options - additional request options
    */
-  get_menu_v3_menu(
-    id: string,
+  get_menu_v3_layouts(
     options?: {
-      query?: GetMenuV3MenuQuery;
+      query?: GetMenuV3LayoutsQuery;
     } & RequestOptions
-  ): ResponsePromise<GetMenuV3MenuResponse> {
-    return this.request("menu", "get_menu_v3_menu", "get", `/menu/v3/menu/${id}`, null, options);
-  }
-
-  /**
-   * PATCH /menu/v3/menu/{id}
-   *
-   * @param id
-   * @param body
-   * @param options - additional request options
-   */
-  patch_menu_v3_menu(
-    id: string,
-    body: PatchMenuV3MenuBody,
-    options?: RequestOptions
-  ): ResponsePromise<PatchMenuV3MenuResponse> {
-    return this.request(
-      "menu",
-      "patch_menu_v3_menu",
-      "patch",
-      `/menu/v3/menu/${id}`,
-      body,
-      options
-    );
+  ): ResponsePromise<GetMenuV3LayoutsResponse> {
+    return this.request("menu", "get_menu_v3_layouts", "get", `/menu/v3/layouts`, null, options);
   }
 
   /**
-   * DELETE /menu/v3/menu/{id}
+   * GET /menu/v3/layout/{id}/categories
    *
    * @param id
    * @param options - additional request options
    */
-  delete_menu_v3_menu(
+  get_menu_v3_layout_categories(
     id: string,
-    options?: RequestOptions
-  ): ResponsePromise<DeleteMenuV3MenuResponse> {
-    return this.request(
-      "menu",
-      "delete_menu_v3_menu",
-      "delete",
-      `/menu/v3/menu/${id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * POST /menu/v3/menu
-   *
-   * @param body
-   * @param options - additional request options
-   */
-  post_menu_v3_menu(
-    body: PostMenuV3MenuBody,
-    options?: RequestOptions
-  ): ResponsePromise<PostMenuV3MenuResponse> {
-    return this.request("menu", "post_menu_v3_menu", "post", `/menu/v3/menu`, body, options);
-  }
-
-  /**
-   * GET /menu/v3/menus/count
-   *
-   * @param options - additional request options
-   */
-  get_menu_v3_menus_count(
     options?: {
-      query?: GetMenuV3MenusCountQuery;
+      query?: GetMenuV3LayoutCategoriesQuery;
     } & RequestOptions
-  ): ResponsePromise<GetMenuV3MenusCountResponse> {
+  ): ResponsePromise<GetMenuV3LayoutCategoriesResponse> {
     return this.request(
       "menu",
-      "get_menu_v3_menus_count",
+      "get_menu_v3_layout_categories",
       "get",
-      `/menu/v3/menus/count`,
+      `/menu/v3/layout/${id}/categories`,
       null,
       options
     );
   }
 
-  /**
-   * GET /menu/v3/layouts
-   *
-   * @param options - additional request options
-   */
-  get_menu_v3_layouts(
-    options?: {
-      query?: GetMenuV3LayoutsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetMenuV3LayoutsResponse> {
-    return this.request("menu", "get_menu_v3_layouts", "get", `/menu/v3/layouts`, null, options);
-  }
-
   /**
    * GET /menu/v3/layout/{id}
    *
@@ -5667,6 +5612,285 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /menu/v3/brands
+   *
+   * @param options - additional request options
+   */
+  get_menu_v3_brands(
+    options?: {
+      query?: GetMenuV3BrandsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandsResponse> {
+    return this.request("menu", "get_menu_v3_brands", "get", `/menu/v3/brands`, null, options);
+  }
+
+  /**
+   * GET /menu/v3/brand/{id}/modifiers
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_modifiers(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandModifiersQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandModifiersResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_modifiers",
+      "get",
+      `/menu/v3/brand/${id}/modifiers`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand/{id}/modifier_groups
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_modifier_groups(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandModifier_groupsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandModifier_groupsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_modifier_groups",
+      "get",
+      `/menu/v3/brand/${id}/modifier_groups`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand/{id}/items
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand_items(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandItemsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandItemsResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brand_items",
+      "get",
+      `/menu/v3/brand/${id}/items`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/brand/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_brand(
+    id: string,
+    options?: {
+      query?: GetMenuV3BrandQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandResponse> {
+    return this.request("menu", "get_menu_v3_brand", "get", `/menu/v3/brand/${id}`, null, options);
+  }
+
+  /**
+   * PATCH /menu/v3/brand/{id}
+   *
+   * @param id
+   * @param body
+   * @param options - additional request options
+   */
+  patch_menu_v3_brand(
+    id: string,
+    body: PatchMenuV3BrandBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV3BrandResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v3_brand",
+      "patch",
+      `/menu/v3/brand/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * DELETE /menu/v3/brand/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  delete_menu_v3_brand(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeleteMenuV3BrandResponse> {
+    return this.request(
+      "menu",
+      "delete_menu_v3_brand",
+      "delete",
+      `/menu/v3/brand/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v3/brand
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v3_brand(
+    body: PostMenuV3BrandBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV3BrandResponse> {
+    return this.request("menu", "post_menu_v3_brand", "post", `/menu/v3/brand`, body, options);
+  }
+
+  /**
+   * GET /menu/v3/brands/count
+   *
+   * @param options - additional request options
+   */
+  get_menu_v3_brands_count(
+    options?: {
+      query?: GetMenuV3BrandsCountQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3BrandsCountResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_brands_count",
+      "get",
+      `/menu/v3/brands/count`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /menu/v3/stations
+   *
+   * @param options - additional request options
+   */
+  get_menu_v3_stations(
+    options?: {
+      query?: GetMenuV3StationsQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3StationsResponse> {
+    return this.request("menu", "get_menu_v3_stations", "get", `/menu/v3/stations`, null, options);
+  }
+
+  /**
+   * GET /menu/v3/station/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  get_menu_v3_station(
+    id: string,
+    options?: {
+      query?: GetMenuV3StationQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3StationResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_station",
+      "get",
+      `/menu/v3/station/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PATCH /menu/v3/station/{id}
+   *
+   * @param id
+   * @param body
+   * @param options - additional request options
+   */
+  patch_menu_v3_station(
+    id: string,
+    body: PatchMenuV3StationBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchMenuV3StationResponse> {
+    return this.request(
+      "menu",
+      "patch_menu_v3_station",
+      "patch",
+      `/menu/v3/station/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * DELETE /menu/v3/station/{id}
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  delete_menu_v3_station(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeleteMenuV3StationResponse> {
+    return this.request(
+      "menu",
+      "delete_menu_v3_station",
+      "delete",
+      `/menu/v3/station/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /menu/v3/station
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_menu_v3_station(
+    body: PostMenuV3StationBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV3StationResponse> {
+    return this.request("menu", "post_menu_v3_station", "post", `/menu/v3/station`, body, options);
+  }
+
+  /**
+   * GET /menu/v3/stations/count
+   *
+   * @param options - additional request options
+   */
+  get_menu_v3_stations_count(
+    options?: {
+      query?: GetMenuV3StationsCountQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetMenuV3StationsCountResponse> {
+    return this.request(
+      "menu",
+      "get_menu_v3_stations_count",
+      "get",
+      `/menu/v3/stations/count`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /menu/client/{client_id} - Get menu client
    *
@@ -6807,6 +7031,45 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /delivery/{id}/order/{order_id} - get delivery for order
+   *
+   * @param id - delivery provider id
+   * @param order_id - order id
+   * @param options - additional request options
+   */
+  get_delivery_order(
+    id: string,
+    order_id: string,
+    options?: {
+      query?: GetDeliveryOrderQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetDeliveryOrderResponse> {
+    return this.request(
+      "delivery",
+      "get_delivery_order",
+      "get",
+      `/delivery/${id}/order/${order_id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /delivery/{id} - Get all Deliveries for delivery provider
+   *
+   * @param id - delivery provider id
+   * @param options - additional request options
+   */
+  get_delivery(
+    id: string,
+    options?: {
+      query?: GetDeliveryQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetDeliveryResponse> {
+    return this.request("delivery", "get_delivery", "get", `/delivery/${id}`, null, options);
+  }
+
   /**
    * POST /loyalty/{id}/enroll/{user_id} - Enroll logged in user in Loyalty program
    *

package/src/interface/delivery.ts

@@ -0,0 +1,101 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from "./util";
+
+export interface Error {
+  message?: string;
+  code?: number;
+}
+
+export interface Delivery {
+  // starship delivery job
+  id?: string;
+  // order id
+  order_id?: string;
+  date?: {
+    created?: string;
+    modified?: string;
+    CONFIRMED?: string;
+    ENROUTE_LOADING_AREA?: string;
+    ARRIVING_LOADING_AREA?: string;
+    WAITING_LOADING?: string;
+    LOADING?: string;
+    ENROUTE_CUSTOMER?: string;
+    ARRIVING_CUSTOMER?: string;
+    WAITING_CUSTOMER?: string;
+    UNLOADING?: string;
+    COMPLETED?: string;
+    CANCELLED?: string;
+    CUSTOMER_NO_SHOW?: string;
+    NO_SHOW_DEADLINE?: string;
+  };
+  assigned_robot?: {
+    name?: string;
+    heading?: number;
+    arrivedDestinationAt?: string;
+    coordinates?: {
+      lat?: number;
+      lng?: number;
+    };
+  };
+  drop_off_location?: {
+    // drop off location cd id
+    id?: string;
+    // starship delivery location id
+    starship_id?: string;
+    name?: string;
+    coordinates?: {
+      lat?: number;
+      lng?: number;
+    };
+  };
+  eta?: {
+    loadingAt?: string;
+    destinationAt?: string;
+  };
+  customer?: string;
+  loading_code?: string;
+  state?: string;
+  state_reason?: string;
+  tracker_url?: string;
+}
+
+// GET /delivery/{id}/order/{order_id} - get delivery for order
+
+export interface GetDeliveryOrderPath {
+  // delivery provider id
+  id: string;
+  // order id
+  order_id: string;
+}
+
+export interface GetDeliveryOrderQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetDeliveryOrderResponse = Delivery;
+
+export interface GetDeliveryOrderRequest
+  extends BaseRequest,
+    RequestQuery<GetDeliveryOrderQuery>,
+    GetDeliveryOrderPath {}
+
+// GET /delivery/{id} - Get all Deliveries for delivery provider
+
+export interface GetDeliveryPath {
+  // delivery provider id
+  id: string;
+}
+
+export interface GetDeliveryQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetDeliveryResponse = Delivery;
+
+export interface GetDeliveryRequest
+  extends BaseRequest,
+    RequestQuery<GetDeliveryQuery>,
+    GetDeliveryPath {}