@compassdigital/sdk.typescript 4.138.0 → 4.140.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 +149 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +167 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/catalog.d.ts +202 -0
- package/lib/interface/catalog.d.ts.map +1 -0
- package/lib/interface/catalog.js +5 -0
- package/lib/interface/catalog.js.map +1 -0
- package/lib/interface/consumer.d.ts +47 -1
- package/lib/interface/consumer.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +71 -0
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/order.d.ts +31 -0
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/promo.d.ts +1 -1
- package/lib/interface/promo.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +5 -0
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/messages/commands/SendPushNotificationCommand.d.ts +2 -1
- package/lib/messages/commands/SendPushNotificationCommand.d.ts.map +1 -1
- package/manifest.json +4 -0
- package/package.json +1 -1
- package/src/index.ts +406 -0
- package/src/interface/catalog.ts +325 -0
- package/src/interface/consumer.ts +55 -1
- package/src/interface/menu.ts +89 -0
- package/src/interface/order.ts +52 -0
- package/src/interface/promo.ts +1 -1
- package/src/interface/shoppingcart.ts +5 -0
- package/src/messages/commands/SendPushNotificationCommand.ts +2 -1
package/src/index.ts
CHANGED
|
@@ -998,12 +998,49 @@ import {
|
|
|
998
998
|
PostMenuV4ScheduleMenuResponse,
|
|
999
999
|
PostMenuV4UnscheduleMenuBody,
|
|
1000
1000
|
PostMenuV4UnscheduleMenuResponse,
|
|
1001
|
+
GetMenuV4MenuQuery,
|
|
1002
|
+
GetMenuV4MenuResponse,
|
|
1003
|
+
GetMenuV4CategoryQuery,
|
|
1004
|
+
GetMenuV4CategoryResponse,
|
|
1001
1005
|
PostMenuV4CategoryAttachmentQuery,
|
|
1002
1006
|
PostMenuV4CategoryAttachmentResponse,
|
|
1003
1007
|
DeleteMenuV4CategoryDetachItemsBody,
|
|
1004
1008
|
DeleteMenuV4CategoryDetachItemsResponse,
|
|
1005
1009
|
} from './interface/menu';
|
|
1006
1010
|
|
|
1011
|
+
import {
|
|
1012
|
+
GetCatalogStatusQuery,
|
|
1013
|
+
GetCatalogStatusResponse,
|
|
1014
|
+
GetCatalogConnectionsStatusQuery,
|
|
1015
|
+
GetCatalogConnectionsStatusResponse,
|
|
1016
|
+
PostCatalogBody,
|
|
1017
|
+
PostCatalogResponse,
|
|
1018
|
+
PatchCatalogBody,
|
|
1019
|
+
PatchCatalogResponse,
|
|
1020
|
+
GetCatalogQuery,
|
|
1021
|
+
GetCatalogResponse,
|
|
1022
|
+
DeleteCatalogResponse,
|
|
1023
|
+
PostCatalogItemBody,
|
|
1024
|
+
PostCatalogItemResponse,
|
|
1025
|
+
PostCatalogItemsBulkBody,
|
|
1026
|
+
PostCatalogItemsBulkResponse,
|
|
1027
|
+
PatchCatalogItemBody,
|
|
1028
|
+
PatchCatalogItemResponse,
|
|
1029
|
+
DeleteCatalogItemResponse,
|
|
1030
|
+
PostListCatalogItemsBody,
|
|
1031
|
+
PostListCatalogItemsResponse,
|
|
1032
|
+
GetListCatalogItemsQuery,
|
|
1033
|
+
GetListCatalogItemsResponse,
|
|
1034
|
+
PostCloneCatalogResponse,
|
|
1035
|
+
PostCatalogBaseItemBody,
|
|
1036
|
+
PostCatalogBaseItemResponse,
|
|
1037
|
+
GetCatalogBaseItemsQuery,
|
|
1038
|
+
GetCatalogBaseItemsBody,
|
|
1039
|
+
GetCatalogBaseItemsResponse,
|
|
1040
|
+
GetCatalogBaseItemQuery,
|
|
1041
|
+
GetCatalogBaseItemResponse,
|
|
1042
|
+
} from './interface/catalog';
|
|
1043
|
+
|
|
1007
1044
|
import {
|
|
1008
1045
|
GetNotificationsQuery,
|
|
1009
1046
|
GetNotificationsResponse,
|
|
@@ -10841,6 +10878,43 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
10841
10878
|
);
|
|
10842
10879
|
}
|
|
10843
10880
|
|
|
10881
|
+
/**
|
|
10882
|
+
* GET /menu/v4/menu/{id}
|
|
10883
|
+
*
|
|
10884
|
+
* @param id
|
|
10885
|
+
* @param options - additional request options
|
|
10886
|
+
*/
|
|
10887
|
+
get_menu_v4_menu(
|
|
10888
|
+
id: string,
|
|
10889
|
+
options?: {
|
|
10890
|
+
query?: GetMenuV4MenuQuery;
|
|
10891
|
+
} & RequestOptions,
|
|
10892
|
+
): ResponsePromise<GetMenuV4MenuResponse> {
|
|
10893
|
+
return this.request('menu', '/menu/v4/menu/{id}', 'GET', `/menu/v4/menu/${id}`, null, options);
|
|
10894
|
+
}
|
|
10895
|
+
|
|
10896
|
+
/**
|
|
10897
|
+
* GET /menu/v4/category/{id}
|
|
10898
|
+
*
|
|
10899
|
+
* @param id
|
|
10900
|
+
* @param options - additional request options
|
|
10901
|
+
*/
|
|
10902
|
+
get_menu_v4_category(
|
|
10903
|
+
id: string,
|
|
10904
|
+
options?: {
|
|
10905
|
+
query?: GetMenuV4CategoryQuery;
|
|
10906
|
+
} & RequestOptions,
|
|
10907
|
+
): ResponsePromise<GetMenuV4CategoryResponse> {
|
|
10908
|
+
return this.request(
|
|
10909
|
+
'menu',
|
|
10910
|
+
'/menu/v4/category/{id}',
|
|
10911
|
+
'GET',
|
|
10912
|
+
`/menu/v4/category/${id}`,
|
|
10913
|
+
null,
|
|
10914
|
+
options,
|
|
10915
|
+
);
|
|
10916
|
+
}
|
|
10917
|
+
|
|
10844
10918
|
/**
|
|
10845
10919
|
* POST /menu/v4/category/{id}/attachment/{name}
|
|
10846
10920
|
*
|
|
@@ -10887,6 +10961,338 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
10887
10961
|
);
|
|
10888
10962
|
}
|
|
10889
10963
|
|
|
10964
|
+
/**
|
|
10965
|
+
* GET /catalog/status - Get the status of the Catalog service
|
|
10966
|
+
*
|
|
10967
|
+
* @param options - additional request options
|
|
10968
|
+
*/
|
|
10969
|
+
get_catalog_status(
|
|
10970
|
+
options?: {
|
|
10971
|
+
query?: GetCatalogStatusQuery;
|
|
10972
|
+
} & RequestOptions,
|
|
10973
|
+
): ResponsePromise<GetCatalogStatusResponse> {
|
|
10974
|
+
return this.request('catalog', '/catalog/status', 'GET', `/catalog/status`, null, options);
|
|
10975
|
+
}
|
|
10976
|
+
|
|
10977
|
+
/**
|
|
10978
|
+
* GET /catalog/status/connections - Get the status of Catalog database connections
|
|
10979
|
+
*
|
|
10980
|
+
* @param options - additional request options
|
|
10981
|
+
*/
|
|
10982
|
+
get_catalog_connections_status(
|
|
10983
|
+
options?: {
|
|
10984
|
+
query?: GetCatalogConnectionsStatusQuery;
|
|
10985
|
+
} & RequestOptions,
|
|
10986
|
+
): ResponsePromise<GetCatalogConnectionsStatusResponse> {
|
|
10987
|
+
return this.request(
|
|
10988
|
+
'catalog',
|
|
10989
|
+
'/catalog/status/connections',
|
|
10990
|
+
'GET',
|
|
10991
|
+
`/catalog/status/connections`,
|
|
10992
|
+
null,
|
|
10993
|
+
options,
|
|
10994
|
+
);
|
|
10995
|
+
}
|
|
10996
|
+
|
|
10997
|
+
/**
|
|
10998
|
+
* POST /catalog/v1/catalog - Create a new catalog
|
|
10999
|
+
*
|
|
11000
|
+
* @param body
|
|
11001
|
+
* @param options - additional request options
|
|
11002
|
+
*/
|
|
11003
|
+
post_catalog(
|
|
11004
|
+
body: PostCatalogBody,
|
|
11005
|
+
options?: RequestOptions,
|
|
11006
|
+
): ResponsePromise<PostCatalogResponse> {
|
|
11007
|
+
return this.request(
|
|
11008
|
+
'catalog',
|
|
11009
|
+
'/catalog/v1/catalog',
|
|
11010
|
+
'POST',
|
|
11011
|
+
`/catalog/v1/catalog`,
|
|
11012
|
+
body,
|
|
11013
|
+
options,
|
|
11014
|
+
);
|
|
11015
|
+
}
|
|
11016
|
+
|
|
11017
|
+
/**
|
|
11018
|
+
* PATCH /catalog/v1/catalog/{id} - Update a catalog
|
|
11019
|
+
*
|
|
11020
|
+
* @param id
|
|
11021
|
+
* @param body
|
|
11022
|
+
* @param options - additional request options
|
|
11023
|
+
*/
|
|
11024
|
+
patch_catalog(
|
|
11025
|
+
id: number,
|
|
11026
|
+
body: PatchCatalogBody,
|
|
11027
|
+
options?: RequestOptions,
|
|
11028
|
+
): ResponsePromise<PatchCatalogResponse> {
|
|
11029
|
+
return this.request(
|
|
11030
|
+
'catalog',
|
|
11031
|
+
'/catalog/v1/catalog/{id}',
|
|
11032
|
+
'PATCH',
|
|
11033
|
+
`/catalog/v1/catalog/${id}`,
|
|
11034
|
+
body,
|
|
11035
|
+
options,
|
|
11036
|
+
);
|
|
11037
|
+
}
|
|
11038
|
+
|
|
11039
|
+
/**
|
|
11040
|
+
* GET /catalog/v1/catalog/{id} - Get a catalog
|
|
11041
|
+
*
|
|
11042
|
+
* @param id
|
|
11043
|
+
* @param options - additional request options
|
|
11044
|
+
*/
|
|
11045
|
+
get_catalog(
|
|
11046
|
+
id: number,
|
|
11047
|
+
options?: {
|
|
11048
|
+
query?: GetCatalogQuery;
|
|
11049
|
+
} & RequestOptions,
|
|
11050
|
+
): ResponsePromise<GetCatalogResponse> {
|
|
11051
|
+
return this.request(
|
|
11052
|
+
'catalog',
|
|
11053
|
+
'/catalog/v1/catalog/{id}',
|
|
11054
|
+
'GET',
|
|
11055
|
+
`/catalog/v1/catalog/${id}`,
|
|
11056
|
+
null,
|
|
11057
|
+
options,
|
|
11058
|
+
);
|
|
11059
|
+
}
|
|
11060
|
+
|
|
11061
|
+
/**
|
|
11062
|
+
* DELETE /catalog/v1/catalog/{id} - Delete a catalog
|
|
11063
|
+
*
|
|
11064
|
+
* @param id
|
|
11065
|
+
* @param options - additional request options
|
|
11066
|
+
*/
|
|
11067
|
+
delete_catalog(id: number, options?: RequestOptions): ResponsePromise<DeleteCatalogResponse> {
|
|
11068
|
+
return this.request(
|
|
11069
|
+
'catalog',
|
|
11070
|
+
'/catalog/v1/catalog/{id}',
|
|
11071
|
+
'DELETE',
|
|
11072
|
+
`/catalog/v1/catalog/${id}`,
|
|
11073
|
+
null,
|
|
11074
|
+
options,
|
|
11075
|
+
);
|
|
11076
|
+
}
|
|
11077
|
+
|
|
11078
|
+
/**
|
|
11079
|
+
* POST /catalog/v1/catalog/{id}/item - Create a new catalog item
|
|
11080
|
+
*
|
|
11081
|
+
* @param id
|
|
11082
|
+
* @param body
|
|
11083
|
+
* @param options - additional request options
|
|
11084
|
+
*/
|
|
11085
|
+
post_catalog_item(
|
|
11086
|
+
id: number,
|
|
11087
|
+
body: PostCatalogItemBody,
|
|
11088
|
+
options?: RequestOptions,
|
|
11089
|
+
): ResponsePromise<PostCatalogItemResponse> {
|
|
11090
|
+
return this.request(
|
|
11091
|
+
'catalog',
|
|
11092
|
+
'/catalog/v1/catalog/{id}/item',
|
|
11093
|
+
'POST',
|
|
11094
|
+
`/catalog/v1/catalog/${id}/item`,
|
|
11095
|
+
body,
|
|
11096
|
+
options,
|
|
11097
|
+
);
|
|
11098
|
+
}
|
|
11099
|
+
|
|
11100
|
+
/**
|
|
11101
|
+
* POST /catalog/v1/catalog/{id}/items/bulk - Bulk create catalog items
|
|
11102
|
+
*
|
|
11103
|
+
* @param id
|
|
11104
|
+
* @param body
|
|
11105
|
+
* @param options - additional request options
|
|
11106
|
+
*/
|
|
11107
|
+
post_catalog_items_bulk(
|
|
11108
|
+
id: number,
|
|
11109
|
+
body: PostCatalogItemsBulkBody,
|
|
11110
|
+
options?: RequestOptions,
|
|
11111
|
+
): ResponsePromise<PostCatalogItemsBulkResponse> {
|
|
11112
|
+
return this.request(
|
|
11113
|
+
'catalog',
|
|
11114
|
+
'/catalog/v1/catalog/{id}/items/bulk',
|
|
11115
|
+
'POST',
|
|
11116
|
+
`/catalog/v1/catalog/${id}/items/bulk`,
|
|
11117
|
+
body,
|
|
11118
|
+
options,
|
|
11119
|
+
);
|
|
11120
|
+
}
|
|
11121
|
+
|
|
11122
|
+
/**
|
|
11123
|
+
* PATCH /catalog/v1/catalog/{catalog_id}/item/{id} - Update a catalog item
|
|
11124
|
+
*
|
|
11125
|
+
* @param catalog_id
|
|
11126
|
+
* @param id
|
|
11127
|
+
* @param body
|
|
11128
|
+
* @param options - additional request options
|
|
11129
|
+
*/
|
|
11130
|
+
patch_catalog_item(
|
|
11131
|
+
catalog_id: number,
|
|
11132
|
+
id: number,
|
|
11133
|
+
body: PatchCatalogItemBody,
|
|
11134
|
+
options?: RequestOptions,
|
|
11135
|
+
): ResponsePromise<PatchCatalogItemResponse> {
|
|
11136
|
+
return this.request(
|
|
11137
|
+
'catalog',
|
|
11138
|
+
'/catalog/v1/catalog/{catalog_id}/item/{id}',
|
|
11139
|
+
'PATCH',
|
|
11140
|
+
`/catalog/v1/catalog/${catalog_id}/item/${id}`,
|
|
11141
|
+
body,
|
|
11142
|
+
options,
|
|
11143
|
+
);
|
|
11144
|
+
}
|
|
11145
|
+
|
|
11146
|
+
/**
|
|
11147
|
+
* DELETE /catalog/v1/catalog/{catalog_id}/item/{id} - Delete a catalog item
|
|
11148
|
+
*
|
|
11149
|
+
* @param catalog_id
|
|
11150
|
+
* @param id
|
|
11151
|
+
* @param options - additional request options
|
|
11152
|
+
*/
|
|
11153
|
+
delete_catalog_item(
|
|
11154
|
+
catalog_id: number,
|
|
11155
|
+
id: number,
|
|
11156
|
+
options?: RequestOptions,
|
|
11157
|
+
): ResponsePromise<DeleteCatalogItemResponse> {
|
|
11158
|
+
return this.request(
|
|
11159
|
+
'catalog',
|
|
11160
|
+
'/catalog/v1/catalog/{catalog_id}/item/{id}',
|
|
11161
|
+
'DELETE',
|
|
11162
|
+
`/catalog/v1/catalog/${catalog_id}/item/${id}`,
|
|
11163
|
+
null,
|
|
11164
|
+
options,
|
|
11165
|
+
);
|
|
11166
|
+
}
|
|
11167
|
+
|
|
11168
|
+
/**
|
|
11169
|
+
* POST /catalog/v1/catalog/{id}/items - List catalog items
|
|
11170
|
+
*
|
|
11171
|
+
* @param id
|
|
11172
|
+
* @param body
|
|
11173
|
+
* @param options - additional request options
|
|
11174
|
+
*/
|
|
11175
|
+
post_list_catalog_items(
|
|
11176
|
+
id: number,
|
|
11177
|
+
body: PostListCatalogItemsBody,
|
|
11178
|
+
options?: RequestOptions,
|
|
11179
|
+
): ResponsePromise<PostListCatalogItemsResponse> {
|
|
11180
|
+
return this.request(
|
|
11181
|
+
'catalog',
|
|
11182
|
+
'/catalog/v1/catalog/{id}/items',
|
|
11183
|
+
'POST',
|
|
11184
|
+
`/catalog/v1/catalog/${id}/items`,
|
|
11185
|
+
body,
|
|
11186
|
+
options,
|
|
11187
|
+
);
|
|
11188
|
+
}
|
|
11189
|
+
|
|
11190
|
+
/**
|
|
11191
|
+
* GET /catalog/v1/catalog/{id}/items - List catalog items
|
|
11192
|
+
*
|
|
11193
|
+
* @param id
|
|
11194
|
+
* @param options - additional request options
|
|
11195
|
+
*/
|
|
11196
|
+
get_list_catalog_items(
|
|
11197
|
+
id: number,
|
|
11198
|
+
options: {
|
|
11199
|
+
query: GetListCatalogItemsQuery;
|
|
11200
|
+
} & RequestOptions,
|
|
11201
|
+
): ResponsePromise<GetListCatalogItemsResponse> {
|
|
11202
|
+
return this.request(
|
|
11203
|
+
'catalog',
|
|
11204
|
+
'/catalog/v1/catalog/{id}/items',
|
|
11205
|
+
'GET',
|
|
11206
|
+
`/catalog/v1/catalog/${id}/items`,
|
|
11207
|
+
null,
|
|
11208
|
+
options,
|
|
11209
|
+
);
|
|
11210
|
+
}
|
|
11211
|
+
|
|
11212
|
+
/**
|
|
11213
|
+
* POST /catalog/v1/catalog/{id}/clone - Clone a catalog
|
|
11214
|
+
*
|
|
11215
|
+
* @param id
|
|
11216
|
+
* @param options - additional request options
|
|
11217
|
+
*/
|
|
11218
|
+
post_clone_catalog(
|
|
11219
|
+
id: number,
|
|
11220
|
+
options?: RequestOptions,
|
|
11221
|
+
): ResponsePromise<PostCloneCatalogResponse> {
|
|
11222
|
+
return this.request(
|
|
11223
|
+
'catalog',
|
|
11224
|
+
'/catalog/v1/catalog/{id}/clone',
|
|
11225
|
+
'POST',
|
|
11226
|
+
`/catalog/v1/catalog/${id}/clone`,
|
|
11227
|
+
null,
|
|
11228
|
+
options,
|
|
11229
|
+
);
|
|
11230
|
+
}
|
|
11231
|
+
|
|
11232
|
+
/**
|
|
11233
|
+
* POST /catalog/v1/base-item - Create a new base item
|
|
11234
|
+
*
|
|
11235
|
+
* @param body
|
|
11236
|
+
* @param options - additional request options
|
|
11237
|
+
*/
|
|
11238
|
+
post_catalog_base_item(
|
|
11239
|
+
body: PostCatalogBaseItemBody,
|
|
11240
|
+
options?: RequestOptions,
|
|
11241
|
+
): ResponsePromise<PostCatalogBaseItemResponse> {
|
|
11242
|
+
return this.request(
|
|
11243
|
+
'catalog',
|
|
11244
|
+
'/catalog/v1/base-item',
|
|
11245
|
+
'POST',
|
|
11246
|
+
`/catalog/v1/base-item`,
|
|
11247
|
+
body,
|
|
11248
|
+
options,
|
|
11249
|
+
);
|
|
11250
|
+
}
|
|
11251
|
+
|
|
11252
|
+
/**
|
|
11253
|
+
* GET /catalog/v1/base-item - List base items
|
|
11254
|
+
*
|
|
11255
|
+
* @param body
|
|
11256
|
+
* @param options - additional request options
|
|
11257
|
+
*/
|
|
11258
|
+
get_catalog_base_items(
|
|
11259
|
+
body: GetCatalogBaseItemsBody,
|
|
11260
|
+
options?: {
|
|
11261
|
+
query?: GetCatalogBaseItemsQuery;
|
|
11262
|
+
} & RequestOptions,
|
|
11263
|
+
): ResponsePromise<GetCatalogBaseItemsResponse> {
|
|
11264
|
+
return this.request(
|
|
11265
|
+
'catalog',
|
|
11266
|
+
'/catalog/v1/base-item',
|
|
11267
|
+
'GET',
|
|
11268
|
+
`/catalog/v1/base-item`,
|
|
11269
|
+
body,
|
|
11270
|
+
options,
|
|
11271
|
+
);
|
|
11272
|
+
}
|
|
11273
|
+
|
|
11274
|
+
/**
|
|
11275
|
+
* GET /catalog/v1/base-item/{id} - Get a base item by id
|
|
11276
|
+
*
|
|
11277
|
+
* @param id
|
|
11278
|
+
* @param options - additional request options
|
|
11279
|
+
*/
|
|
11280
|
+
get_catalog_base_item(
|
|
11281
|
+
id: string,
|
|
11282
|
+
options?: {
|
|
11283
|
+
query?: GetCatalogBaseItemQuery;
|
|
11284
|
+
} & RequestOptions,
|
|
11285
|
+
): ResponsePromise<GetCatalogBaseItemResponse> {
|
|
11286
|
+
return this.request(
|
|
11287
|
+
'catalog',
|
|
11288
|
+
'/catalog/v1/base-item/{id}',
|
|
11289
|
+
'GET',
|
|
11290
|
+
`/catalog/v1/base-item/${id}`,
|
|
11291
|
+
null,
|
|
11292
|
+
options,
|
|
11293
|
+
);
|
|
11294
|
+
}
|
|
11295
|
+
|
|
10890
11296
|
/**
|
|
10891
11297
|
* GET /notification - Get all notifications
|
|
10892
11298
|
*
|