@compassdigital/sdk.typescript 4.527.0 → 4.528.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.527.0",
3
+ "version": "4.528.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -892,6 +892,9 @@ import {
892
892
  GetMenuV3MenuworksQuery,
893
893
  GetMenuV3MenuworksResponse,
894
894
  GetMenuV3MenuworksBusinessUnitsResponse,
895
+ GetMenuV3MenuworksBusinessUnitsProductsQuery,
896
+ GetMenuV3MenuworksBusinessUnitsProductsResponse,
897
+ PostMenuV3MenuworksBusinessUnitsProductsSyncResponse,
895
898
  GetMenuV3UniversalItemsQuery,
896
899
  GetMenuV3UniversalItemsResponse,
897
900
  PutMenuV3UniversalItemsBody,
@@ -10332,6 +10335,48 @@ export class ServiceClient extends BaseServiceClient {
10332
10335
  );
10333
10336
  }
10334
10337
 
10338
+ /**
10339
+ * GET /menu/v3/menuworks/business_units/{unit_id}/products
10340
+ *
10341
+ * @param unit_id
10342
+ * @param options - additional request options
10343
+ */
10344
+ get_menu_v3_menuworks_business_units_products(
10345
+ unit_id: string,
10346
+ options?: {
10347
+ query?: GetMenuV3MenuworksBusinessUnitsProductsQuery;
10348
+ } & RequestOptions,
10349
+ ): ResponsePromise<GetMenuV3MenuworksBusinessUnitsProductsResponse> {
10350
+ return this.request(
10351
+ 'menu',
10352
+ '/menu/v3/menuworks/business_units/{unit_id}/products',
10353
+ 'GET',
10354
+ `/menu/v3/menuworks/business_units/${unit_id}/products`,
10355
+ null,
10356
+ options,
10357
+ );
10358
+ }
10359
+
10360
+ /**
10361
+ * POST /menu/v3/menuworks/business_units/{unit_id}/products/sync
10362
+ *
10363
+ * @param unit_id
10364
+ * @param options - additional request options
10365
+ */
10366
+ post_menu_v3_menuworks_business_units_products_sync(
10367
+ unit_id: string,
10368
+ options?: RequestOptions,
10369
+ ): ResponsePromise<PostMenuV3MenuworksBusinessUnitsProductsSyncResponse> {
10370
+ return this.request(
10371
+ 'menu',
10372
+ '/menu/v3/menuworks/business_units/{unit_id}/products/sync',
10373
+ 'POST',
10374
+ `/menu/v3/menuworks/business_units/${unit_id}/products/sync`,
10375
+ null,
10376
+ options,
10377
+ );
10378
+ }
10379
+
10335
10380
  /**
10336
10381
  * GET /menu/v3/universal-items
10337
10382
  *
@@ -1937,6 +1937,31 @@ export interface BusinessUnitDTO {
1937
1937
  [index: string]: any;
1938
1938
  }
1939
1939
 
1940
+ export interface MenuWorksProductDTO {
1941
+ mrn: string;
1942
+ product_type?: string;
1943
+ name?: string;
1944
+ short_name?: string;
1945
+ [index: string]: any;
1946
+ }
1947
+
1948
+ export interface ProductsSyncStatusResponseDTO {
1949
+ status: string;
1950
+ items_ingested_count: number;
1951
+ total_available?: number;
1952
+ last_success_at?: string | string;
1953
+ last_failure_at?: string | string;
1954
+ started_at?: string | string;
1955
+ message?: string;
1956
+ [index: string]: any;
1957
+ }
1958
+
1959
+ export interface ConflictErrorDTO {
1960
+ number: number;
1961
+ message: string;
1962
+ [index: string]: any;
1963
+ }
1964
+
1940
1965
  export interface UniversalItemWithoutIdDTO {
1941
1966
  barcode: string;
1942
1967
  name: string;
@@ -7790,6 +7815,54 @@ export interface GetMenuV3MenuworksBusinessUnitsResponse {
7790
7815
 
7791
7816
  export interface GetMenuV3MenuworksBusinessUnitsRequest extends BaseRequest {}
7792
7817
 
7818
+ // GET /menu/v3/menuworks/business_units/{unit_id}/products
7819
+
7820
+ export interface GetMenuV3MenuworksBusinessUnitsProductsPath {
7821
+ unit_id: string;
7822
+ }
7823
+
7824
+ export interface GetMenuV3MenuworksBusinessUnitsProductsQuery {
7825
+ q?: string;
7826
+ // Number of records to load per page
7827
+ limit?: number;
7828
+ page?: number;
7829
+ // If specified, only the selected fields will be returned
7830
+ select?: string[];
7831
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
7832
+ relationships?: string[];
7833
+ // A field to sort the results based on
7834
+ sort_by?: string;
7835
+ sort_order?: 'DESC' | 'ASC';
7836
+ // How soft deleted records should be shown in the list
7837
+ soft_deleted?: 'include' | 'exclude' | 'only';
7838
+ }
7839
+
7840
+ export interface GetMenuV3MenuworksBusinessUnitsProductsResponse {
7841
+ results: MenuWorksProductDTO[];
7842
+ sync_status?: ProductsSyncStatusResponseDTO;
7843
+ meta?: ListResponseMetadataDTO;
7844
+ [index: string]: any;
7845
+ }
7846
+
7847
+ export interface GetMenuV3MenuworksBusinessUnitsProductsRequest
7848
+ extends BaseRequest,
7849
+ RequestQuery<GetMenuV3MenuworksBusinessUnitsProductsQuery>,
7850
+ GetMenuV3MenuworksBusinessUnitsProductsPath {}
7851
+
7852
+ // POST /menu/v3/menuworks/business_units/{unit_id}/products/sync
7853
+
7854
+ export interface PostMenuV3MenuworksBusinessUnitsProductsSyncPath {
7855
+ unit_id: string;
7856
+ }
7857
+
7858
+ export interface PostMenuV3MenuworksBusinessUnitsProductsSyncResponse {
7859
+ triggered?: boolean;
7860
+ }
7861
+
7862
+ export interface PostMenuV3MenuworksBusinessUnitsProductsSyncRequest
7863
+ extends BaseRequest,
7864
+ PostMenuV3MenuworksBusinessUnitsProductsSyncPath {}
7865
+
7793
7866
  // GET /menu/v3/universal-items
7794
7867
 
7795
7868
  export interface GetMenuV3UniversalItemsQuery {