@compassdigital/sdk.typescript 4.41.1 → 4.43.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 +56 -71
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +31 -66
- package/lib/index.js.map +1 -1
- package/lib/interface/auth.d.ts +58 -2
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/compassconnect.d.ts +23 -0
- package/lib/interface/compassconnect.d.ts.map +1 -1
- package/lib/interface/frictionless.d.ts +0 -12
- package/lib/interface/frictionless.d.ts.map +1 -1
- package/lib/interface/location.d.ts +1 -0
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +202 -290
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/order.d.ts +2 -0
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/partner.d.ts +1 -37
- package/lib/interface/partner.d.ts.map +1 -1
- package/lib/interface/user.d.ts +0 -9
- package/lib/interface/user.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +88 -160
- package/src/interface/auth.ts +77 -2
- package/src/interface/compassconnect.ts +29 -1
- package/src/interface/frictionless.ts +0 -23
- package/src/interface/location.ts +1 -0
- package/src/interface/menu.ts +228 -292
- package/src/interface/order.ts +4 -0
- package/src/interface/partner.ts +1 -68
- package/src/interface/user.ts +0 -17
package/src/index.ts
CHANGED
|
@@ -201,14 +201,6 @@ import {
|
|
|
201
201
|
} from "./interface/shoppingcart";
|
|
202
202
|
|
|
203
203
|
import {
|
|
204
|
-
PostPartnerStandardcognitionShoppingcartBody,
|
|
205
|
-
PostPartnerStandardcognitionShoppingcartResponse,
|
|
206
|
-
GetPartnerStandardcognitionLocationsQuery,
|
|
207
|
-
GetPartnerStandardcognitionLocationsResponse,
|
|
208
|
-
GetPartnerStandardcognitionStoresQuery,
|
|
209
|
-
GetPartnerStandardcognitionStoresResponse,
|
|
210
|
-
PostPartnerStandardcognitionMenuBody,
|
|
211
|
-
PostPartnerStandardcognitionMenuResponse,
|
|
212
204
|
PostPartnerEventBody,
|
|
213
205
|
PostPartnerEventResponse,
|
|
214
206
|
GetPartnerSwaggerQuery,
|
|
@@ -431,8 +423,6 @@ import {
|
|
|
431
423
|
PutUserPermissionsResponse,
|
|
432
424
|
PostUserCheckInBody,
|
|
433
425
|
PostUserCheckInResponse,
|
|
434
|
-
PatchUserCheckinBody,
|
|
435
|
-
PatchUserCheckinResponse,
|
|
436
426
|
GetUserSearchCheckInQuery,
|
|
437
427
|
GetUserSearchCheckInResponse,
|
|
438
428
|
PostUserSendEmailVerificationResponse,
|
|
@@ -581,6 +571,7 @@ import {
|
|
|
581
571
|
GetMenuV3DraftBrandResponse,
|
|
582
572
|
PatchMenuV3DraftBrandBody,
|
|
583
573
|
PatchMenuV3DraftBrandResponse,
|
|
574
|
+
DeleteMenuV3DraftBrandQuery,
|
|
584
575
|
DeleteMenuV3DraftBrandResponse,
|
|
585
576
|
GetMenuV3DraftBrandsQuery,
|
|
586
577
|
GetMenuV3DraftBrandsResponse,
|
|
@@ -604,7 +595,7 @@ import {
|
|
|
604
595
|
PostMenuV3DraftBrandDiffGenerateResponse,
|
|
605
596
|
GetMenuV3DraftBrandDiffsQuery,
|
|
606
597
|
GetMenuV3DraftBrandDiffsResponse,
|
|
607
|
-
|
|
598
|
+
PostMenuV3DraftBrandGlobalDiffsApplyBody,
|
|
608
599
|
PostMenuV3DraftBrandGlobalDiffsApplyResponse,
|
|
609
600
|
PostMenuV3DraftBrandAttachmentQuery,
|
|
610
601
|
PostMenuV3DraftBrandAttachmentResponse,
|
|
@@ -639,6 +630,7 @@ import {
|
|
|
639
630
|
GetMenuV3DraftMenuResponse,
|
|
640
631
|
PatchMenuV3DraftMenuBody,
|
|
641
632
|
PatchMenuV3DraftMenuResponse,
|
|
633
|
+
DeleteMenuV3DraftMenuQuery,
|
|
642
634
|
DeleteMenuV3DraftMenuResponse,
|
|
643
635
|
GetMenuV3DraftMenusQuery,
|
|
644
636
|
GetMenuV3DraftMenusResponse,
|
|
@@ -665,6 +657,7 @@ import {
|
|
|
665
657
|
GetMenuV3DraftCategoryResponse,
|
|
666
658
|
PatchMenuV3DraftCategoryBody,
|
|
667
659
|
PatchMenuV3DraftCategoryResponse,
|
|
660
|
+
DeleteMenuV3DraftCategoryQuery,
|
|
668
661
|
DeleteMenuV3DraftCategoryResponse,
|
|
669
662
|
GetMenuV3DraftCategoriesCountQuery,
|
|
670
663
|
GetMenuV3DraftCategoriesCountResponse,
|
|
@@ -682,6 +675,7 @@ import {
|
|
|
682
675
|
GetMenuV3DraftCategoryRelationshipsItemResponse,
|
|
683
676
|
PatchMenuV3DraftCategoryRelationshipsItemBody,
|
|
684
677
|
PatchMenuV3DraftCategoryRelationshipsItemResponse,
|
|
678
|
+
DeleteMenuV3DraftCategoryRelationshipsItemQuery,
|
|
685
679
|
DeleteMenuV3DraftCategoryRelationshipsItemResponse,
|
|
686
680
|
GetMenuV3DraftCategoryRelationshipsItemsQuery,
|
|
687
681
|
GetMenuV3DraftCategoryRelationshipsItemsResponse,
|
|
@@ -701,6 +695,7 @@ import {
|
|
|
701
695
|
GetMenuV3DraftItemResponse,
|
|
702
696
|
PatchMenuV3DraftItemBody,
|
|
703
697
|
PatchMenuV3DraftItemResponse,
|
|
698
|
+
DeleteMenuV3DraftItemQuery,
|
|
704
699
|
DeleteMenuV3DraftItemResponse,
|
|
705
700
|
GetMenuV3DraftItemsQuery,
|
|
706
701
|
GetMenuV3DraftItemsResponse,
|
|
@@ -732,6 +727,7 @@ import {
|
|
|
732
727
|
GetMenuV3DraftItemRelationshipsModifierGroupResponse,
|
|
733
728
|
PatchMenuV3DraftItemRelationshipsModifierGroupBody,
|
|
734
729
|
PatchMenuV3DraftItemRelationshipsModifierGroupResponse,
|
|
730
|
+
DeleteMenuV3DraftItemRelationshipsModifierGroupQuery,
|
|
735
731
|
DeleteMenuV3DraftItemRelationshipsModifierGroupResponse,
|
|
736
732
|
GetMenuV3DraftItemRelationshipsModifierGroupsQuery,
|
|
737
733
|
GetMenuV3DraftItemRelationshipsModifierGroupsResponse,
|
|
@@ -751,6 +747,7 @@ import {
|
|
|
751
747
|
GetMenuV3DraftModifierGroupResponse,
|
|
752
748
|
PatchMenuV3DraftModifierGroupBody,
|
|
753
749
|
PatchMenuV3DraftModifierGroupResponse,
|
|
750
|
+
DeleteMenuV3DraftModifierGroupQuery,
|
|
754
751
|
DeleteMenuV3DraftModifierGroupResponse,
|
|
755
752
|
GetMenuV3DraftModifierGroupsQuery,
|
|
756
753
|
GetMenuV3DraftModifierGroupsResponse,
|
|
@@ -771,6 +768,7 @@ import {
|
|
|
771
768
|
GetMenuV3DraftModifierGroupRelationshipsModifierResponse,
|
|
772
769
|
PatchMenuV3DraftModifierGroupRelationshipsModifierBody,
|
|
773
770
|
PatchMenuV3DraftModifierGroupRelationshipsModifierResponse,
|
|
771
|
+
DeleteMenuV3DraftModifierGroupRelationshipsModifierQuery,
|
|
774
772
|
DeleteMenuV3DraftModifierGroupRelationshipsModifierResponse,
|
|
775
773
|
GetMenuV3DraftModifierGroupRelationshipsModifiersQuery,
|
|
776
774
|
GetMenuV3DraftModifierGroupRelationshipsModifiersResponse,
|
|
@@ -790,6 +788,7 @@ import {
|
|
|
790
788
|
GetMenuV3DraftModifierResponse,
|
|
791
789
|
PatchMenuV3DraftModifierBody,
|
|
792
790
|
PatchMenuV3DraftModifierResponse,
|
|
791
|
+
DeleteMenuV3DraftModifierQuery,
|
|
793
792
|
DeleteMenuV3DraftModifierResponse,
|
|
794
793
|
GetMenuV3DraftModifiersQuery,
|
|
795
794
|
GetMenuV3DraftModifiersResponse,
|
|
@@ -903,8 +902,6 @@ import {
|
|
|
903
902
|
PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse,
|
|
904
903
|
PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody,
|
|
905
904
|
PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse,
|
|
906
|
-
PostFrictionlessWebhookStandardcognitionBody,
|
|
907
|
-
PostFrictionlessWebhookStandardcognitionResponse,
|
|
908
905
|
} from "./interface/frictionless";
|
|
909
906
|
|
|
910
907
|
import {
|
|
@@ -958,6 +955,10 @@ import {
|
|
|
958
955
|
GetAuthFlowResponse,
|
|
959
956
|
GetAuthSsoConfigsQuery,
|
|
960
957
|
GetAuthSsoConfigsResponse,
|
|
958
|
+
PostAuthSsoConfigBody,
|
|
959
|
+
PostAuthSsoConfigResponse,
|
|
960
|
+
PostAuthSsoBody,
|
|
961
|
+
PostAuthSsoResponse,
|
|
961
962
|
} from "./interface/auth";
|
|
962
963
|
|
|
963
964
|
import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
|
|
@@ -2857,86 +2858,6 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
2857
2858
|
);
|
|
2858
2859
|
}
|
|
2859
2860
|
|
|
2860
|
-
/**
|
|
2861
|
-
* POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
|
|
2862
|
-
*
|
|
2863
|
-
* @param body
|
|
2864
|
-
* @param options - additional request options
|
|
2865
|
-
*/
|
|
2866
|
-
post_partner_standardcognition_shoppingcart(
|
|
2867
|
-
body: PostPartnerStandardcognitionShoppingcartBody,
|
|
2868
|
-
options?: RequestOptions,
|
|
2869
|
-
): ResponsePromise<PostPartnerStandardcognitionShoppingcartResponse> {
|
|
2870
|
-
return this.request(
|
|
2871
|
-
"partner",
|
|
2872
|
-
"post_partner_standardcognition_shoppingcart",
|
|
2873
|
-
"post",
|
|
2874
|
-
`/partner/standardcognition/shoppingcart`,
|
|
2875
|
-
body,
|
|
2876
|
-
options,
|
|
2877
|
-
);
|
|
2878
|
-
}
|
|
2879
|
-
|
|
2880
|
-
/**
|
|
2881
|
-
* GET /partner/standardcognition/locations - Gets the locations where Standard Cognition is available
|
|
2882
|
-
*
|
|
2883
|
-
* @param options - additional request options
|
|
2884
|
-
*/
|
|
2885
|
-
get_partner_standardcognition_locations(
|
|
2886
|
-
options?: {
|
|
2887
|
-
query?: GetPartnerStandardcognitionLocationsQuery;
|
|
2888
|
-
} & RequestOptions,
|
|
2889
|
-
): ResponsePromise<GetPartnerStandardcognitionLocationsResponse> {
|
|
2890
|
-
return this.request(
|
|
2891
|
-
"partner",
|
|
2892
|
-
"get_partner_standardcognition_locations",
|
|
2893
|
-
"get",
|
|
2894
|
-
`/partner/standardcognition/locations`,
|
|
2895
|
-
null,
|
|
2896
|
-
options,
|
|
2897
|
-
);
|
|
2898
|
-
}
|
|
2899
|
-
|
|
2900
|
-
/**
|
|
2901
|
-
* GET /partner/standardcognition/stores - Gets the UUID for all the Standard Cognition external locations
|
|
2902
|
-
*
|
|
2903
|
-
* @param options - additional request options
|
|
2904
|
-
*/
|
|
2905
|
-
get_partner_standardcognition_stores(
|
|
2906
|
-
options?: {
|
|
2907
|
-
query?: GetPartnerStandardcognitionStoresQuery;
|
|
2908
|
-
} & RequestOptions,
|
|
2909
|
-
): ResponsePromise<GetPartnerStandardcognitionStoresResponse> {
|
|
2910
|
-
return this.request(
|
|
2911
|
-
"partner",
|
|
2912
|
-
"get_partner_standardcognition_stores",
|
|
2913
|
-
"get",
|
|
2914
|
-
`/partner/standardcognition/stores`,
|
|
2915
|
-
null,
|
|
2916
|
-
options,
|
|
2917
|
-
);
|
|
2918
|
-
}
|
|
2919
|
-
|
|
2920
|
-
/**
|
|
2921
|
-
* POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
|
|
2922
|
-
*
|
|
2923
|
-
* @param body
|
|
2924
|
-
* @param options - additional request options
|
|
2925
|
-
*/
|
|
2926
|
-
post_partner_standardcognition_menu(
|
|
2927
|
-
body: PostPartnerStandardcognitionMenuBody,
|
|
2928
|
-
options?: RequestOptions,
|
|
2929
|
-
): ResponsePromise<PostPartnerStandardcognitionMenuResponse> {
|
|
2930
|
-
return this.request(
|
|
2931
|
-
"partner",
|
|
2932
|
-
"post_partner_standardcognition_menu",
|
|
2933
|
-
"post",
|
|
2934
|
-
`/partner/standardcognition/menu`,
|
|
2935
|
-
body,
|
|
2936
|
-
options,
|
|
2937
|
-
);
|
|
2938
|
-
}
|
|
2939
|
-
|
|
2940
2861
|
/**
|
|
2941
2862
|
* POST /partner/event/{id} - Send an event from 3rd party to our system
|
|
2942
2863
|
*
|
|
@@ -4758,30 +4679,6 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
4758
4679
|
return this.request("user", "post_user_check_in", "post", `/user/${id}/checkin`, body, options);
|
|
4759
4680
|
}
|
|
4760
4681
|
|
|
4761
|
-
/**
|
|
4762
|
-
* PATCH /user/{id}/checkin/{checkin_id} - Update check-in
|
|
4763
|
-
*
|
|
4764
|
-
* @param id - UserId of user who wants to checkin
|
|
4765
|
-
* @param checkin_id - Checkin id
|
|
4766
|
-
* @param body - The updated state/date_queued of the check-in
|
|
4767
|
-
* @param options - additional request options
|
|
4768
|
-
*/
|
|
4769
|
-
patch_user_checkin(
|
|
4770
|
-
id: string,
|
|
4771
|
-
checkin_id: string,
|
|
4772
|
-
body: PatchUserCheckinBody,
|
|
4773
|
-
options?: RequestOptions,
|
|
4774
|
-
): ResponsePromise<PatchUserCheckinResponse> {
|
|
4775
|
-
return this.request(
|
|
4776
|
-
"user",
|
|
4777
|
-
"patch_user_checkin",
|
|
4778
|
-
"patch",
|
|
4779
|
-
`/user/${id}/checkin/${checkin_id}`,
|
|
4780
|
-
body,
|
|
4781
|
-
options,
|
|
4782
|
-
);
|
|
4783
|
-
}
|
|
4784
|
-
|
|
4785
4682
|
/**
|
|
4786
4683
|
* GET /user/checkin/search - Search check-in
|
|
4787
4684
|
*
|
|
@@ -5470,7 +5367,7 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
5470
5367
|
/**
|
|
5471
5368
|
* GET /menu/{id}/export - Export menu set to zipped excel file.
|
|
5472
5369
|
*
|
|
5473
|
-
* @param id - menu
|
|
5370
|
+
* @param id - menu
|
|
5474
5371
|
* @param options - additional request options
|
|
5475
5372
|
*/
|
|
5476
5373
|
get_menu_export(
|
|
@@ -5485,7 +5382,7 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
5485
5382
|
/**
|
|
5486
5383
|
* GET /menu/partial/{id}/groups - Get an individual menu with its categories only partially loaded. (No items)
|
|
5487
5384
|
*
|
|
5488
|
-
* @param id - menu
|
|
5385
|
+
* @param id - menu
|
|
5489
5386
|
* @param options - additional request options
|
|
5490
5387
|
*/
|
|
5491
5388
|
get_menu_partial_groups(
|
|
@@ -5507,8 +5404,8 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
5507
5404
|
/**
|
|
5508
5405
|
* GET /menu/partial/{id}/group/{group_id}/items - Get an individual menu with its categories only partially loaded. (No items)
|
|
5509
5406
|
*
|
|
5510
|
-
* @param id - menu
|
|
5511
|
-
* @param group_id - group
|
|
5407
|
+
* @param id - menu
|
|
5408
|
+
* @param group_id - group
|
|
5512
5409
|
* @param options - additional request options
|
|
5513
5410
|
*/
|
|
5514
5411
|
get_menu_partial_group_items(
|
|
@@ -5531,8 +5428,8 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
5531
5428
|
/**
|
|
5532
5429
|
* POST /menu/partial/{id}/group/{group_id}/item/options - Get menu items's options
|
|
5533
5430
|
*
|
|
5534
|
-
* @param id - menu
|
|
5535
|
-
* @param group_id - group
|
|
5431
|
+
* @param id - menu
|
|
5432
|
+
* @param group_id - group
|
|
5536
5433
|
* @param body
|
|
5537
5434
|
* @param options - additional request options
|
|
5538
5435
|
*/
|
|
@@ -6134,7 +6031,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
6134
6031
|
*/
|
|
6135
6032
|
delete_menu_v3_draft_brand(
|
|
6136
6033
|
id: string,
|
|
6137
|
-
options?:
|
|
6034
|
+
options?: {
|
|
6035
|
+
query?: DeleteMenuV3DraftBrandQuery;
|
|
6036
|
+
} & RequestOptions,
|
|
6138
6037
|
): ResponsePromise<DeleteMenuV3DraftBrandResponse> {
|
|
6139
6038
|
return this.request(
|
|
6140
6039
|
"menu",
|
|
@@ -6404,20 +6303,20 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
6404
6303
|
* POST /menu/v3/draft/brand/{id}/global-diffs/apply
|
|
6405
6304
|
*
|
|
6406
6305
|
* @param id
|
|
6306
|
+
* @param body
|
|
6407
6307
|
* @param options - additional request options
|
|
6408
6308
|
*/
|
|
6409
6309
|
post_menu_v3_draft_brand_global_diffs_apply(
|
|
6410
6310
|
id: string,
|
|
6411
|
-
|
|
6412
|
-
|
|
6413
|
-
} & RequestOptions,
|
|
6311
|
+
body: PostMenuV3DraftBrandGlobalDiffsApplyBody,
|
|
6312
|
+
options?: RequestOptions,
|
|
6414
6313
|
): ResponsePromise<PostMenuV3DraftBrandGlobalDiffsApplyResponse> {
|
|
6415
6314
|
return this.request(
|
|
6416
6315
|
"menu",
|
|
6417
6316
|
"post_menu_v3_draft_brand_global_diffs_apply",
|
|
6418
6317
|
"post",
|
|
6419
6318
|
`/menu/v3/draft/brand/${id}/global-diffs/apply`,
|
|
6420
|
-
|
|
6319
|
+
body,
|
|
6421
6320
|
options,
|
|
6422
6321
|
);
|
|
6423
6322
|
}
|
|
@@ -6730,7 +6629,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
6730
6629
|
*/
|
|
6731
6630
|
delete_menu_v3_draft_menu(
|
|
6732
6631
|
id: string,
|
|
6733
|
-
options?:
|
|
6632
|
+
options?: {
|
|
6633
|
+
query?: DeleteMenuV3DraftMenuQuery;
|
|
6634
|
+
} & RequestOptions,
|
|
6734
6635
|
): ResponsePromise<DeleteMenuV3DraftMenuResponse> {
|
|
6735
6636
|
return this.request(
|
|
6736
6637
|
"menu",
|
|
@@ -7008,7 +6909,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
7008
6909
|
*/
|
|
7009
6910
|
delete_menu_v3_draft_category(
|
|
7010
6911
|
id: string,
|
|
7011
|
-
options?:
|
|
6912
|
+
options?: {
|
|
6913
|
+
query?: DeleteMenuV3DraftCategoryQuery;
|
|
6914
|
+
} & RequestOptions,
|
|
7012
6915
|
): ResponsePromise<DeleteMenuV3DraftCategoryResponse> {
|
|
7013
6916
|
return this.request(
|
|
7014
6917
|
"menu",
|
|
@@ -7198,7 +7101,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
7198
7101
|
*/
|
|
7199
7102
|
delete_menu_v3_draft_category_relationships_item(
|
|
7200
7103
|
id: string,
|
|
7201
|
-
options?:
|
|
7104
|
+
options?: {
|
|
7105
|
+
query?: DeleteMenuV3DraftCategoryRelationshipsItemQuery;
|
|
7106
|
+
} & RequestOptions,
|
|
7202
7107
|
): ResponsePromise<DeleteMenuV3DraftCategoryRelationshipsItemResponse> {
|
|
7203
7108
|
return this.request(
|
|
7204
7109
|
"menu",
|
|
@@ -7404,7 +7309,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
7404
7309
|
*/
|
|
7405
7310
|
delete_menu_v3_draft_item(
|
|
7406
7311
|
id: string,
|
|
7407
|
-
options?:
|
|
7312
|
+
options?: {
|
|
7313
|
+
query?: DeleteMenuV3DraftItemQuery;
|
|
7314
|
+
} & RequestOptions,
|
|
7408
7315
|
): ResponsePromise<DeleteMenuV3DraftItemResponse> {
|
|
7409
7316
|
return this.request(
|
|
7410
7317
|
"menu",
|
|
@@ -7722,7 +7629,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
7722
7629
|
*/
|
|
7723
7630
|
delete_menu_v3_draft_item_relationships_modifier_group(
|
|
7724
7631
|
id: string,
|
|
7725
|
-
options?:
|
|
7632
|
+
options?: {
|
|
7633
|
+
query?: DeleteMenuV3DraftItemRelationshipsModifierGroupQuery;
|
|
7634
|
+
} & RequestOptions,
|
|
7726
7635
|
): ResponsePromise<DeleteMenuV3DraftItemRelationshipsModifierGroupResponse> {
|
|
7727
7636
|
return this.request(
|
|
7728
7637
|
"menu",
|
|
@@ -7928,7 +7837,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
7928
7837
|
*/
|
|
7929
7838
|
delete_menu_v3_draft_modifier_group(
|
|
7930
7839
|
id: string,
|
|
7931
|
-
options?:
|
|
7840
|
+
options?: {
|
|
7841
|
+
query?: DeleteMenuV3DraftModifierGroupQuery;
|
|
7842
|
+
} & RequestOptions,
|
|
7932
7843
|
): ResponsePromise<DeleteMenuV3DraftModifierGroupResponse> {
|
|
7933
7844
|
return this.request(
|
|
7934
7845
|
"menu",
|
|
@@ -8154,7 +8065,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
8154
8065
|
*/
|
|
8155
8066
|
delete_menu_v3_draft_modifier_group_relationships_modifier(
|
|
8156
8067
|
id: string,
|
|
8157
|
-
options?:
|
|
8068
|
+
options?: {
|
|
8069
|
+
query?: DeleteMenuV3DraftModifierGroupRelationshipsModifierQuery;
|
|
8070
|
+
} & RequestOptions,
|
|
8158
8071
|
): ResponsePromise<DeleteMenuV3DraftModifierGroupRelationshipsModifierResponse> {
|
|
8159
8072
|
return this.request(
|
|
8160
8073
|
"menu",
|
|
@@ -8360,7 +8273,9 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
8360
8273
|
*/
|
|
8361
8274
|
delete_menu_v3_draft_modifier(
|
|
8362
8275
|
id: string,
|
|
8363
|
-
options?:
|
|
8276
|
+
options?: {
|
|
8277
|
+
query?: DeleteMenuV3DraftModifierQuery;
|
|
8278
|
+
} & RequestOptions,
|
|
8364
8279
|
): ResponsePromise<DeleteMenuV3DraftModifierResponse> {
|
|
8365
8280
|
return this.request(
|
|
8366
8281
|
"menu",
|
|
@@ -8621,7 +8536,7 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
8621
8536
|
}
|
|
8622
8537
|
|
|
8623
8538
|
/**
|
|
8624
|
-
* GET menu/v3/menuworks
|
|
8539
|
+
* GET /menu/v3/menuworks
|
|
8625
8540
|
*
|
|
8626
8541
|
* @param options - additional request options
|
|
8627
8542
|
*/
|
|
@@ -8630,7 +8545,14 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
8630
8545
|
query?: GetMenuV3MenuworksQuery;
|
|
8631
8546
|
} & RequestOptions,
|
|
8632
8547
|
): ResponsePromise<GetMenuV3MenuworksResponse> {
|
|
8633
|
-
return this.request(
|
|
8548
|
+
return this.request(
|
|
8549
|
+
"menu",
|
|
8550
|
+
"get_menu_v3_menuworks",
|
|
8551
|
+
"get",
|
|
8552
|
+
`/menu/v3/menuworks`,
|
|
8553
|
+
null,
|
|
8554
|
+
options,
|
|
8555
|
+
);
|
|
8634
8556
|
}
|
|
8635
8557
|
|
|
8636
8558
|
/**
|
|
@@ -8771,7 +8693,7 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
8771
8693
|
}
|
|
8772
8694
|
|
|
8773
8695
|
/**
|
|
8774
|
-
* GET /compassconnect/
|
|
8696
|
+
* GET /compassconnect/oms_token - Gets an OMS token
|
|
8775
8697
|
*
|
|
8776
8698
|
* @param options - additional request options
|
|
8777
8699
|
*/
|
|
@@ -8784,7 +8706,7 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
8784
8706
|
"compassconnect",
|
|
8785
8707
|
"get_compassconnect_oms_token",
|
|
8786
8708
|
"get",
|
|
8787
|
-
`/compassconnect/
|
|
8709
|
+
`/compassconnect/oms_token`,
|
|
8788
8710
|
null,
|
|
8789
8711
|
options,
|
|
8790
8712
|
);
|
|
@@ -9348,26 +9270,6 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
9348
9270
|
);
|
|
9349
9271
|
}
|
|
9350
9272
|
|
|
9351
|
-
/**
|
|
9352
|
-
* POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
|
|
9353
|
-
*
|
|
9354
|
-
* @param body
|
|
9355
|
-
* @param options - additional request options
|
|
9356
|
-
*/
|
|
9357
|
-
post_frictionless_webhook_standardcognition(
|
|
9358
|
-
body: PostFrictionlessWebhookStandardcognitionBody,
|
|
9359
|
-
options?: RequestOptions,
|
|
9360
|
-
): ResponsePromise<PostFrictionlessWebhookStandardcognitionResponse> {
|
|
9361
|
-
return this.request(
|
|
9362
|
-
"frictionless",
|
|
9363
|
-
"post_frictionless_webhook_standardcognition",
|
|
9364
|
-
"post",
|
|
9365
|
-
`/frictionless/webhook/standardcognition`,
|
|
9366
|
-
body,
|
|
9367
|
-
options,
|
|
9368
|
-
);
|
|
9369
|
-
}
|
|
9370
|
-
|
|
9371
9273
|
/**
|
|
9372
9274
|
* GET /dev/consumer/v1/health-check
|
|
9373
9275
|
*
|
|
@@ -9691,4 +9593,30 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
9691
9593
|
): ResponsePromise<GetAuthSsoConfigsResponse> {
|
|
9692
9594
|
return this.request("auth", "get_auth_sso_configs", "get", `/auth/sso-configs`, null, options);
|
|
9693
9595
|
}
|
|
9596
|
+
|
|
9597
|
+
/**
|
|
9598
|
+
* POST /auth/sso-config - Create a new SSO configuration
|
|
9599
|
+
*
|
|
9600
|
+
* @param body
|
|
9601
|
+
* @param options - additional request options
|
|
9602
|
+
*/
|
|
9603
|
+
post_auth_sso_config(
|
|
9604
|
+
body: PostAuthSsoConfigBody,
|
|
9605
|
+
options?: RequestOptions,
|
|
9606
|
+
): ResponsePromise<PostAuthSsoConfigResponse> {
|
|
9607
|
+
return this.request("auth", "post_auth_sso_config", "post", `/auth/sso-config`, body, options);
|
|
9608
|
+
}
|
|
9609
|
+
|
|
9610
|
+
/**
|
|
9611
|
+
* POST /auth/sso - Authenticates a user using a SSO provider.
|
|
9612
|
+
*
|
|
9613
|
+
* @param body
|
|
9614
|
+
* @param options - additional request options
|
|
9615
|
+
*/
|
|
9616
|
+
post_auth_sso(
|
|
9617
|
+
body: PostAuthSsoBody,
|
|
9618
|
+
options?: RequestOptions,
|
|
9619
|
+
): ResponsePromise<PostAuthSsoResponse> {
|
|
9620
|
+
return this.request("auth", "post_auth_sso", "post", `/auth/sso`, body, options);
|
|
9621
|
+
}
|
|
9694
9622
|
}
|
package/src/interface/auth.ts
CHANGED
|
@@ -12,13 +12,68 @@ export interface SSOFlowResponseDTO {
|
|
|
12
12
|
oidc?: OIDC;
|
|
13
13
|
}
|
|
14
14
|
|
|
15
|
-
export interface
|
|
15
|
+
export interface SSOConfigsResponseDTO {
|
|
16
|
+
name: string;
|
|
17
|
+
clientId: string;
|
|
18
|
+
authorizationEndpoint: string;
|
|
19
|
+
tokenEndpoint: string;
|
|
20
|
+
userinfoEndpoint: string;
|
|
21
|
+
realm: string;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface SSOConfigRequestDTO {
|
|
16
25
|
name: string;
|
|
17
26
|
clientId: string;
|
|
18
27
|
authorizationEndpoint: string;
|
|
28
|
+
clientSecret: string;
|
|
19
29
|
tokenEndpoint: string;
|
|
20
30
|
userinfoEndpoint: string;
|
|
21
31
|
realm: string;
|
|
32
|
+
protocol: "OIDC" | "SAML2";
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface SSOConfigResponseDTO {
|
|
36
|
+
success: boolean;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface SSOAuthRequestDTO {
|
|
40
|
+
code: string;
|
|
41
|
+
name: string;
|
|
42
|
+
clientId: string;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface Token {
|
|
46
|
+
token: string;
|
|
47
|
+
expires: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface Name {
|
|
51
|
+
first: string;
|
|
52
|
+
last: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface Date {
|
|
56
|
+
modified: string;
|
|
57
|
+
created: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export interface Is {
|
|
61
|
+
disabled: boolean;
|
|
62
|
+
verified: boolean;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export interface Profile {
|
|
66
|
+
id: string;
|
|
67
|
+
email: string;
|
|
68
|
+
name?: Name;
|
|
69
|
+
date?: Date;
|
|
70
|
+
ssoId: string;
|
|
71
|
+
is?: Is;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface SSOAuthResponseDTO {
|
|
75
|
+
access: Token;
|
|
76
|
+
profile: Profile;
|
|
22
77
|
}
|
|
23
78
|
|
|
24
79
|
// GET /auth/flow - Determines the authentication flow for a user based on their email address
|
|
@@ -42,8 +97,28 @@ export interface GetAuthSsoConfigsQuery {
|
|
|
42
97
|
_query?: string;
|
|
43
98
|
}
|
|
44
99
|
|
|
45
|
-
export type GetAuthSsoConfigsResponse =
|
|
100
|
+
export type GetAuthSsoConfigsResponse = SSOConfigsResponseDTO[];
|
|
46
101
|
|
|
47
102
|
export interface GetAuthSsoConfigsRequest
|
|
48
103
|
extends BaseRequest,
|
|
49
104
|
RequestQuery<GetAuthSsoConfigsQuery> {}
|
|
105
|
+
|
|
106
|
+
// POST /auth/sso-config - Create a new SSO configuration
|
|
107
|
+
|
|
108
|
+
export type PostAuthSsoConfigBody = SSOConfigRequestDTO;
|
|
109
|
+
|
|
110
|
+
export type PostAuthSsoConfigResponse = SSOConfigResponseDTO;
|
|
111
|
+
|
|
112
|
+
export interface PostAuthSsoConfigRequest extends BaseRequest {
|
|
113
|
+
body: PostAuthSsoConfigBody;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
// POST /auth/sso - Authenticates a user using a SSO provider.
|
|
117
|
+
|
|
118
|
+
export type PostAuthSsoBody = SSOAuthRequestDTO;
|
|
119
|
+
|
|
120
|
+
export type PostAuthSsoResponse = SSOAuthResponseDTO;
|
|
121
|
+
|
|
122
|
+
export interface PostAuthSsoRequest extends BaseRequest {
|
|
123
|
+
body: PostAuthSsoBody;
|
|
124
|
+
}
|
|
@@ -25,6 +25,34 @@ export interface Auth {
|
|
|
25
25
|
token?: string;
|
|
26
26
|
expires?: string;
|
|
27
27
|
};
|
|
28
|
+
// Access token string (should be moved inside access object under real scenarios)
|
|
29
|
+
access_token?: string;
|
|
30
|
+
// Duration in seconds until the access token expires (should be moved inside access object under real scenarios)
|
|
31
|
+
expires_in?: number;
|
|
32
|
+
// Unix timestamp when the token expires (should be moved inside access object under real scenarios)
|
|
33
|
+
expires_at?: number;
|
|
34
|
+
attributes?: {
|
|
35
|
+
clientName?: string;
|
|
36
|
+
company?: string;
|
|
37
|
+
country?: string;
|
|
38
|
+
credentialType?: string;
|
|
39
|
+
department?: string;
|
|
40
|
+
email?: string;
|
|
41
|
+
first_name?: string;
|
|
42
|
+
full_name?: string;
|
|
43
|
+
last_name?: string;
|
|
44
|
+
locale?: string;
|
|
45
|
+
logon_username?: string;
|
|
46
|
+
mobile?: string;
|
|
47
|
+
samlAuthenticationStatementAuthMethod?: string;
|
|
48
|
+
telephone?: string;
|
|
49
|
+
title?: string;
|
|
50
|
+
userPrincipalName?: string;
|
|
51
|
+
};
|
|
52
|
+
// Identifier of the user or session
|
|
53
|
+
id?: string;
|
|
54
|
+
// Refresh token string (should be moved inside refresh object under real scenarios)
|
|
55
|
+
refresh_token?: string;
|
|
28
56
|
}
|
|
29
57
|
|
|
30
58
|
export interface Compassconnect {
|
|
@@ -36,7 +64,7 @@ export interface Compassconnects {
|
|
|
36
64
|
compassconnects: Compassconnect[];
|
|
37
65
|
}
|
|
38
66
|
|
|
39
|
-
// GET /compassconnect/
|
|
67
|
+
// GET /compassconnect/oms_token - Gets an OMS token
|
|
40
68
|
|
|
41
69
|
export interface GetCompassconnectOmsTokenQuery {
|
|
42
70
|
// The SSO code recieved from login
|
|
@@ -217,19 +217,6 @@ export interface AmazonJWOOrderingResponseDTO {
|
|
|
217
217
|
purchaseId: string;
|
|
218
218
|
}
|
|
219
219
|
|
|
220
|
-
export interface StandardCognitionEventDTO {
|
|
221
|
-
// Value that uniquely identifies each event that occurs in Standard Cognition's system
|
|
222
|
-
event_id: string;
|
|
223
|
-
// Contains an enumerated string that tells the system what type of event took place. Current values are external-customer-order-created for when a new order is created and external-customer-order-state-changed for when an order changes state
|
|
224
|
-
event_type: "external-customer-order-created" | "external-customer-order-state-changed";
|
|
225
|
-
// Value that uniquely identifies each customer in Standard Cognition's system. Coincides with our Checkin ID
|
|
226
|
-
external_customer_id: string;
|
|
227
|
-
// Value that uniquely identifies each store in Standard Cognition's system
|
|
228
|
-
tenant_id: string;
|
|
229
|
-
// Value that uniquely identifies each order in Standard Cognition's system
|
|
230
|
-
order_id: string;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
220
|
// GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
|
|
234
221
|
|
|
235
222
|
export interface GetFrictionlessBrandFrictionlessStatusPath {
|
|
@@ -377,13 +364,3 @@ export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
|
|
|
377
364
|
export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
|
|
378
365
|
body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
|
|
379
366
|
}
|
|
380
|
-
|
|
381
|
-
// POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
|
|
382
|
-
|
|
383
|
-
export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEventDTO;
|
|
384
|
-
|
|
385
|
-
export type PostFrictionlessWebhookStandardcognitionResponse = {};
|
|
386
|
-
|
|
387
|
-
export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
|
|
388
|
-
body: PostFrictionlessWebhookStandardcognitionBody;
|
|
389
|
-
}
|