@compassdigital/sdk.typescript 3.0.0-beta.16 → 3.0.0-beta.18

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/manifest.json CHANGED
@@ -99,6 +99,10 @@
99
99
  {
100
100
  "name": "logger",
101
101
  "swagger": "https://api.compassdigital.org/dev/logger/swagger.json"
102
+ },
103
+ {
104
+ "name": "menu",
105
+ "swagger": "https://api.compassdigital.org/dev/menu/swagger.json"
102
106
  }
103
107
  ]
104
108
  }
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "3.0.0-beta.16",
3
+ "version": "3.0.0-beta.18",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
+ "bin": "./bin/index.js",
6
7
  "main": "./lib/index.js",
7
8
  "types": "./lib/index.d.ts",
8
9
  "exports": {
@@ -25,8 +26,8 @@
25
26
  },
26
27
  "scripts": {
27
28
  "test": "jest",
28
- "gen": "ts-node gen.ts --run && tsc",
29
- "prepare": "rimraf ./lib && tsc"
29
+ "gen": "ts-node gen.ts --manifest ./manifest.json && tsc",
30
+ "prepare": "rimraf ./lib && tsc && tsc --esModuleInterop --outDir ./bin gen.ts"
30
31
  },
31
32
  "author": "",
32
33
  "license": "ISC",
@@ -44,6 +45,7 @@
44
45
  "prettier": "^2.3.2",
45
46
  "rimraf": "^3.0.2",
46
47
  "ts-jest": "^27.0.5",
47
- "ts-node": "^10.2.1"
48
+ "ts-node": "^10.2.1",
49
+ "yargs": "^17.1.1"
48
50
  }
49
51
  }
package/src/index.ts CHANGED
@@ -468,6 +468,51 @@ import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "./inte
468
468
 
469
469
  import { GetLoggerBrandStatusQuery, GetLoggerBrandStatusResponse } from "./interface/logger";
470
470
 
471
+ import {
472
+ GetMenuClientResponse,
473
+ GetMenusQuery,
474
+ GetMenusResponse,
475
+ PostMenuBody,
476
+ PostMenuResponse,
477
+ HeadMenuQuery,
478
+ HeadMenuResponse,
479
+ GetMenuQuery,
480
+ GetMenuResponse,
481
+ PutMenuQuery,
482
+ PutMenuBody,
483
+ PutMenuResponse,
484
+ DeleteMenuQuery,
485
+ DeleteMenuResponse,
486
+ PatchMenuQuery,
487
+ PatchMenuBody,
488
+ PatchMenuResponse,
489
+ PostMenuImportMenuBody,
490
+ PostMenuImportMenuResponse,
491
+ GetMenuItemResponse,
492
+ DeleteMenuItemResponse,
493
+ PostMenuItemBody,
494
+ PostMenuItemResponse,
495
+ GetMenuItemsQuery,
496
+ GetMenuItemsResponse,
497
+ PostMenuImportItemsCanteenResponse,
498
+ GetMenuLocationItemsResponse,
499
+ GetMenuLocationItemRandomQuery,
500
+ GetMenuLocationItemRandomResponse,
501
+ GetMenuLocationItemsRandomQuery,
502
+ GetMenuLocationItemsRandomResponse,
503
+ GetMenuSectorMenusResponse,
504
+ GetMenuCompanyMenusResponse,
505
+ PostMenuModifierGroupBody,
506
+ PostMenuModifierGroupResponse,
507
+ GetMenuModifierGroupResponse,
508
+ PutMenuModifierGroupBody,
509
+ PutMenuModifierGroupResponse,
510
+ DeleteMenuModifierGroupResponse,
511
+ GetMenuCompanyModifierGroupsResponse,
512
+ GetMenuCompanyModifierGroupsExportResponse,
513
+ GetMenuExportResponse,
514
+ } from "./interface/menu";
515
+
471
516
  import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
472
517
  export * from "./base";
473
518
 
@@ -4842,4 +4887,441 @@ export class ServiceClient extends BaseServiceClient {
4842
4887
  options
4843
4888
  );
4844
4889
  }
4890
+
4891
+ /**
4892
+ * GET /menu/client/{client_id} - Get menu client
4893
+ *
4894
+ * @param client_id
4895
+ * @param options - additional request options
4896
+ */
4897
+ get_menu_client(
4898
+ client_id: string,
4899
+ options?: RequestOptions
4900
+ ): ResponsePromise<GetMenuClientResponse> {
4901
+ return this.request(
4902
+ "menu",
4903
+ "get_menu_client",
4904
+ "get",
4905
+ `/menu/client/${client_id}`,
4906
+ null,
4907
+ options
4908
+ );
4909
+ }
4910
+
4911
+ /**
4912
+ * GET /menu - Get Menus or search for Menus
4913
+ *
4914
+ * @param options - additional request options
4915
+ */
4916
+ get_menus(
4917
+ options: {
4918
+ query: GetMenusQuery;
4919
+ } & RequestOptions
4920
+ ): ResponsePromise<GetMenusResponse> {
4921
+ return this.request("menu", "get_menus", "get", `/menu`, null, options);
4922
+ }
4923
+
4924
+ /**
4925
+ * POST /menu - Create a new Menu
4926
+ *
4927
+ * @param body
4928
+ * @param options - additional request options
4929
+ */
4930
+ post_menu(body: PostMenuBody, options?: RequestOptions): ResponsePromise<PostMenuResponse> {
4931
+ return this.request("menu", "post_menu", "post", `/menu`, body, options);
4932
+ }
4933
+
4934
+ /**
4935
+ * HEAD /menu/{id} - Get an individual Menu
4936
+ *
4937
+ * @param id - menu
4938
+ * @param options - additional request options
4939
+ */
4940
+ head_menu(
4941
+ id: string,
4942
+ options?: {
4943
+ query?: HeadMenuQuery;
4944
+ } & RequestOptions
4945
+ ): ResponsePromise<HeadMenuResponse> {
4946
+ return this.request("menu", "head_menu", "head", `/menu/${id}`, null, options);
4947
+ }
4948
+
4949
+ /**
4950
+ * GET /menu/{id} - Get an individual Menu
4951
+ *
4952
+ * @param id - menu
4953
+ * @param options - additional request options
4954
+ */
4955
+ get_menu(
4956
+ id: string,
4957
+ options?: {
4958
+ query?: GetMenuQuery;
4959
+ } & RequestOptions
4960
+ ): ResponsePromise<GetMenuResponse> {
4961
+ return this.request("menu", "get_menu", "get", `/menu/${id}`, null, options);
4962
+ }
4963
+
4964
+ /**
4965
+ * PUT /menu/{id} - Override a complete Menu
4966
+ *
4967
+ * @param id - menu
4968
+ * @param body
4969
+ * @param options - additional request options
4970
+ */
4971
+ put_menu(
4972
+ id: string,
4973
+ body: PutMenuBody,
4974
+ options?: {
4975
+ query?: PutMenuQuery;
4976
+ } & RequestOptions
4977
+ ): ResponsePromise<PutMenuResponse> {
4978
+ return this.request("menu", "put_menu", "put", `/menu/${id}`, body, options);
4979
+ }
4980
+
4981
+ /**
4982
+ * DELETE /menu/{id} - Delete a Menu
4983
+ *
4984
+ * @param id - menu
4985
+ * @param options - additional request options
4986
+ */
4987
+ delete_menu(
4988
+ id: string,
4989
+ options?: {
4990
+ query?: DeleteMenuQuery;
4991
+ } & RequestOptions
4992
+ ): ResponsePromise<DeleteMenuResponse> {
4993
+ return this.request("menu", "delete_menu", "delete", `/menu/${id}`, null, options);
4994
+ }
4995
+
4996
+ /**
4997
+ * PATCH /menu/{id} - Update a menu
4998
+ *
4999
+ * @param id - menu
5000
+ * @param body
5001
+ * @param options - additional request options
5002
+ */
5003
+ patch_menu(
5004
+ id: string,
5005
+ body: PatchMenuBody,
5006
+ options?: {
5007
+ query?: PatchMenuQuery;
5008
+ } & RequestOptions
5009
+ ): ResponsePromise<PatchMenuResponse> {
5010
+ return this.request("menu", "patch_menu", "patch", `/menu/${id}`, body, options);
5011
+ }
5012
+
5013
+ /**
5014
+ * POST /menu/import - Import an existing Menu
5015
+ *
5016
+ * @param body
5017
+ * @param options - additional request options
5018
+ */
5019
+ post_menu_import_menu(
5020
+ body: PostMenuImportMenuBody,
5021
+ options?: RequestOptions
5022
+ ): ResponsePromise<PostMenuImportMenuResponse> {
5023
+ return this.request("menu", "post_menu_import_menu", "post", `/menu/import`, body, options);
5024
+ }
5025
+
5026
+ /**
5027
+ * GET /menu/item/{id} - Get menu item
5028
+ *
5029
+ * @param id - Item ID
5030
+ * @param options - additional request options
5031
+ */
5032
+ get_menu_item(id: string, options?: RequestOptions): ResponsePromise<GetMenuItemResponse> {
5033
+ return this.request("menu", "get_menu_item", "get", `/menu/item/${id}`, null, options);
5034
+ }
5035
+
5036
+ /**
5037
+ * DELETE /menu/item/{id} - Delete a menu item
5038
+ *
5039
+ * @param id - Item ID
5040
+ * @param options - additional request options
5041
+ */
5042
+ delete_menu_item(id: string, options?: RequestOptions): ResponsePromise<DeleteMenuItemResponse> {
5043
+ return this.request("menu", "delete_menu_item", "delete", `/menu/item/${id}`, null, options);
5044
+ }
5045
+
5046
+ /**
5047
+ * POST /menu/item - Create a menu item
5048
+ *
5049
+ * @param body
5050
+ * @param options - additional request options
5051
+ */
5052
+ post_menu_item(
5053
+ body: PostMenuItemBody,
5054
+ options?: RequestOptions
5055
+ ): ResponsePromise<PostMenuItemResponse> {
5056
+ return this.request("menu", "post_menu_item", "post", `/menu/item`, body, options);
5057
+ }
5058
+
5059
+ /**
5060
+ * GET /menu/items - Search for menu items
5061
+ *
5062
+ * @param options - additional request options
5063
+ */
5064
+ get_menu_items(
5065
+ options: {
5066
+ query: GetMenuItemsQuery;
5067
+ } & RequestOptions
5068
+ ): ResponsePromise<GetMenuItemsResponse> {
5069
+ return this.request("menu", "get_menu_items", "get", `/menu/items`, null, options);
5070
+ }
5071
+
5072
+ /**
5073
+ * POST /menu/items/import/{location} - trigger import items
5074
+ *
5075
+ * @param location - Location ID
5076
+ * @param options - additional request options
5077
+ */
5078
+ post_menu_import_items_canteen(
5079
+ location: string,
5080
+ options?: RequestOptions
5081
+ ): ResponsePromise<PostMenuImportItemsCanteenResponse> {
5082
+ return this.request(
5083
+ "menu",
5084
+ "post_menu_import_items_canteen",
5085
+ "post",
5086
+ `/menu/items/import/${location}`,
5087
+ null,
5088
+ options
5089
+ );
5090
+ }
5091
+
5092
+ /**
5093
+ * GET /menu/items/location/{location} - Get all menu items for a location
5094
+ *
5095
+ * @param location - Location ID
5096
+ * @param options - additional request options
5097
+ */
5098
+ get_menu_location_items(
5099
+ location: string,
5100
+ options?: RequestOptions
5101
+ ): ResponsePromise<GetMenuLocationItemsResponse> {
5102
+ return this.request(
5103
+ "menu",
5104
+ "get_menu_location_items",
5105
+ "get",
5106
+ `/menu/items/location/${location}`,
5107
+ null,
5108
+ options
5109
+ );
5110
+ }
5111
+
5112
+ /**
5113
+ * GET /menu/item/random/location/{location} - Get a random item
5114
+ *
5115
+ * @param location - Location ID
5116
+ * @param options - additional request options
5117
+ */
5118
+ get_menu_location_item_random(
5119
+ location: string,
5120
+ options?: {
5121
+ query?: GetMenuLocationItemRandomQuery;
5122
+ } & RequestOptions
5123
+ ): ResponsePromise<GetMenuLocationItemRandomResponse> {
5124
+ return this.request(
5125
+ "menu",
5126
+ "get_menu_location_item_random",
5127
+ "get",
5128
+ `/menu/item/random/location/${location}`,
5129
+ null,
5130
+ options
5131
+ );
5132
+ }
5133
+
5134
+ /**
5135
+ * GET /menu/items/random/location/{location} - Get a set of random items
5136
+ *
5137
+ * @param location - Location ID
5138
+ * @param options - additional request options
5139
+ */
5140
+ get_menu_location_items_random(
5141
+ location: string,
5142
+ options?: {
5143
+ query?: GetMenuLocationItemsRandomQuery;
5144
+ } & RequestOptions
5145
+ ): ResponsePromise<GetMenuLocationItemsRandomResponse> {
5146
+ return this.request(
5147
+ "menu",
5148
+ "get_menu_location_items_random",
5149
+ "get",
5150
+ `/menu/items/random/location/${location}`,
5151
+ null,
5152
+ options
5153
+ );
5154
+ }
5155
+
5156
+ /**
5157
+ * GET /menu/sector/{sector} - Get menus that belong to sector
5158
+ *
5159
+ * @param sector - Sector ID
5160
+ * @param options - additional request options
5161
+ */
5162
+ get_menu_sector_menus(
5163
+ sector: string,
5164
+ options?: RequestOptions
5165
+ ): ResponsePromise<GetMenuSectorMenusResponse> {
5166
+ return this.request(
5167
+ "menu",
5168
+ "get_menu_sector_menus",
5169
+ "get",
5170
+ `/menu/sector/${sector}`,
5171
+ null,
5172
+ options
5173
+ );
5174
+ }
5175
+
5176
+ /**
5177
+ * GET /menu/company/{company} - Get menus that belong to company
5178
+ *
5179
+ * @param company - Company ID
5180
+ * @param options - additional request options
5181
+ */
5182
+ get_menu_company_menus(
5183
+ company: string,
5184
+ options?: RequestOptions
5185
+ ): ResponsePromise<GetMenuCompanyMenusResponse> {
5186
+ return this.request(
5187
+ "menu",
5188
+ "get_menu_company_menus",
5189
+ "get",
5190
+ `/menu/company/${company}`,
5191
+ null,
5192
+ options
5193
+ );
5194
+ }
5195
+
5196
+ /**
5197
+ * POST /menu/modifier/group - Create a new Menu Modifier Group
5198
+ *
5199
+ * @param body
5200
+ * @param options - additional request options
5201
+ */
5202
+ post_menu_modifier_group(
5203
+ body: PostMenuModifierGroupBody,
5204
+ options?: RequestOptions
5205
+ ): ResponsePromise<PostMenuModifierGroupResponse> {
5206
+ return this.request(
5207
+ "menu",
5208
+ "post_menu_modifier_group",
5209
+ "post",
5210
+ `/menu/modifier/group`,
5211
+ body,
5212
+ options
5213
+ );
5214
+ }
5215
+
5216
+ /**
5217
+ * GET /menu/modifier/group/{id} - Get a Menu Modifier Group
5218
+ *
5219
+ * @param id - modifier_group
5220
+ * @param options - additional request options
5221
+ */
5222
+ get_menu_modifier_group(
5223
+ id: string,
5224
+ options?: RequestOptions
5225
+ ): ResponsePromise<GetMenuModifierGroupResponse> {
5226
+ return this.request(
5227
+ "menu",
5228
+ "get_menu_modifier_group",
5229
+ "get",
5230
+ `/menu/modifier/group/${id}`,
5231
+ null,
5232
+ options
5233
+ );
5234
+ }
5235
+
5236
+ /**
5237
+ * PUT /menu/modifier/group/{id} - Update a Menu Modifier Group
5238
+ *
5239
+ * @param id - modifier_group
5240
+ * @param body
5241
+ * @param options - additional request options
5242
+ */
5243
+ put_menu_modifier_group(
5244
+ id: string,
5245
+ body: PutMenuModifierGroupBody,
5246
+ options?: RequestOptions
5247
+ ): ResponsePromise<PutMenuModifierGroupResponse> {
5248
+ return this.request(
5249
+ "menu",
5250
+ "put_menu_modifier_group",
5251
+ "put",
5252
+ `/menu/modifier/group/${id}`,
5253
+ body,
5254
+ options
5255
+ );
5256
+ }
5257
+
5258
+ /**
5259
+ * DELETE /menu/modifier/group/{id} - Delete a Menu Modifier Group
5260
+ *
5261
+ * @param id - modifier_group
5262
+ * @param options - additional request options
5263
+ */
5264
+ delete_menu_modifier_group(
5265
+ id: string,
5266
+ options?: RequestOptions
5267
+ ): ResponsePromise<DeleteMenuModifierGroupResponse> {
5268
+ return this.request(
5269
+ "menu",
5270
+ "delete_menu_modifier_group",
5271
+ "delete",
5272
+ `/menu/modifier/group/${id}`,
5273
+ null,
5274
+ options
5275
+ );
5276
+ }
5277
+
5278
+ /**
5279
+ * GET /menu/modifier/group/company/{company} - Get the modifier groups that belong to company
5280
+ *
5281
+ * @param company - Company ID
5282
+ * @param options - additional request options
5283
+ */
5284
+ get_menu_company_modifier_groups(
5285
+ company: string,
5286
+ options?: RequestOptions
5287
+ ): ResponsePromise<GetMenuCompanyModifierGroupsResponse> {
5288
+ return this.request(
5289
+ "menu",
5290
+ "get_menu_company_modifier_groups",
5291
+ "get",
5292
+ `/menu/modifier/group/company/${company}`,
5293
+ null,
5294
+ options
5295
+ );
5296
+ }
5297
+
5298
+ /**
5299
+ * GET /menu/modifier/group/company/{company}/export - Export company modifier groups to zipped excel file.
5300
+ *
5301
+ * @param company - Company ID
5302
+ * @param options - additional request options
5303
+ */
5304
+ get_menu_company_modifier_groups_export(
5305
+ company: string,
5306
+ options?: RequestOptions
5307
+ ): ResponsePromise<GetMenuCompanyModifierGroupsExportResponse> {
5308
+ return this.request(
5309
+ "menu",
5310
+ "get_menu_company_modifier_groups_export",
5311
+ "get",
5312
+ `/menu/modifier/group/company/${company}/export`,
5313
+ null,
5314
+ options
5315
+ );
5316
+ }
5317
+
5318
+ /**
5319
+ * GET /menu/{id}/export - Export menu set to zipped excel file.
5320
+ *
5321
+ * @param id - menu; TODO: cannot use compassdigital.id as path parameter
5322
+ * @param options - additional request options
5323
+ */
5324
+ get_menu_export(id: string, options?: RequestOptions): ResponsePromise<GetMenuExportResponse> {
5325
+ return this.request("menu", "get_menu_export", "get", `/menu/${id}/export`, null, options);
5326
+ }
4845
5327
  }