@compassdigital/sdk.typescript 4.191.0 → 4.193.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.191.0",
3
+ "version": "4.193.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -956,6 +956,8 @@ import {
956
956
  DeleteMenuV4ItemResponse,
957
957
  PatchMenuV4ItemsBulkUpdateBody,
958
958
  PatchMenuV4ItemsBulkUpdateResponse,
959
+ PatchMenuV4ItemsBulkPriceUpdateBody,
960
+ PatchMenuV4ItemsBulkPriceUpdateResponse,
959
961
  PostMenuV4ItemDuplicateBody,
960
962
  PostMenuV4ItemDuplicateResponse,
961
963
  DeleteMenuV4ItemModifierGroupsDetachBody,
@@ -10484,6 +10486,26 @@ export class ServiceClient extends BaseServiceClient {
10484
10486
  );
10485
10487
  }
10486
10488
 
10489
+ /**
10490
+ * PATCH /menu/v4/items/bulk-price-update
10491
+ *
10492
+ * @param body
10493
+ * @param options - additional request options
10494
+ */
10495
+ patch_menu_v4_items_bulk_price_update(
10496
+ body: PatchMenuV4ItemsBulkPriceUpdateBody,
10497
+ options?: RequestOptions,
10498
+ ): ResponsePromise<PatchMenuV4ItemsBulkPriceUpdateResponse> {
10499
+ return this.request(
10500
+ 'menu',
10501
+ '/menu/v4/items/bulk-price-update',
10502
+ 'PATCH',
10503
+ `/menu/v4/items/bulk-price-update`,
10504
+ body,
10505
+ options,
10506
+ );
10507
+ }
10508
+
10487
10509
  /**
10488
10510
  * POST /menu/v4/item/{id}/duplicate
10489
10511
  *
@@ -12341,7 +12363,7 @@ export class ServiceClient extends BaseServiceClient {
12341
12363
  /**
12342
12364
  * PATCH /consumer/order/{id}/cancel - Cancel an existing order
12343
12365
  *
12344
- * @param id - TODO: add parameter to swagger.json
12366
+ * @param id - a valid CDL user id
12345
12367
  * @param body
12346
12368
  * @param options - additional request options
12347
12369
  */
@@ -299,7 +299,7 @@ export interface PatchCatalogItemsBulkPath {
299
299
  export type PatchCatalogItemsBulkBody = {
300
300
  id?: number;
301
301
  catalog_id?: number;
302
- item_id?: number | null;
302
+ item_id?: string | null;
303
303
  name?: string | null;
304
304
  label?: string | null;
305
305
  description?: string | null;
@@ -899,9 +899,9 @@ export interface PlacedOrderMeta {
899
899
  export interface PostOrderResponseDTO {
900
900
  // Order ID
901
901
  id?: string;
902
- // Brand/location ID
902
+ // Brand/Station ID
903
903
  location_brand?: string;
904
- // Location ID
904
+ // Location/Site ID - only present for marketplace
905
905
  location?: string;
906
906
  // Shopping cart ID
907
907
  shoppingcart?: string;
@@ -967,9 +967,9 @@ export interface PatchOrderCancelBodyDTO {
967
967
  export interface PatchOrderCancelResponseDTO {
968
968
  // Order ID
969
969
  id?: string;
970
- // Brand/location ID
970
+ // Brand/Station ID
971
971
  location_brand?: string;
972
- // Location ID
972
+ // Location/Site ID - only present for marketplace
973
973
  location?: string;
974
974
  // Shopping cart ID
975
975
  shoppingcart?: string;
@@ -2266,9 +2266,9 @@ export interface GetConsumerAppConfigResponse {
2266
2266
  export interface PatchCheckinOrderResponseDTO {
2267
2267
  // Order ID
2268
2268
  id?: string;
2269
- // Brand/location ID
2269
+ // Brand/Station ID
2270
2270
  location_brand?: string;
2271
- // Location ID
2271
+ // Location/Site ID - only present for marketplace
2272
2272
  location?: string;
2273
2273
  // Shopping cart ID
2274
2274
  shoppingcart?: string;
@@ -2392,7 +2392,7 @@ export type PostConsumerOrderResponse = PostOrderResponseDTO;
2392
2392
  // PATCH /consumer/order/{id}/cancel - Cancel an existing order
2393
2393
 
2394
2394
  export interface PatchConsumerOrderCancelPath {
2395
- // TODO: add parameter to swagger.json
2395
+ // a valid CDL user id
2396
2396
  id: string;
2397
2397
  }
2398
2398
 
@@ -8854,6 +8854,65 @@ export interface PatchMenuV4ItemsBulkUpdateRequest extends BaseRequest {
8854
8854
  body: PatchMenuV4ItemsBulkUpdateBody;
8855
8855
  }
8856
8856
 
8857
+ // PATCH /menu/v4/items/bulk-price-update
8858
+
8859
+ export interface PatchMenuV4ItemsBulkPriceUpdateBody {
8860
+ id_list: string[];
8861
+ price_flat_adjustment_amount?: number;
8862
+ price_percentage_adjustment?: number;
8863
+ is_published?: boolean;
8864
+ parent?: DraftItemDTO;
8865
+ children?: DraftItemDTO[];
8866
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8867
+ cpg_item?: UniversalItemDTO;
8868
+ stocks?: StockDTO[];
8869
+ id?: string;
8870
+ parent_id?: string;
8871
+ name?: string;
8872
+ name_on_receipt?: string;
8873
+ name_on_kds?: string;
8874
+ label?: string;
8875
+ description?: string;
8876
+ reporting?: ReportingMetadataDTO;
8877
+ price?: number;
8878
+ barcode?: string;
8879
+ calories?: number;
8880
+ meal_value?: number;
8881
+ is_active?: boolean;
8882
+ posid?: string;
8883
+ tax_tags?: string[];
8884
+ brand_id?: string;
8885
+ line_route?: string;
8886
+ posid_segment?: number;
8887
+ menu_works?: MenuWorksDTO;
8888
+ is_out_of_stock?: boolean;
8889
+ tax_tag_code?: string;
8890
+ tags?: string[];
8891
+ is_featured?: boolean;
8892
+ tax_jwo_code?: string;
8893
+ unique_id?: number;
8894
+ cpg_item_id?: string;
8895
+ price_levels?: Record<string, any>;
8896
+ translation?: Record<string, any>;
8897
+ applied_diff_snapshot?: Record<string, any>;
8898
+ brand?: DraftBrandDTO;
8899
+ categories?: DraftCategoryToItemRelationshipDTO[];
8900
+ changes?: ItemChangeDTO[];
8901
+ vendor_metadata?: VendorMetadataDTO[];
8902
+ attachments?: FileAttachmentsDTO;
8903
+ weight?: WeightDTO;
8904
+ permissions?: Record<string, any>;
8905
+ [index: string]: any;
8906
+ }
8907
+
8908
+ export interface PatchMenuV4ItemsBulkPriceUpdateResponse {
8909
+ results?: DraftItemEntityDTO[];
8910
+ }
8911
+
8912
+ export interface PatchMenuV4ItemsBulkPriceUpdateRequest extends BaseRequest {
8913
+ body: PatchMenuV4ItemsBulkPriceUpdateBody;
8914
+ }
8915
+
8857
8916
  // POST /menu/v4/item/{id}/duplicate
8858
8917
 
8859
8918
  export interface PostMenuV4ItemDuplicatePath {