@compassdigital/sdk.typescript 3.76.0 → 3.77.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 +68 -60
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +72 -67
- package/lib/index.js.map +1 -1
- package/lib/interface/frictionless.d.ts +97 -0
- package/lib/interface/frictionless.d.ts.map +1 -0
- package/lib/interface/frictionless.js +5 -0
- package/lib/interface/frictionless.js.map +1 -0
- package/lib/interface/location.d.ts +29 -86
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +141 -14
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/payment.d.ts +30 -0
- package/lib/interface/payment.d.ts.map +1 -1
- package/lib/interface/payment.js +1 -1
- package/lib/interface/payment.js.map +1 -1
- package/manifest.json +5 -1
- package/package.json +2 -2
- package/sonar-project.properties +3 -1
- package/src/index.ts +187 -165
- package/src/interface/frictionless.ts +161 -0
- package/src/interface/location.ts +55 -155
- package/src/interface/menu.ts +145 -14
- package/src/interface/payment.ts +32 -1
|
@@ -3,15 +3,6 @@
|
|
|
3
3
|
|
|
4
4
|
import { RequestQuery, BaseRequest } from "./util";
|
|
5
5
|
|
|
6
|
-
export interface POS {
|
|
7
|
-
// pos
|
|
8
|
-
id?: string;
|
|
9
|
-
type?: string;
|
|
10
|
-
meta?: {
|
|
11
|
-
[index: string]: any;
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
|
|
15
6
|
export interface MenuHours {
|
|
16
7
|
// menu
|
|
17
8
|
id?: string;
|
|
@@ -205,23 +196,6 @@ export interface Brand {
|
|
|
205
196
|
[index: string]: any;
|
|
206
197
|
}
|
|
207
198
|
|
|
208
|
-
export interface BrandDocument {
|
|
209
|
-
// CDL id
|
|
210
|
-
id?: string;
|
|
211
|
-
type?: string;
|
|
212
|
-
url?: string;
|
|
213
|
-
is_archived?: boolean;
|
|
214
|
-
// UTC timestamp
|
|
215
|
-
upload_date?: number;
|
|
216
|
-
name?: string;
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
export type BrandDocuments = BrandDocument[];
|
|
220
|
-
|
|
221
|
-
export interface BrandDocumentsResponse {
|
|
222
|
-
documents?: BrandDocuments;
|
|
223
|
-
}
|
|
224
|
-
|
|
225
199
|
export type Brands = Brand[];
|
|
226
200
|
|
|
227
201
|
export interface Location {
|
|
@@ -455,6 +429,23 @@ export interface WaitTime {
|
|
|
455
429
|
|
|
456
430
|
export type BrandOrMenuState = string;
|
|
457
431
|
|
|
432
|
+
export interface MenuAssociations {
|
|
433
|
+
menu_associations?: MenuAssociation[];
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
export interface MenuAssociation {
|
|
437
|
+
// CDL id
|
|
438
|
+
id?: string;
|
|
439
|
+
// CDL id
|
|
440
|
+
brand?: string;
|
|
441
|
+
// CDL id
|
|
442
|
+
menu?: string;
|
|
443
|
+
// CDL id
|
|
444
|
+
group?: string;
|
|
445
|
+
created?: string;
|
|
446
|
+
[index: string]: any;
|
|
447
|
+
}
|
|
448
|
+
|
|
458
449
|
// POST /location - Create a new location
|
|
459
450
|
|
|
460
451
|
export type PostLocationBody = Location;
|
|
@@ -569,40 +560,6 @@ export interface PatchLocationRequest extends BaseRequest, PatchLocationPath {
|
|
|
569
560
|
body: PatchLocationBody;
|
|
570
561
|
}
|
|
571
562
|
|
|
572
|
-
// GET /location/pos/{id} - Get information about a POS
|
|
573
|
-
|
|
574
|
-
export interface GetLocationPosPath {
|
|
575
|
-
// POS ID
|
|
576
|
-
id: string;
|
|
577
|
-
}
|
|
578
|
-
|
|
579
|
-
export interface GetLocationPosQuery {
|
|
580
|
-
// Graphql query string
|
|
581
|
-
_query?: string;
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
export type GetLocationPosResponse = POS;
|
|
585
|
-
|
|
586
|
-
export interface GetLocationPosRequest
|
|
587
|
-
extends BaseRequest,
|
|
588
|
-
RequestQuery<GetLocationPosQuery>,
|
|
589
|
-
GetLocationPosPath {}
|
|
590
|
-
|
|
591
|
-
// PUT /location/pos/{id} - Set information about a POS
|
|
592
|
-
|
|
593
|
-
export interface PutLocationPosPath {
|
|
594
|
-
// POS ID
|
|
595
|
-
id: string;
|
|
596
|
-
}
|
|
597
|
-
|
|
598
|
-
export type PutLocationPosBody = POS;
|
|
599
|
-
|
|
600
|
-
export type PutLocationPosResponse = POS;
|
|
601
|
-
|
|
602
|
-
export interface PutLocationPosRequest extends BaseRequest, PutLocationPosPath {
|
|
603
|
-
body: PutLocationPosBody;
|
|
604
|
-
}
|
|
605
|
-
|
|
606
563
|
// GET /location/multigroup - Get all the top level multigroups
|
|
607
564
|
|
|
608
565
|
export interface GetLocationMultigroupsQuery {
|
|
@@ -933,30 +890,6 @@ export interface GetLocationGroupDeliverydestinationRequest
|
|
|
933
890
|
RequestQuery<GetLocationGroupDeliverydestinationQuery>,
|
|
934
891
|
GetLocationGroupDeliverydestinationPath {}
|
|
935
892
|
|
|
936
|
-
// GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
|
|
937
|
-
|
|
938
|
-
export interface GetLocationUserGroupPath {
|
|
939
|
-
// group
|
|
940
|
-
id: string;
|
|
941
|
-
// user
|
|
942
|
-
user_id: string;
|
|
943
|
-
}
|
|
944
|
-
|
|
945
|
-
export interface GetLocationUserGroupQuery {
|
|
946
|
-
latitude?: number;
|
|
947
|
-
longitude?: number;
|
|
948
|
-
// Graphql query string
|
|
949
|
-
_query?: string;
|
|
950
|
-
nocache?: boolean;
|
|
951
|
-
}
|
|
952
|
-
|
|
953
|
-
export type GetLocationUserGroupResponse = Group;
|
|
954
|
-
|
|
955
|
-
export interface GetLocationUserGroupRequest
|
|
956
|
-
extends BaseRequest,
|
|
957
|
-
RequestQuery<GetLocationUserGroupQuery>,
|
|
958
|
-
GetLocationUserGroupPath {}
|
|
959
|
-
|
|
960
893
|
// GET /location/brands - Get all location brands
|
|
961
894
|
|
|
962
895
|
export interface GetLocationBrandsQuery {
|
|
@@ -991,77 +924,6 @@ export interface GetLocationBrandDestinationsRequest
|
|
|
991
924
|
RequestQuery<GetLocationBrandDestinationsQuery>,
|
|
992
925
|
GetLocationBrandDestinationsPath {}
|
|
993
926
|
|
|
994
|
-
// POST /location/brand/{id}/document - Attach document to a brand
|
|
995
|
-
|
|
996
|
-
export interface PostLocationBrandDocumentPath {
|
|
997
|
-
// Brand ID
|
|
998
|
-
id: string;
|
|
999
|
-
}
|
|
1000
|
-
|
|
1001
|
-
export interface PostLocationBrandDocumentBody {
|
|
1002
|
-
document_name?: string;
|
|
1003
|
-
document_type?: string;
|
|
1004
|
-
// base64 string
|
|
1005
|
-
document?: string;
|
|
1006
|
-
}
|
|
1007
|
-
|
|
1008
|
-
export type PostLocationBrandDocumentResponse = BrandDocumentsResponse;
|
|
1009
|
-
|
|
1010
|
-
export interface PostLocationBrandDocumentRequest
|
|
1011
|
-
extends BaseRequest,
|
|
1012
|
-
PostLocationBrandDocumentPath {
|
|
1013
|
-
body: PostLocationBrandDocumentBody;
|
|
1014
|
-
}
|
|
1015
|
-
|
|
1016
|
-
// PATCH /location/brand/{id}/document - Edit location document
|
|
1017
|
-
|
|
1018
|
-
export interface PatchLocationBrandDocumentPath {
|
|
1019
|
-
// Brand ID
|
|
1020
|
-
id: string;
|
|
1021
|
-
}
|
|
1022
|
-
|
|
1023
|
-
export interface PatchLocationBrandDocumentResponse {
|
|
1024
|
-
document?: BrandDocument;
|
|
1025
|
-
}
|
|
1026
|
-
|
|
1027
|
-
export interface PatchLocationBrandDocumentRequest
|
|
1028
|
-
extends BaseRequest,
|
|
1029
|
-
PatchLocationBrandDocumentPath {}
|
|
1030
|
-
|
|
1031
|
-
// DELETE /location/brand/{id}/document - Deleted brand document
|
|
1032
|
-
|
|
1033
|
-
export interface DeleteLocationBrandDocumentPath {
|
|
1034
|
-
// Brand ID
|
|
1035
|
-
id: string;
|
|
1036
|
-
}
|
|
1037
|
-
|
|
1038
|
-
export interface DeleteLocationBrandDocumentResponse {
|
|
1039
|
-
deleted_document?: BrandDocument;
|
|
1040
|
-
}
|
|
1041
|
-
|
|
1042
|
-
export interface DeleteLocationBrandDocumentRequest
|
|
1043
|
-
extends BaseRequest,
|
|
1044
|
-
DeleteLocationBrandDocumentPath {}
|
|
1045
|
-
|
|
1046
|
-
// GET /location/brand/{id}/documents - Get location brand attached documents
|
|
1047
|
-
|
|
1048
|
-
export interface GetLocationBrandDocumentsPath {
|
|
1049
|
-
// Brand ID
|
|
1050
|
-
id: string;
|
|
1051
|
-
}
|
|
1052
|
-
|
|
1053
|
-
export interface GetLocationBrandDocumentsQuery {
|
|
1054
|
-
// Graphql query string
|
|
1055
|
-
_query?: string;
|
|
1056
|
-
}
|
|
1057
|
-
|
|
1058
|
-
export type GetLocationBrandDocumentsResponse = BrandDocumentsResponse;
|
|
1059
|
-
|
|
1060
|
-
export interface GetLocationBrandDocumentsRequest
|
|
1061
|
-
extends BaseRequest,
|
|
1062
|
-
RequestQuery<GetLocationBrandDocumentsQuery>,
|
|
1063
|
-
GetLocationBrandDocumentsPath {}
|
|
1064
|
-
|
|
1065
927
|
// GET /location/brand/{id}/timeslots - Get location brand timeslots
|
|
1066
928
|
|
|
1067
929
|
export interface GetLocationBrandTimeslotsPath {
|
|
@@ -1453,3 +1315,41 @@ export interface GetLocationV2GroupsResponse {
|
|
|
1453
1315
|
export interface GetLocationV2GroupsRequest
|
|
1454
1316
|
extends BaseRequest,
|
|
1455
1317
|
RequestQuery<GetLocationV2GroupsQuery> {}
|
|
1318
|
+
|
|
1319
|
+
// GET /location/menu_association/{id}/brand - Get menu association for a brand
|
|
1320
|
+
|
|
1321
|
+
export interface GetLocationMenu_associationBrandPath {
|
|
1322
|
+
// brand id
|
|
1323
|
+
id: string;
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
export interface GetLocationMenu_associationBrandQuery {
|
|
1327
|
+
// Graphql query string
|
|
1328
|
+
_query?: string;
|
|
1329
|
+
}
|
|
1330
|
+
|
|
1331
|
+
export type GetLocationMenu_associationBrandResponse = MenuAssociations;
|
|
1332
|
+
|
|
1333
|
+
export interface GetLocationMenu_associationBrandRequest
|
|
1334
|
+
extends BaseRequest,
|
|
1335
|
+
RequestQuery<GetLocationMenu_associationBrandQuery>,
|
|
1336
|
+
GetLocationMenu_associationBrandPath {}
|
|
1337
|
+
|
|
1338
|
+
// GET /location/menu_association/{id}/menu - Get menu association for a brand
|
|
1339
|
+
|
|
1340
|
+
export interface GetLocationMenu_associationMenuPath {
|
|
1341
|
+
// menu id
|
|
1342
|
+
id: string;
|
|
1343
|
+
}
|
|
1344
|
+
|
|
1345
|
+
export interface GetLocationMenu_associationMenuQuery {
|
|
1346
|
+
// Graphql query string
|
|
1347
|
+
_query?: string;
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
export type GetLocationMenu_associationMenuResponse = MenuAssociations;
|
|
1351
|
+
|
|
1352
|
+
export interface GetLocationMenu_associationMenuRequest
|
|
1353
|
+
extends BaseRequest,
|
|
1354
|
+
RequestQuery<GetLocationMenu_associationMenuQuery>,
|
|
1355
|
+
GetLocationMenu_associationMenuPath {}
|