@compassdigital/sdk.typescript 4.684.0 → 4.687.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/manifest.json CHANGED
@@ -171,6 +171,10 @@
171
171
  "options": {
172
172
  "request": false
173
173
  }
174
+ },
175
+ {
176
+ "name": "delivery",
177
+ "swagger": "../../api/platform2/delivery/swagger.json"
174
178
  }
175
179
  ]
176
180
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.684.0",
3
+ "version": "4.687.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/pipeline.yml CHANGED
@@ -2,7 +2,6 @@ name: npm-typescript-sdk
2
2
 
3
3
  flags:
4
4
  - DEPENDABOT
5
- - P4_V2_TOOLS
6
5
 
7
6
  test:
8
7
  commands:
package/src/index.ts CHANGED
@@ -941,6 +941,7 @@ import {
941
941
  PatchMenuV4BrandResponse,
942
942
  DeleteMenuV4BrandResponse,
943
943
  GetMenuV4BrandStatusesResponse,
944
+ GetMenuV4BrandParentResponse,
944
945
  PostMenuV4BrandAttachmentQuery,
945
946
  PostMenuV4BrandAttachmentResponse,
946
947
  PostMenuV4BrandMenuBody,
@@ -1380,6 +1381,8 @@ import {
1380
1381
  GetCentricosDiscountResponse,
1381
1382
  GetCentricosDiscountsQuery,
1382
1383
  GetCentricosDiscountsResponse,
1384
+ GetCentricosDiscountsSitesQuery,
1385
+ GetCentricosDiscountsSitesResponse,
1383
1386
  GetRecommendationsBySiteResponse,
1384
1387
  GetDescriptionRecommendationsQuery,
1385
1388
  GetDescriptionRecommendationsResponse,
@@ -1582,6 +1585,8 @@ import {
1582
1585
  GetForecastingHealthResponse,
1583
1586
  } from './interface/forecasting';
1584
1587
 
1588
+ import { GetDeliveryHealthResponse } from './interface/delivery';
1589
+
1585
1590
  import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
1586
1591
  export * from './base';
1587
1592
 
@@ -11042,6 +11047,26 @@ export class ServiceClient extends BaseServiceClient {
11042
11047
  );
11043
11048
  }
11044
11049
 
11050
+ /**
11051
+ * GET /menu/v4/brand/{id}/parent
11052
+ *
11053
+ * @param id
11054
+ * @param options - additional request options
11055
+ */
11056
+ get_menu_v4_brand_parent(
11057
+ id: string,
11058
+ options?: RequestOptions,
11059
+ ): ResponsePromise<GetMenuV4BrandParentResponse> {
11060
+ return this.request(
11061
+ 'menu',
11062
+ '/menu/v4/brand/{id}/parent',
11063
+ 'GET',
11064
+ `/menu/v4/brand/${id}/parent`,
11065
+ null,
11066
+ options,
11067
+ );
11068
+ }
11069
+
11045
11070
  /**
11046
11071
  * POST /menu/v4/brand/{id}/attachment/{name}
11047
11072
  *
@@ -15977,6 +16002,26 @@ export class ServiceClient extends BaseServiceClient {
15977
16002
  );
15978
16003
  }
15979
16004
 
16005
+ /**
16006
+ * GET /centricos/discounts/sites - Get sites (id and name only) for the discount site picker
16007
+ *
16008
+ * @param options - additional request options
16009
+ */
16010
+ get_centricos_discounts_sites(
16011
+ options: {
16012
+ query: GetCentricosDiscountsSitesQuery;
16013
+ } & RequestOptions,
16014
+ ): ResponsePromise<GetCentricosDiscountsSitesResponse> {
16015
+ return this.request(
16016
+ 'centricos',
16017
+ '/centricos/discounts/sites',
16018
+ 'GET',
16019
+ `/centricos/discounts/sites`,
16020
+ null,
16021
+ options,
16022
+ );
16023
+ }
16024
+
15980
16025
  /**
15981
16026
  * GET /centricos/recommendations/{siteId} - Get recommendations by site
15982
16027
  *
@@ -17954,4 +17999,20 @@ export class ServiceClient extends BaseServiceClient {
17954
17999
  options,
17955
18000
  );
17956
18001
  }
18002
+
18003
+ /**
18004
+ * GET /delivery/health - Delivery service readiness check
18005
+ *
18006
+ * @param options - additional request options
18007
+ */
18008
+ get_delivery_health(options?: RequestOptions): ResponsePromise<GetDeliveryHealthResponse> {
18009
+ return this.request(
18010
+ 'delivery',
18011
+ '/delivery/health',
18012
+ 'GET',
18013
+ `/delivery/health`,
18014
+ null,
18015
+ options,
18016
+ );
18017
+ }
17957
18018
  }
@@ -816,6 +816,16 @@ export interface GetDiscountsResponseDTO {
816
816
  meta: MetaResultsDTO;
817
817
  }
818
818
 
819
+ export interface DiscountSiteDTO {
820
+ id: string;
821
+ name: string;
822
+ }
823
+
824
+ export interface GetDiscountSitesResponseDTO {
825
+ meta: PageMetadata;
826
+ results: DiscountSiteDTO[];
827
+ }
828
+
819
829
  export interface VisualDataset {
820
830
  // Label for the dataset
821
831
  label: string;
@@ -1528,6 +1538,22 @@ export interface GetCentricosDiscountsQuery {
1528
1538
 
1529
1539
  export type GetCentricosDiscountsResponse = GetDiscountsResponseDTO;
1530
1540
 
1541
+ // GET /centricos/discounts/sites - Get sites (id and name only) for the discount site picker
1542
+
1543
+ export interface GetCentricosDiscountsSitesQuery {
1544
+ id_multigroups?: string[];
1545
+ filter?: string;
1546
+ limit: number;
1547
+ page: number;
1548
+ sortOrder: string;
1549
+ sortBy?: string;
1550
+ sector_name?: string;
1551
+ // Site statuses. Use repeated query params. Allowed values: active, inactive, archived.
1552
+ status?: string[];
1553
+ }
1554
+
1555
+ export type GetCentricosDiscountsSitesResponse = GetDiscountSitesResponseDTO;
1556
+
1531
1557
  // GET /centricos/recommendations/{siteId} - Get recommendations by site
1532
1558
 
1533
1559
  export interface GetRecommendationsBySitePath {
@@ -0,0 +1,53 @@
1
+ /* eslint-disable */
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+
4
+ import { RequestQuery, BaseRequest } from './util';
5
+
6
+ export interface HealthMetadataDto {
7
+ // Service name
8
+ service: string;
9
+ // AWS region
10
+ region?: string;
11
+ }
12
+
13
+ export interface HealthResponseDto {
14
+ // Health status
15
+ status: string;
16
+ // ISO timestamp of the health check
17
+ timestamp: string;
18
+ // Deployed git SHA or service version
19
+ version: string;
20
+ metadata: HealthMetadataDto;
21
+ }
22
+
23
+ export interface ErrorDisplayMessage {
24
+ // user message title
25
+ title: string;
26
+ // user message description
27
+ description: string;
28
+ }
29
+
30
+ export interface ErrorData {
31
+ // http status code
32
+ statusCode: number;
33
+ // http status text
34
+ statusText: string;
35
+ timestamp: string;
36
+ // user friendly error message
37
+ displayMessage: ErrorDisplayMessage;
38
+ }
39
+
40
+ export interface Error {
41
+ // business error code
42
+ code: number;
43
+ // business error description
44
+ message: string;
45
+ // additional error data
46
+ data: ErrorData;
47
+ }
48
+
49
+ // GET /delivery/health - Delivery service readiness check
50
+
51
+ export type GetDeliveryHealthResponse = HealthResponseDto;
52
+
53
+ export interface GetDeliveryHealthRequest extends BaseRequest {}
@@ -8464,6 +8464,26 @@ export interface GetMenuV4BrandStatusesResponse {
8464
8464
 
8465
8465
  export interface GetMenuV4BrandStatusesRequest extends BaseRequest, GetMenuV4BrandStatusesPath {}
8466
8466
 
8467
+ // GET /menu/v4/brand/{id}/parent
8468
+
8469
+ export interface GetMenuV4BrandParentPath {
8470
+ id: string;
8471
+ }
8472
+
8473
+ export interface GetMenuV4BrandParentResponse {
8474
+ id: string;
8475
+ name: string;
8476
+ parent_id?: string;
8477
+ global_menu_group_id?: string;
8478
+ frictionless_partner?: string;
8479
+ meta?: BrandMeta;
8480
+ archived_at?: string;
8481
+ attachments?: FileAttachmentsDTO;
8482
+ [index: string]: any;
8483
+ }
8484
+
8485
+ export interface GetMenuV4BrandParentRequest extends BaseRequest, GetMenuV4BrandParentPath {}
8486
+
8467
8487
  // POST /menu/v4/brand/{id}/attachment/{name}
8468
8488
 
8469
8489
  export interface PostMenuV4BrandAttachmentPath {