@compassdigital/sdk.typescript 4.501.0 → 4.503.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/lib/index.d.ts +5 -5
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +3 -3
- package/lib/index.js.map +1 -1
- package/lib/interface/consumer.d.ts +3 -3
- package/lib/interface/consumer.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +12 -2
- package/lib/interface/menu.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +10 -10
- package/src/interface/consumer.ts +4 -4
- package/src/interface/location.ts +2 -2
- package/src/interface/menu.ts +16 -4
- package/src/interface/order.ts +5 -5
- package/src/interface/task.ts +2 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@compassdigital/sdk.typescript",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.503.0",
|
|
4
4
|
"description": "Compass Digital Labs TypeScript SDK",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "./lib/index.js",
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
60
|
"@compassdigital/review": "^7.6.3",
|
|
61
|
-
"@compassdigital/sdk.typescript.cli": "^4.
|
|
61
|
+
"@compassdigital/sdk.typescript.cli": "^4.57.0",
|
|
62
62
|
"@swc/core": "^1.4.1",
|
|
63
63
|
"@swc/jest": "^0.2.36",
|
|
64
64
|
"@types/jest": "^30.0.0",
|
package/src/index.ts
CHANGED
|
@@ -1246,9 +1246,9 @@ import {
|
|
|
1246
1246
|
PostConsumerCustomerRewardsBody,
|
|
1247
1247
|
PostConsumerCustomerRewardsResponse,
|
|
1248
1248
|
PostConsumerSendEmailVerificationResponse,
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1249
|
+
PostConsumerUserCreateQuery,
|
|
1250
|
+
PostConsumerUserCreateBody,
|
|
1251
|
+
PostConsumerUserCreateResponse,
|
|
1252
1252
|
PostConsumerUserGuestTokenBody,
|
|
1253
1253
|
PostConsumerUserGuestTokenResponse$0,
|
|
1254
1254
|
PostConsumerUserGuestBody,
|
|
@@ -14259,22 +14259,22 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
14259
14259
|
}
|
|
14260
14260
|
|
|
14261
14261
|
/**
|
|
14262
|
-
* POST /consumer/user/
|
|
14262
|
+
* POST /consumer/user/create - Create a new user with captcha
|
|
14263
14263
|
*
|
|
14264
14264
|
* @param body
|
|
14265
14265
|
* @param options - additional request options
|
|
14266
14266
|
*/
|
|
14267
|
-
|
|
14268
|
-
body:
|
|
14267
|
+
post_consumer_user_create(
|
|
14268
|
+
body: PostConsumerUserCreateBody,
|
|
14269
14269
|
options: {
|
|
14270
|
-
query:
|
|
14270
|
+
query: PostConsumerUserCreateQuery;
|
|
14271
14271
|
} & RequestOptions,
|
|
14272
|
-
): ResponsePromise<
|
|
14272
|
+
): ResponsePromise<PostConsumerUserCreateResponse> {
|
|
14273
14273
|
return this.request(
|
|
14274
14274
|
'consumer',
|
|
14275
|
-
'/consumer/user/
|
|
14275
|
+
'/consumer/user/create',
|
|
14276
14276
|
'POST',
|
|
14277
|
-
`/consumer/user/
|
|
14277
|
+
`/consumer/user/create`,
|
|
14278
14278
|
body,
|
|
14279
14279
|
options,
|
|
14280
14280
|
);
|
|
@@ -4149,16 +4149,16 @@ export interface PostConsumerSendEmailVerificationPath {
|
|
|
4149
4149
|
|
|
4150
4150
|
export type PostConsumerSendEmailVerificationResponse = PostConsumerUserVerificationResponse;
|
|
4151
4151
|
|
|
4152
|
-
// POST /consumer/user/
|
|
4152
|
+
// POST /consumer/user/create - Create a new user with captcha
|
|
4153
4153
|
|
|
4154
|
-
export interface
|
|
4154
|
+
export interface PostConsumerUserCreateQuery {
|
|
4155
4155
|
// The captcha response key
|
|
4156
4156
|
captchaResponseKey: string;
|
|
4157
4157
|
}
|
|
4158
4158
|
|
|
4159
|
-
export type
|
|
4159
|
+
export type PostConsumerUserCreateBody = PostConsumerUserCaptchaRequest;
|
|
4160
4160
|
|
|
4161
|
-
export type
|
|
4161
|
+
export type PostConsumerUserCreateResponse = PostConsumerUserCaptchaResponse;
|
|
4162
4162
|
|
|
4163
4163
|
// POST /consumer/user/guest/token - Post user guest token
|
|
4164
4164
|
|
|
@@ -1200,7 +1200,7 @@ export interface GetLocationBrandQuery {
|
|
|
1200
1200
|
extended?: boolean;
|
|
1201
1201
|
// determine whether to calculate estimated_wait_time
|
|
1202
1202
|
include_estimated_wait_time?: boolean;
|
|
1203
|
-
//
|
|
1203
|
+
// @deprecated
|
|
1204
1204
|
_query?: string;
|
|
1205
1205
|
nocache?: boolean;
|
|
1206
1206
|
}
|
|
@@ -1451,7 +1451,7 @@ export interface GetLocationMenuAssociationMenuPath {
|
|
|
1451
1451
|
}
|
|
1452
1452
|
|
|
1453
1453
|
export interface GetLocationMenuAssociationMenuQuery {
|
|
1454
|
-
//
|
|
1454
|
+
// @deprecated
|
|
1455
1455
|
_query?: string;
|
|
1456
1456
|
}
|
|
1457
1457
|
|
package/src/interface/menu.ts
CHANGED
|
@@ -2090,6 +2090,12 @@ export interface FetchBrandItemsCategoryRequestDTO {
|
|
|
2090
2090
|
[index: string]: any;
|
|
2091
2091
|
}
|
|
2092
2092
|
|
|
2093
|
+
export interface FetchBrandItemsMetaDTO {
|
|
2094
|
+
result_count: number;
|
|
2095
|
+
exceeds_item_cap: boolean;
|
|
2096
|
+
[index: string]: any;
|
|
2097
|
+
}
|
|
2098
|
+
|
|
2093
2099
|
export interface FetchEntityWithMenusAndItemsDTO {
|
|
2094
2100
|
id: string;
|
|
2095
2101
|
name: string;
|
|
@@ -2264,6 +2270,12 @@ export interface FetchStationItemsSearchCategoryRequestDTO {
|
|
|
2264
2270
|
[index: string]: any;
|
|
2265
2271
|
}
|
|
2266
2272
|
|
|
2273
|
+
export interface FetchStationItemsMetaDTO {
|
|
2274
|
+
result_count: number;
|
|
2275
|
+
exceeds_item_cap: boolean;
|
|
2276
|
+
[index: string]: any;
|
|
2277
|
+
}
|
|
2278
|
+
|
|
2267
2279
|
export interface FetchSiteWithStationsDTO {
|
|
2268
2280
|
id: string;
|
|
2269
2281
|
name: string;
|
|
@@ -2354,7 +2366,7 @@ export interface GetMenuQuery {
|
|
|
2354
2366
|
include_items_with_weight?: boolean;
|
|
2355
2367
|
// Show out of stock entities, lower in priority to hidden and disabled
|
|
2356
2368
|
show_out_of_stock?: boolean;
|
|
2357
|
-
//
|
|
2369
|
+
// @deprecated
|
|
2358
2370
|
_query?: string;
|
|
2359
2371
|
nocache?: boolean;
|
|
2360
2372
|
}
|
|
@@ -2413,7 +2425,7 @@ export interface PatchMenuPath {
|
|
|
2413
2425
|
}
|
|
2414
2426
|
|
|
2415
2427
|
export interface PatchMenuQuery {
|
|
2416
|
-
//
|
|
2428
|
+
// @deprecated
|
|
2417
2429
|
_query?: string;
|
|
2418
2430
|
}
|
|
2419
2431
|
|
|
@@ -9007,7 +9019,7 @@ export interface PostMenuV4BrandItemsSearchBody {
|
|
|
9007
9019
|
}
|
|
9008
9020
|
|
|
9009
9021
|
export interface PostMenuV4BrandItemsSearchResponse {
|
|
9010
|
-
meta:
|
|
9022
|
+
meta: FetchBrandItemsMetaDTO;
|
|
9011
9023
|
results: FetchEntityWithMenusAndItemsDTO[];
|
|
9012
9024
|
[index: string]: any;
|
|
9013
9025
|
}
|
|
@@ -11099,7 +11111,7 @@ export interface PostMenuV4StationItemsSearchBody {
|
|
|
11099
11111
|
}
|
|
11100
11112
|
|
|
11101
11113
|
export interface PostMenuV4StationItemsSearchResponse {
|
|
11102
|
-
meta:
|
|
11114
|
+
meta: FetchStationItemsMetaDTO;
|
|
11103
11115
|
results: FetchSiteWithStationsDTO[];
|
|
11104
11116
|
[index: string]: any;
|
|
11105
11117
|
}
|
package/src/interface/order.ts
CHANGED
|
@@ -496,7 +496,7 @@ export interface OrderDiscount {
|
|
|
496
496
|
export interface PostOrderQuery {
|
|
497
497
|
// The language of the user ex en, fr
|
|
498
498
|
lang?: string;
|
|
499
|
-
//
|
|
499
|
+
// @deprecated
|
|
500
500
|
_query?: string;
|
|
501
501
|
}
|
|
502
502
|
|
|
@@ -531,7 +531,7 @@ export interface GetOrderPath {
|
|
|
531
531
|
}
|
|
532
532
|
|
|
533
533
|
export interface GetOrderQuery {
|
|
534
|
-
//
|
|
534
|
+
// @deprecated
|
|
535
535
|
_query?: string;
|
|
536
536
|
}
|
|
537
537
|
|
|
@@ -634,7 +634,7 @@ export interface GetOrderCustomerOrdersQuery {
|
|
|
634
634
|
active?: boolean;
|
|
635
635
|
// Filter orders by eligible for reorder.
|
|
636
636
|
reorder_eligible?: boolean;
|
|
637
|
-
//
|
|
637
|
+
// @deprecated
|
|
638
638
|
_query?: string;
|
|
639
639
|
}
|
|
640
640
|
|
|
@@ -688,7 +688,7 @@ export interface GetOrderLocationBrandQuery {
|
|
|
688
688
|
all_statuses?: boolean;
|
|
689
689
|
// return orders with specific statuses. Comma separated list of status:value pairs. Example: ready:true,cancelled:true - will return orders that are ready or cancelled
|
|
690
690
|
status?: string;
|
|
691
|
-
//
|
|
691
|
+
// @deprecated
|
|
692
692
|
_query?: string;
|
|
693
693
|
}
|
|
694
694
|
|
|
@@ -750,7 +750,7 @@ export interface GetOrderGroupOrdersQuery {
|
|
|
750
750
|
brand?: string;
|
|
751
751
|
// show additional hidden properties/entities
|
|
752
752
|
extended?: boolean;
|
|
753
|
-
//
|
|
753
|
+
// @deprecated
|
|
754
754
|
_query?: string;
|
|
755
755
|
}
|
|
756
756
|
|
package/src/interface/task.ts
CHANGED
|
@@ -208,7 +208,7 @@ export interface GetTaskOrderPath {
|
|
|
208
208
|
}
|
|
209
209
|
|
|
210
210
|
export interface GetTaskOrderQuery {
|
|
211
|
-
//
|
|
211
|
+
// @deprecated
|
|
212
212
|
_query?: string;
|
|
213
213
|
}
|
|
214
214
|
|
|
@@ -294,7 +294,7 @@ export interface GetTaskLocationBrandQuery {
|
|
|
294
294
|
pickup_time?: number;
|
|
295
295
|
// The type of task that will be searched on. The default is: 'bolter'
|
|
296
296
|
query_type?: string;
|
|
297
|
-
//
|
|
297
|
+
// @deprecated
|
|
298
298
|
_query?: string;
|
|
299
299
|
}
|
|
300
300
|
|