@compassdigital/sdk.typescript 4.51.0 → 4.52.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/base.js.map +1 -1
- package/lib/index.d.ts +44 -3
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +45 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/auth.d.ts +21 -0
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +80 -9
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/user.d.ts +4 -4
- package/lib/interface/user.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/base.ts +3 -3
- package/src/index.ts +115 -0
- package/src/interface/auth.ts +36 -0
- package/src/interface/menu.ts +103 -9
- package/src/interface/user.ts +4 -4
package/lib/interface/menu.d.ts
CHANGED
|
@@ -117,6 +117,7 @@ export interface Item {
|
|
|
117
117
|
barcodes?: string[];
|
|
118
118
|
tax?: {
|
|
119
119
|
tax_tag_code?: string;
|
|
120
|
+
tax_jwo_code?: string;
|
|
120
121
|
};
|
|
121
122
|
[index: string]: any;
|
|
122
123
|
};
|
|
@@ -226,7 +227,6 @@ export interface Option {
|
|
|
226
227
|
meta?: {
|
|
227
228
|
sort_number?: number;
|
|
228
229
|
menu_sort_number?: number;
|
|
229
|
-
plu?: string;
|
|
230
230
|
sizing?: {
|
|
231
231
|
name?: string;
|
|
232
232
|
posid?: string;
|
|
@@ -334,7 +334,7 @@ export interface DraftBrandDTO {
|
|
|
334
334
|
global_menu_group_id?: string;
|
|
335
335
|
posid_segment?: string;
|
|
336
336
|
is_simplified_view?: boolean;
|
|
337
|
-
frictionless_partner?:
|
|
337
|
+
frictionless_partner?: string;
|
|
338
338
|
applied_diff_snapshot?: Record<string, any>;
|
|
339
339
|
permissions?: Record<string, any>;
|
|
340
340
|
[index: string]: any;
|
|
@@ -350,7 +350,7 @@ export interface PublishedBrandDTO {
|
|
|
350
350
|
global_menu_group_id?: string;
|
|
351
351
|
posid_segment?: string;
|
|
352
352
|
is_simplified_view?: boolean;
|
|
353
|
-
frictionless_partner?:
|
|
353
|
+
frictionless_partner?: string;
|
|
354
354
|
permissions?: Record<string, any>;
|
|
355
355
|
[index: string]: any;
|
|
356
356
|
}
|
|
@@ -539,6 +539,7 @@ export interface DraftItemDTO {
|
|
|
539
539
|
tax_tag_code?: string;
|
|
540
540
|
tags?: string[];
|
|
541
541
|
is_featured?: boolean;
|
|
542
|
+
tax_jwo_code?: string;
|
|
542
543
|
applied_diff_snapshot?: Record<string, any>;
|
|
543
544
|
brand?: DraftBrandDTO;
|
|
544
545
|
categories?: Record<string, any>[];
|
|
@@ -756,6 +757,18 @@ export interface BrandStatusDTO {
|
|
|
756
757
|
permissions?: Record<string, any>;
|
|
757
758
|
[index: string]: any;
|
|
758
759
|
}
|
|
760
|
+
export interface AuditDTO {
|
|
761
|
+
process_id?: string;
|
|
762
|
+
brand_id?: string;
|
|
763
|
+
status_type?: string;
|
|
764
|
+
status?: string;
|
|
765
|
+
message?: string;
|
|
766
|
+
id?: string;
|
|
767
|
+
data?: Record<string, any>;
|
|
768
|
+
brand?: DraftBrandDTO;
|
|
769
|
+
permissions?: Record<string, any>;
|
|
770
|
+
[index: string]: any;
|
|
771
|
+
}
|
|
759
772
|
export interface SiteGroupWithMenuGroupNameResponseDTO {
|
|
760
773
|
site_id: string;
|
|
761
774
|
local_menu_group_id: string;
|
|
@@ -771,6 +784,22 @@ export interface SiteGroupDTO {
|
|
|
771
784
|
updated_at?: string;
|
|
772
785
|
[index: string]: any;
|
|
773
786
|
}
|
|
787
|
+
export interface AuditListDraftItemDTO {
|
|
788
|
+
process_id: string;
|
|
789
|
+
brand_id: string;
|
|
790
|
+
status_type: string;
|
|
791
|
+
status: string;
|
|
792
|
+
message: string;
|
|
793
|
+
id: string;
|
|
794
|
+
created_at?: string;
|
|
795
|
+
updated_at?: string;
|
|
796
|
+
deleted_at?: string;
|
|
797
|
+
data?: Record<string, any>;
|
|
798
|
+
version?: number;
|
|
799
|
+
brand?: DraftBrandDTO;
|
|
800
|
+
permissions?: Record<string, any>;
|
|
801
|
+
[index: string]: any;
|
|
802
|
+
}
|
|
774
803
|
export interface ReportingCategorySuggestion {
|
|
775
804
|
category?: string;
|
|
776
805
|
occurrences?: number;
|
|
@@ -881,6 +910,7 @@ export interface PublishedItemDTO {
|
|
|
881
910
|
tax_tag_code?: string;
|
|
882
911
|
tags?: string[];
|
|
883
912
|
is_featured?: boolean;
|
|
913
|
+
tax_jwo_code?: string;
|
|
884
914
|
permissions?: Record<string, any>;
|
|
885
915
|
[index: string]: any;
|
|
886
916
|
}
|
|
@@ -1194,6 +1224,7 @@ export interface DraftItemEntityDTO {
|
|
|
1194
1224
|
tax_tag_code?: string;
|
|
1195
1225
|
tags?: string[];
|
|
1196
1226
|
is_featured?: boolean;
|
|
1227
|
+
tax_jwo_code?: string;
|
|
1197
1228
|
applied_diff_snapshot?: Record<string, any>;
|
|
1198
1229
|
version?: number;
|
|
1199
1230
|
brand?: DraftBrandDTO;
|
|
@@ -1361,6 +1392,18 @@ export interface GetMenuItemsQuery {
|
|
|
1361
1392
|
export type GetMenuItemsResponse = Items;
|
|
1362
1393
|
export interface GetMenuItemsRequest extends BaseRequest, RequestQuery<GetMenuItemsQuery>, GetMenuItemsPath {
|
|
1363
1394
|
}
|
|
1395
|
+
export interface PostMenuRecommendedPath {
|
|
1396
|
+
id: string;
|
|
1397
|
+
}
|
|
1398
|
+
export interface PostMenuRecommendedBody {
|
|
1399
|
+
excluded_items?: string[];
|
|
1400
|
+
}
|
|
1401
|
+
export interface PostMenuRecommendedResponse {
|
|
1402
|
+
items?: Item[];
|
|
1403
|
+
}
|
|
1404
|
+
export interface PostMenuRecommendedRequest extends BaseRequest, PostMenuRecommendedPath {
|
|
1405
|
+
body: PostMenuRecommendedBody;
|
|
1406
|
+
}
|
|
1364
1407
|
export interface ImportItemsCanteenPath {
|
|
1365
1408
|
location: string;
|
|
1366
1409
|
}
|
|
@@ -1965,6 +2008,7 @@ export interface PostMenuV3DraftBrandBody {
|
|
|
1965
2008
|
modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
|
|
1966
2009
|
modifiers?: DraftModifierDTO[];
|
|
1967
2010
|
statuses?: BrandStatusDTO[];
|
|
2011
|
+
audit_logs?: AuditDTO[];
|
|
1968
2012
|
name: string;
|
|
1969
2013
|
description?: string;
|
|
1970
2014
|
is_active?: boolean;
|
|
@@ -1974,7 +2018,7 @@ export interface PostMenuV3DraftBrandBody {
|
|
|
1974
2018
|
global_menu_group_id?: string;
|
|
1975
2019
|
posid_segment?: string;
|
|
1976
2020
|
is_simplified_view?: boolean;
|
|
1977
|
-
frictionless_partner?:
|
|
2021
|
+
frictionless_partner?: string;
|
|
1978
2022
|
applied_diff_snapshot?: Record<string, any>;
|
|
1979
2023
|
changes?: BrandChangeDTO[];
|
|
1980
2024
|
local_menu_group?: LocalMenuGroupDTO;
|
|
@@ -2014,6 +2058,7 @@ export interface PatchMenuV3DraftBrandBody {
|
|
|
2014
2058
|
modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
|
|
2015
2059
|
modifiers?: DraftModifierDTO[];
|
|
2016
2060
|
statuses?: BrandStatusDTO[];
|
|
2061
|
+
audit_logs?: AuditDTO[];
|
|
2017
2062
|
id?: string;
|
|
2018
2063
|
name?: string;
|
|
2019
2064
|
description?: string;
|
|
@@ -2024,7 +2069,7 @@ export interface PatchMenuV3DraftBrandBody {
|
|
|
2024
2069
|
global_menu_group_id?: string;
|
|
2025
2070
|
posid_segment?: string;
|
|
2026
2071
|
is_simplified_view?: boolean;
|
|
2027
|
-
frictionless_partner?:
|
|
2072
|
+
frictionless_partner?: string;
|
|
2028
2073
|
applied_diff_snapshot?: Record<string, any>;
|
|
2029
2074
|
version?: number;
|
|
2030
2075
|
changes?: BrandChangeDTO[];
|
|
@@ -2078,6 +2123,7 @@ export type PostMenuV3DraftBrandsBody = {
|
|
|
2078
2123
|
modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
|
|
2079
2124
|
modifiers?: DraftModifierDTO[];
|
|
2080
2125
|
statuses?: BrandStatusDTO[];
|
|
2126
|
+
audit_logs?: AuditDTO[];
|
|
2081
2127
|
name: string;
|
|
2082
2128
|
description?: string;
|
|
2083
2129
|
is_active?: boolean;
|
|
@@ -2087,7 +2133,7 @@ export type PostMenuV3DraftBrandsBody = {
|
|
|
2087
2133
|
global_menu_group_id?: string;
|
|
2088
2134
|
posid_segment?: string;
|
|
2089
2135
|
is_simplified_view?: boolean;
|
|
2090
|
-
frictionless_partner?:
|
|
2136
|
+
frictionless_partner?: string;
|
|
2091
2137
|
applied_diff_snapshot?: Record<string, any>;
|
|
2092
2138
|
changes?: BrandChangeDTO[];
|
|
2093
2139
|
local_menu_group?: LocalMenuGroupDTO;
|
|
@@ -2115,6 +2161,27 @@ export interface GetMenuV3DraftBrandsCountResponse {
|
|
|
2115
2161
|
}
|
|
2116
2162
|
export interface GetMenuV3DraftBrandsCountRequest extends BaseRequest, RequestQuery<GetMenuV3DraftBrandsCountQuery> {
|
|
2117
2163
|
}
|
|
2164
|
+
export interface GetMenuV3DraftBrandAuditsPath {
|
|
2165
|
+
id: string;
|
|
2166
|
+
}
|
|
2167
|
+
export interface GetMenuV3DraftBrandAuditsQuery {
|
|
2168
|
+
select?: string[];
|
|
2169
|
+
relationships?: string[];
|
|
2170
|
+
filter?: string;
|
|
2171
|
+
limit?: number;
|
|
2172
|
+
page?: number;
|
|
2173
|
+
sort_by?: string;
|
|
2174
|
+
sort_order?: "DESC" | "ASC";
|
|
2175
|
+
soft_deleted?: "include" | "exclude" | "only";
|
|
2176
|
+
_query?: string;
|
|
2177
|
+
}
|
|
2178
|
+
export interface GetMenuV3DraftBrandAuditsResponse {
|
|
2179
|
+
results: AuditListDraftItemDTO[];
|
|
2180
|
+
meta?: ListResponseMetadataDTO;
|
|
2181
|
+
[index: string]: any;
|
|
2182
|
+
}
|
|
2183
|
+
export interface GetMenuV3DraftBrandAuditsRequest extends BaseRequest, RequestQuery<GetMenuV3DraftBrandAuditsQuery>, GetMenuV3DraftBrandAuditsPath {
|
|
2184
|
+
}
|
|
2118
2185
|
export interface GetMenuV3DraftBrandMenusPath {
|
|
2119
2186
|
id: string;
|
|
2120
2187
|
}
|
|
@@ -2327,7 +2394,7 @@ export interface PostMenuV3BrandBody {
|
|
|
2327
2394
|
global_menu_group_id?: string;
|
|
2328
2395
|
posid_segment?: string;
|
|
2329
2396
|
is_simplified_view?: boolean;
|
|
2330
|
-
frictionless_partner?:
|
|
2397
|
+
frictionless_partner?: string;
|
|
2331
2398
|
local_menu_group?: LocalMenuGroupDTO;
|
|
2332
2399
|
global_menu_group?: GlobalMenuGroupDTO;
|
|
2333
2400
|
attachments?: FileAttachmentsDTO;
|
|
@@ -2377,7 +2444,7 @@ export interface PatchMenuV3BrandBody {
|
|
|
2377
2444
|
global_menu_group_id?: string;
|
|
2378
2445
|
posid_segment?: string;
|
|
2379
2446
|
is_simplified_view?: boolean;
|
|
2380
|
-
frictionless_partner?:
|
|
2447
|
+
frictionless_partner?: string;
|
|
2381
2448
|
version?: number;
|
|
2382
2449
|
local_menu_group?: LocalMenuGroupDTO;
|
|
2383
2450
|
global_menu_group?: GlobalMenuGroupDTO;
|
|
@@ -2441,7 +2508,7 @@ export type PostMenuV3BrandsBody = {
|
|
|
2441
2508
|
global_menu_group_id?: string;
|
|
2442
2509
|
posid_segment?: string;
|
|
2443
2510
|
is_simplified_view?: boolean;
|
|
2444
|
-
frictionless_partner?:
|
|
2511
|
+
frictionless_partner?: string;
|
|
2445
2512
|
local_menu_group?: LocalMenuGroupDTO;
|
|
2446
2513
|
global_menu_group?: GlobalMenuGroupDTO;
|
|
2447
2514
|
attachments?: FileAttachmentsDTO;
|
|
@@ -3116,6 +3183,7 @@ export interface PostMenuV3DraftItemBody {
|
|
|
3116
3183
|
tax_tag_code?: string;
|
|
3117
3184
|
tags?: string[];
|
|
3118
3185
|
is_featured?: boolean;
|
|
3186
|
+
tax_jwo_code?: string;
|
|
3119
3187
|
applied_diff_snapshot?: Record<string, any>;
|
|
3120
3188
|
brand?: DraftBrandDTO;
|
|
3121
3189
|
categories?: DraftCategoryToItemRelationshipDTO[];
|
|
@@ -3171,6 +3239,7 @@ export interface PatchMenuV3DraftItemBody {
|
|
|
3171
3239
|
tax_tag_code?: string;
|
|
3172
3240
|
tags?: string[];
|
|
3173
3241
|
is_featured?: boolean;
|
|
3242
|
+
tax_jwo_code?: string;
|
|
3174
3243
|
applied_diff_snapshot?: Record<string, any>;
|
|
3175
3244
|
version?: number;
|
|
3176
3245
|
brand?: DraftBrandDTO;
|
|
@@ -3239,6 +3308,7 @@ export type PostMenuV3DraftItemsBody = {
|
|
|
3239
3308
|
tax_tag_code?: string;
|
|
3240
3309
|
tags?: string[];
|
|
3241
3310
|
is_featured?: boolean;
|
|
3311
|
+
tax_jwo_code?: string;
|
|
3242
3312
|
applied_diff_snapshot?: Record<string, any>;
|
|
3243
3313
|
brand?: DraftBrandDTO;
|
|
3244
3314
|
categories?: DraftCategoryToItemRelationshipDTO[];
|
|
@@ -3307,6 +3377,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
|
|
|
3307
3377
|
tax_tag_code?: string;
|
|
3308
3378
|
tags?: string[];
|
|
3309
3379
|
is_featured?: boolean;
|
|
3380
|
+
tax_jwo_code?: string;
|
|
3310
3381
|
applied_diff_snapshot?: Record<string, any>;
|
|
3311
3382
|
brand?: DraftBrandDTO;
|
|
3312
3383
|
categories?: DraftCategoryToItemRelationshipDTO[];
|