@compassdigital/sdk.typescript 4.465.0 → 4.467.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.465.0",
3
+ "version": "4.467.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -938,6 +938,10 @@ import {
938
938
  PostMenuV4BrandMenuDuplicateResponse,
939
939
  GetMenuV4BrandExportQuery,
940
940
  GetMenuV4BrandExportResponse,
941
+ PostMenuV4BrandsFetchQuery,
942
+ PostMenuV4BrandsFetchResponse,
943
+ PostMenuV4BrandItemsSearchQuery,
944
+ PostMenuV4BrandItemsSearchResponse,
941
945
  PostMenuV4ItemAttachmentQuery,
942
946
  PostMenuV4ItemAttachmentResponse,
943
947
  PostMenuV4ItemBody,
@@ -1024,6 +1028,10 @@ import {
1024
1028
  DeleteMenuV4CategoryDetachItemsResponse,
1025
1029
  GetMenuV4CategoryAttachableItemsQuery,
1026
1030
  GetMenuV4CategoryAttachableItemsResponse,
1031
+ PostMenuV4StationsMenusFetchQuery,
1032
+ PostMenuV4StationsMenusFetchResponse,
1033
+ PostMenuV4StationItemsSearchQuery,
1034
+ PostMenuV4StationItemsSearchResponse,
1027
1035
  GetMenuV3PingResponse,
1028
1036
  GetMenuV3HealthResponse,
1029
1037
  } from './interface/menu';
@@ -1287,7 +1295,6 @@ import {
1287
1295
  PutCentricosDiscountVoucherifyPublishResponse,
1288
1296
  DeleteCentricosDiscountsVoucherifyResponse,
1289
1297
  GetCentricosDiscountResponse,
1290
- GetCentricosDiscountAllResponse,
1291
1298
  PostDiscountActiveBody,
1292
1299
  PostDiscountActiveResponse,
1293
1300
  GetCentricosDiscountsQuery,
@@ -10866,6 +10873,46 @@ export class ServiceClient extends BaseServiceClient {
10866
10873
  );
10867
10874
  }
10868
10875
 
10876
+ /**
10877
+ * POST /menu/v4/brands/fetch
10878
+ *
10879
+ * @param options - additional request options
10880
+ */
10881
+ post_menu_v4_brands_fetch(
10882
+ options?: {
10883
+ query?: PostMenuV4BrandsFetchQuery;
10884
+ } & RequestOptions,
10885
+ ): ResponsePromise<PostMenuV4BrandsFetchResponse> {
10886
+ return this.request(
10887
+ 'menu',
10888
+ '/menu/v4/brands/fetch',
10889
+ 'POST',
10890
+ `/menu/v4/brands/fetch`,
10891
+ null,
10892
+ options,
10893
+ );
10894
+ }
10895
+
10896
+ /**
10897
+ * POST /menu/v4/brand/items/search
10898
+ *
10899
+ * @param options - additional request options
10900
+ */
10901
+ post_menu_v4_brand_items_search(
10902
+ options?: {
10903
+ query?: PostMenuV4BrandItemsSearchQuery;
10904
+ } & RequestOptions,
10905
+ ): ResponsePromise<PostMenuV4BrandItemsSearchResponse> {
10906
+ return this.request(
10907
+ 'menu',
10908
+ '/menu/v4/brand/items/search',
10909
+ 'POST',
10910
+ `/menu/v4/brand/items/search`,
10911
+ null,
10912
+ options,
10913
+ );
10914
+ }
10915
+
10869
10916
  /**
10870
10917
  * POST /menu/v4/item/{id}/attachment/{name}
10871
10918
  *
@@ -11801,6 +11848,46 @@ export class ServiceClient extends BaseServiceClient {
11801
11848
  );
11802
11849
  }
11803
11850
 
11851
+ /**
11852
+ * POST /menu/v4/stations/menus/fetch
11853
+ *
11854
+ * @param options - additional request options
11855
+ */
11856
+ post_menu_v4_stations_menus_fetch(
11857
+ options?: {
11858
+ query?: PostMenuV4StationsMenusFetchQuery;
11859
+ } & RequestOptions,
11860
+ ): ResponsePromise<PostMenuV4StationsMenusFetchResponse> {
11861
+ return this.request(
11862
+ 'menu',
11863
+ '/menu/v4/stations/menus/fetch',
11864
+ 'POST',
11865
+ `/menu/v4/stations/menus/fetch`,
11866
+ null,
11867
+ options,
11868
+ );
11869
+ }
11870
+
11871
+ /**
11872
+ * POST /menu/v4/station/items/search
11873
+ *
11874
+ * @param options - additional request options
11875
+ */
11876
+ post_menu_v4_station_items_search(
11877
+ options?: {
11878
+ query?: PostMenuV4StationItemsSearchQuery;
11879
+ } & RequestOptions,
11880
+ ): ResponsePromise<PostMenuV4StationItemsSearchResponse> {
11881
+ return this.request(
11882
+ 'menu',
11883
+ '/menu/v4/station/items/search',
11884
+ 'POST',
11885
+ `/menu/v4/station/items/search`,
11886
+ null,
11887
+ options,
11888
+ );
11889
+ }
11890
+
11804
11891
  /**
11805
11892
  * GET /menu/v3/ping
11806
11893
  *
@@ -14669,24 +14756,6 @@ export class ServiceClient extends BaseServiceClient {
14669
14756
  );
14670
14757
  }
14671
14758
 
14672
- /**
14673
- * GET /centricos/discount/all - Get all discounts
14674
- *
14675
- * @param options - additional request options
14676
- */
14677
- get_centricos_discount_all(
14678
- options?: RequestOptions,
14679
- ): ResponsePromise<GetCentricosDiscountAllResponse> {
14680
- return this.request(
14681
- 'centricos',
14682
- '/centricos/discount/all',
14683
- 'GET',
14684
- `/centricos/discount/all`,
14685
- null,
14686
- options,
14687
- );
14688
- }
14689
-
14690
14759
  /**
14691
14760
  * POST /centricos/discount/{id}/active - Set discount active status flag
14692
14761
  *
@@ -130,7 +130,8 @@ export interface Site {
130
130
  id: string;
131
131
  name: string;
132
132
  sector: string;
133
- app: 'thrive' | 'boost';
133
+ // Ordering app name; empty when integration-agnostic (Unlisted)
134
+ app: string;
134
135
  unit_number: string;
135
136
  visible_stations: number;
136
137
  local_menu_group?: LocalMenuGroup[];
@@ -640,19 +641,6 @@ export interface GetDiscountResponseDTO {
640
641
  brands: DiscountEntityDTO[];
641
642
  }
642
643
 
643
- export interface DiscountWithEntitiesDTO {
644
- // The discount information
645
- discount: DiscountDTO;
646
- // The sites associated with the discount
647
- sites: DiscountEntityDTO[];
648
- // The brands associated with the discount
649
- brands: DiscountEntityDTO[];
650
- }
651
-
652
- export interface GetAllDiscountsResponseDTO {
653
- discounts: DiscountWithEntitiesDTO[];
654
- }
655
-
656
644
  export interface PostDiscountActiveRequestDTO {
657
645
  // Set discount active status flag
658
646
  active: boolean;
@@ -1055,10 +1043,6 @@ export interface GetCentricosDiscountPath {
1055
1043
 
1056
1044
  export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
1057
1045
 
1058
- // GET /centricos/discount/all - Get all discounts
1059
-
1060
- export type GetCentricosDiscountAllResponse = GetAllDiscountsResponseDTO;
1061
-
1062
1046
  // POST /centricos/discount/{id}/active - Set discount active status flag
1063
1047
 
1064
1048
  export interface PostDiscountActivePath {
@@ -2040,6 +2040,50 @@ export interface SwappedCategoryDTO {
2040
2040
  sequence?: number;
2041
2041
  }
2042
2042
 
2043
+ export interface FetchMetaDTO {
2044
+ result_count?: number;
2045
+ }
2046
+
2047
+ export interface FetchEntityWithMenusDTO {
2048
+ id?: string;
2049
+ name?: string;
2050
+ menus?: FetchMenuDTO[];
2051
+ }
2052
+
2053
+ export interface FetchMenuDTO {
2054
+ id?: string;
2055
+ name?: string;
2056
+ categories?: FetchCategoryDTO[];
2057
+ }
2058
+
2059
+ export interface FetchCategoryDTO {
2060
+ id?: string;
2061
+ name?: string;
2062
+ }
2063
+
2064
+ export interface FetchEntityWithMenusAndItemsDTO {
2065
+ id?: string;
2066
+ name?: string;
2067
+ menus?: FetchMenuWithItemsDTO[];
2068
+ }
2069
+
2070
+ export interface FetchMenuWithItemsDTO {
2071
+ id?: string;
2072
+ name?: string;
2073
+ categories?: FetchCategoryWithItemsDTO[];
2074
+ }
2075
+
2076
+ export interface FetchCategoryWithItemsDTO {
2077
+ id?: string;
2078
+ name?: string;
2079
+ items?: FetchItemDTO[];
2080
+ }
2081
+
2082
+ export interface FetchItemDTO {
2083
+ id?: string;
2084
+ name?: string;
2085
+ }
2086
+
2043
2087
  export interface PartialItemDTO {
2044
2088
  base_item_id?: string;
2045
2089
  is_published?: boolean;
@@ -2141,6 +2185,43 @@ export interface MenuSizeDTO {
2141
2185
  [index: string]: any;
2142
2186
  }
2143
2187
 
2188
+ export interface FetchStationWithMenusDTO {
2189
+ id?: string;
2190
+ name?: string;
2191
+ menus?: FetchStationMenuDTO[];
2192
+ }
2193
+
2194
+ export interface FetchStationMenuDTO {
2195
+ id?: string;
2196
+ name?: string;
2197
+ categories?: FetchStationCategoryDTO[];
2198
+ }
2199
+
2200
+ export interface FetchStationCategoryDTO {
2201
+ items?: FetchItemDTO[];
2202
+ id?: string;
2203
+ name?: string;
2204
+ [index: string]: any;
2205
+ }
2206
+
2207
+ export interface FetchSiteWithStationsDTO {
2208
+ id?: string;
2209
+ name?: string;
2210
+ stations?: FetchStationDTO[];
2211
+ }
2212
+
2213
+ export interface FetchStationDTO {
2214
+ id?: string;
2215
+ name?: string;
2216
+ menus?: FetchStationItemStationMenuDTO[];
2217
+ }
2218
+
2219
+ export interface FetchStationItemStationMenuDTO {
2220
+ id?: string;
2221
+ name?: string;
2222
+ categories?: FetchCategoryWithItemsDTO[];
2223
+ }
2224
+
2144
2225
  export interface HealthDependencyDTO {
2145
2226
  name: string;
2146
2227
  status: string;
@@ -8761,6 +8842,36 @@ export interface GetMenuV4BrandExportRequest
8761
8842
  RequestQuery<GetMenuV4BrandExportQuery>,
8762
8843
  GetMenuV4BrandExportPath {}
8763
8844
 
8845
+ // POST /menu/v4/brands/fetch
8846
+
8847
+ export interface PostMenuV4BrandsFetchQuery {
8848
+ 'body.brand_ids'?: string[];
8849
+ }
8850
+
8851
+ export interface PostMenuV4BrandsFetchResponse {
8852
+ meta?: FetchMetaDTO;
8853
+ results?: FetchEntityWithMenusDTO[];
8854
+ }
8855
+
8856
+ export interface PostMenuV4BrandsFetchRequest
8857
+ extends BaseRequest,
8858
+ RequestQuery<PostMenuV4BrandsFetchQuery> {}
8859
+
8860
+ // POST /menu/v4/brand/items/search
8861
+
8862
+ export interface PostMenuV4BrandItemsSearchQuery {
8863
+ 'body.brand_ids'?: string[];
8864
+ }
8865
+
8866
+ export interface PostMenuV4BrandItemsSearchResponse {
8867
+ meta?: FetchMetaDTO;
8868
+ menuBrands?: FetchEntityWithMenusAndItemsDTO[];
8869
+ }
8870
+
8871
+ export interface PostMenuV4BrandItemsSearchRequest
8872
+ extends BaseRequest,
8873
+ RequestQuery<PostMenuV4BrandItemsSearchQuery> {}
8874
+
8764
8875
  // POST /menu/v4/item/{id}/attachment/{name}
8765
8876
 
8766
8877
  export interface PostMenuV4ItemAttachmentPath {
@@ -10818,6 +10929,36 @@ export interface GetMenuV4CategoryAttachableItemsRequest
10818
10929
  RequestQuery<GetMenuV4CategoryAttachableItemsQuery>,
10819
10930
  GetMenuV4CategoryAttachableItemsPath {}
10820
10931
 
10932
+ // POST /menu/v4/stations/menus/fetch
10933
+
10934
+ export interface PostMenuV4StationsMenusFetchQuery {
10935
+ 'body.station_ids'?: string[];
10936
+ }
10937
+
10938
+ export interface PostMenuV4StationsMenusFetchResponse {
10939
+ meta?: FetchMetaDTO;
10940
+ results?: FetchStationWithMenusDTO[];
10941
+ }
10942
+
10943
+ export interface PostMenuV4StationsMenusFetchRequest
10944
+ extends BaseRequest,
10945
+ RequestQuery<PostMenuV4StationsMenusFetchQuery> {}
10946
+
10947
+ // POST /menu/v4/station/items/search
10948
+
10949
+ export interface PostMenuV4StationItemsSearchQuery {
10950
+ 'body.station_ids'?: string[];
10951
+ }
10952
+
10953
+ export interface PostMenuV4StationItemsSearchResponse {
10954
+ meta?: FetchMetaDTO;
10955
+ sites?: FetchSiteWithStationsDTO[];
10956
+ }
10957
+
10958
+ export interface PostMenuV4StationItemsSearchRequest
10959
+ extends BaseRequest,
10960
+ RequestQuery<PostMenuV4StationItemsSearchQuery> {}
10961
+
10821
10962
  // GET /menu/v3/ping
10822
10963
 
10823
10964
  export interface GetMenuV3PingResponse {