@thelllabs/winehaus-sdk 0.0.6 → 0.0.7
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/dist/cjs/api/api.js +561 -1
- package/dist/esm/api/api.js +561 -1
- package/dist/types/api/api.d.ts +1814 -158
- package/dist/umd/index.ts +561 -1
- package/package.json +1 -1
package/dist/types/api/api.d.ts
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
export interface CreateNameOnlyEntityDto {
|
|
2
|
+
/** [SYSTEM ADMIN ONLY] It enables the entity for ALL tenants */
|
|
3
|
+
isGlobal?: boolean;
|
|
4
|
+
name: string;
|
|
5
|
+
}
|
|
1
6
|
export interface CreateTenantUserDto {
|
|
2
7
|
/** @example "user@example.com" */
|
|
3
8
|
email: string;
|
|
@@ -9,6 +14,26 @@ export interface CreateTenantUserDto {
|
|
|
9
14
|
/** @example ["operator"] */
|
|
10
15
|
roles: TenantRoleEnum[];
|
|
11
16
|
}
|
|
17
|
+
export interface CreateWineDto {
|
|
18
|
+
/** @format uuid */
|
|
19
|
+
brandId: string;
|
|
20
|
+
description?: string;
|
|
21
|
+
/** [SYSTEM ADMIN ONLY] It enables the entity for ALL tenants */
|
|
22
|
+
isGlobal?: boolean;
|
|
23
|
+
location: WineLocationDto;
|
|
24
|
+
/** @format uuid */
|
|
25
|
+
producerId: string;
|
|
26
|
+
/** @format uuid */
|
|
27
|
+
styleId: string;
|
|
28
|
+
/** @format uuid */
|
|
29
|
+
typeId: string;
|
|
30
|
+
/** @format uuid */
|
|
31
|
+
varietalId: string;
|
|
32
|
+
/** @format uuid */
|
|
33
|
+
villageId: string;
|
|
34
|
+
/** @format uuid */
|
|
35
|
+
vineyardId: string;
|
|
36
|
+
}
|
|
12
37
|
export interface HttpExceptionDto {
|
|
13
38
|
/** @example null */
|
|
14
39
|
data?: object;
|
|
@@ -88,7 +113,7 @@ export interface TenantUserEntityDto {
|
|
|
88
113
|
/** @format uuid */
|
|
89
114
|
userId: string;
|
|
90
115
|
}
|
|
91
|
-
export interface
|
|
116
|
+
export interface TenantUserEntityPaginatedDto {
|
|
92
117
|
items: TenantUserEntityDto[];
|
|
93
118
|
links?: PaginationLinksDto;
|
|
94
119
|
meta: PaginationMetaDto;
|
|
@@ -97,6 +122,11 @@ export declare enum TenantUserStatusEnum {
|
|
|
97
122
|
Enabled = "enabled",
|
|
98
123
|
Blocked = "blocked"
|
|
99
124
|
}
|
|
125
|
+
export interface UpdateNameOnlyEntityDto {
|
|
126
|
+
/** [SYSTEM ADMIN ONLY] It enables the entity for ALL tenants */
|
|
127
|
+
isGlobal?: boolean;
|
|
128
|
+
name: string;
|
|
129
|
+
}
|
|
100
130
|
export interface UpdateUserPasswordDto {
|
|
101
131
|
/** @example "P@ssw0rd" */
|
|
102
132
|
currentPassword: string;
|
|
@@ -111,6 +141,26 @@ export interface UpdateUserPasswordDto {
|
|
|
111
141
|
export interface UpdateUserProfileDto {
|
|
112
142
|
name: string;
|
|
113
143
|
}
|
|
144
|
+
export interface UpdateWineDto {
|
|
145
|
+
/** @format uuid */
|
|
146
|
+
brandId: string;
|
|
147
|
+
description?: string;
|
|
148
|
+
/** [SYSTEM ADMIN ONLY] It enables the entity for ALL tenants */
|
|
149
|
+
isGlobal?: boolean;
|
|
150
|
+
location: WineLocationDto;
|
|
151
|
+
/** @format uuid */
|
|
152
|
+
producerId: string;
|
|
153
|
+
/** @format uuid */
|
|
154
|
+
styleId: string;
|
|
155
|
+
/** @format uuid */
|
|
156
|
+
typeId: string;
|
|
157
|
+
/** @format uuid */
|
|
158
|
+
varietalId: string;
|
|
159
|
+
/** @format uuid */
|
|
160
|
+
villageId: string;
|
|
161
|
+
/** @format uuid */
|
|
162
|
+
vineyardId: string;
|
|
163
|
+
}
|
|
114
164
|
export interface UserEntityDto {
|
|
115
165
|
/** @format date-time */
|
|
116
166
|
createdAt?: string;
|
|
@@ -123,6 +173,176 @@ export interface UserEntityDto {
|
|
|
123
173
|
/** @format date-time */
|
|
124
174
|
updatedAt: string;
|
|
125
175
|
}
|
|
176
|
+
export interface WineBrandEntityDto {
|
|
177
|
+
/** @format date-time */
|
|
178
|
+
createdAt?: string;
|
|
179
|
+
/** @format date-time */
|
|
180
|
+
deletedAt?: string | null;
|
|
181
|
+
/** @format uuid */
|
|
182
|
+
id: string;
|
|
183
|
+
name: string;
|
|
184
|
+
/** @format uuid */
|
|
185
|
+
tenantId?: string | null;
|
|
186
|
+
/** @format date-time */
|
|
187
|
+
updatedAt: string;
|
|
188
|
+
}
|
|
189
|
+
export interface WineBrandEntityPaginatedDto {
|
|
190
|
+
items: WineBrandEntityDto[];
|
|
191
|
+
links?: PaginationLinksDto;
|
|
192
|
+
meta: PaginationMetaDto;
|
|
193
|
+
}
|
|
194
|
+
export interface WineEntityDto {
|
|
195
|
+
brand: WineBrandEntityDto;
|
|
196
|
+
/** @format uuid */
|
|
197
|
+
brandId: string;
|
|
198
|
+
/** @format date-time */
|
|
199
|
+
createdAt?: string;
|
|
200
|
+
/** @format date-time */
|
|
201
|
+
deletedAt?: string | null;
|
|
202
|
+
description?: string;
|
|
203
|
+
/** @format uuid */
|
|
204
|
+
id: string;
|
|
205
|
+
location: WineLocationDto;
|
|
206
|
+
producer: WineProducerEntityDto;
|
|
207
|
+
/** @format uuid */
|
|
208
|
+
producerId: string;
|
|
209
|
+
style: WineStyleEntityDto;
|
|
210
|
+
/** @format uuid */
|
|
211
|
+
styleId: string;
|
|
212
|
+
/** @format uuid */
|
|
213
|
+
tenantId?: string | null;
|
|
214
|
+
type: WineTypeEntityDto;
|
|
215
|
+
/** @format uuid */
|
|
216
|
+
typeId: string;
|
|
217
|
+
/** @format date-time */
|
|
218
|
+
updatedAt: string;
|
|
219
|
+
varietal: WineVarietalEntityDto;
|
|
220
|
+
/** @format uuid */
|
|
221
|
+
varietalId: string;
|
|
222
|
+
village: WineVillageEntityDto;
|
|
223
|
+
/** @format uuid */
|
|
224
|
+
villageId: string;
|
|
225
|
+
vineyard: WineVineyardEntityDto;
|
|
226
|
+
/** @format uuid */
|
|
227
|
+
vineyardId: string;
|
|
228
|
+
}
|
|
229
|
+
export interface WineEntityPaginatedDto {
|
|
230
|
+
items: WineEntityDto[];
|
|
231
|
+
links?: PaginationLinksDto;
|
|
232
|
+
meta: PaginationMetaDto;
|
|
233
|
+
}
|
|
234
|
+
export interface WineLocationDto {
|
|
235
|
+
country: string;
|
|
236
|
+
region: string;
|
|
237
|
+
}
|
|
238
|
+
export interface WineProducerEntityDto {
|
|
239
|
+
/** @format date-time */
|
|
240
|
+
createdAt?: string;
|
|
241
|
+
/** @format date-time */
|
|
242
|
+
deletedAt?: string | null;
|
|
243
|
+
/** @format uuid */
|
|
244
|
+
id: string;
|
|
245
|
+
name: string;
|
|
246
|
+
/** @format uuid */
|
|
247
|
+
tenantId?: string | null;
|
|
248
|
+
/** @format date-time */
|
|
249
|
+
updatedAt: string;
|
|
250
|
+
}
|
|
251
|
+
export interface WineProducerEntityPaginatedDto {
|
|
252
|
+
items: WineProducerEntityDto[];
|
|
253
|
+
links?: PaginationLinksDto;
|
|
254
|
+
meta: PaginationMetaDto;
|
|
255
|
+
}
|
|
256
|
+
export interface WineStyleEntityDto {
|
|
257
|
+
/** @format date-time */
|
|
258
|
+
createdAt?: string;
|
|
259
|
+
/** @format date-time */
|
|
260
|
+
deletedAt?: string | null;
|
|
261
|
+
/** @format uuid */
|
|
262
|
+
id: string;
|
|
263
|
+
name: string;
|
|
264
|
+
/** @format uuid */
|
|
265
|
+
tenantId?: string | null;
|
|
266
|
+
/** @format date-time */
|
|
267
|
+
updatedAt: string;
|
|
268
|
+
}
|
|
269
|
+
export interface WineStyleEntityPaginatedDto {
|
|
270
|
+
items: WineStyleEntityDto[];
|
|
271
|
+
links?: PaginationLinksDto;
|
|
272
|
+
meta: PaginationMetaDto;
|
|
273
|
+
}
|
|
274
|
+
export interface WineTypeEntityDto {
|
|
275
|
+
/** @format date-time */
|
|
276
|
+
createdAt?: string;
|
|
277
|
+
/** @format date-time */
|
|
278
|
+
deletedAt?: string | null;
|
|
279
|
+
/** @format uuid */
|
|
280
|
+
id: string;
|
|
281
|
+
name: string;
|
|
282
|
+
/** @format uuid */
|
|
283
|
+
tenantId?: string | null;
|
|
284
|
+
/** @format date-time */
|
|
285
|
+
updatedAt: string;
|
|
286
|
+
}
|
|
287
|
+
export interface WineTypeEntityPaginatedDto {
|
|
288
|
+
items: WineTypeEntityDto[];
|
|
289
|
+
links?: PaginationLinksDto;
|
|
290
|
+
meta: PaginationMetaDto;
|
|
291
|
+
}
|
|
292
|
+
export interface WineVarietalEntityDto {
|
|
293
|
+
/** @format date-time */
|
|
294
|
+
createdAt?: string;
|
|
295
|
+
/** @format date-time */
|
|
296
|
+
deletedAt?: string | null;
|
|
297
|
+
/** @format uuid */
|
|
298
|
+
id: string;
|
|
299
|
+
name: string;
|
|
300
|
+
/** @format uuid */
|
|
301
|
+
tenantId?: string | null;
|
|
302
|
+
/** @format date-time */
|
|
303
|
+
updatedAt: string;
|
|
304
|
+
}
|
|
305
|
+
export interface WineVarietalEntityPaginatedDto {
|
|
306
|
+
items: WineVarietalEntityDto[];
|
|
307
|
+
links?: PaginationLinksDto;
|
|
308
|
+
meta: PaginationMetaDto;
|
|
309
|
+
}
|
|
310
|
+
export interface WineVillageEntityDto {
|
|
311
|
+
/** @format date-time */
|
|
312
|
+
createdAt?: string;
|
|
313
|
+
/** @format date-time */
|
|
314
|
+
deletedAt?: string | null;
|
|
315
|
+
/** @format uuid */
|
|
316
|
+
id: string;
|
|
317
|
+
name: string;
|
|
318
|
+
/** @format uuid */
|
|
319
|
+
tenantId?: string | null;
|
|
320
|
+
/** @format date-time */
|
|
321
|
+
updatedAt: string;
|
|
322
|
+
}
|
|
323
|
+
export interface WineVillageEntityPaginatedDto {
|
|
324
|
+
items: WineVillageEntityDto[];
|
|
325
|
+
links?: PaginationLinksDto;
|
|
326
|
+
meta: PaginationMetaDto;
|
|
327
|
+
}
|
|
328
|
+
export interface WineVineyardEntityDto {
|
|
329
|
+
/** @format date-time */
|
|
330
|
+
createdAt?: string;
|
|
331
|
+
/** @format date-time */
|
|
332
|
+
deletedAt?: string | null;
|
|
333
|
+
/** @format uuid */
|
|
334
|
+
id: string;
|
|
335
|
+
name: string;
|
|
336
|
+
/** @format uuid */
|
|
337
|
+
tenantId?: string | null;
|
|
338
|
+
/** @format date-time */
|
|
339
|
+
updatedAt: string;
|
|
340
|
+
}
|
|
341
|
+
export interface WineVineyardEntityPaginatedDto {
|
|
342
|
+
items: WineVineyardEntityDto[];
|
|
343
|
+
links?: PaginationLinksDto;
|
|
344
|
+
meta: PaginationMetaDto;
|
|
345
|
+
}
|
|
126
346
|
export declare namespace Auth {
|
|
127
347
|
/**
|
|
128
348
|
* No description
|
|
@@ -244,235 +464,1369 @@ export declare namespace Admin {
|
|
|
244
464
|
}
|
|
245
465
|
/**
|
|
246
466
|
* No description
|
|
247
|
-
* @tags Admin Tenant
|
|
248
|
-
* @name
|
|
249
|
-
* @request
|
|
467
|
+
* @tags Admin Tenant Wines
|
|
468
|
+
* @name CreateTenantWine
|
|
469
|
+
* @request POST:/admin/tenants/{tenantId}/wines
|
|
250
470
|
* @secure
|
|
251
|
-
* @response `
|
|
471
|
+
* @response `201` `WineEntityDto`
|
|
252
472
|
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
253
473
|
*/
|
|
254
|
-
namespace
|
|
474
|
+
namespace CreateTenantWine {
|
|
255
475
|
type RequestParams = {
|
|
256
476
|
tenantId: string;
|
|
257
|
-
userId: string;
|
|
258
477
|
};
|
|
259
478
|
type RequestQuery = {};
|
|
260
|
-
type RequestBody =
|
|
479
|
+
type RequestBody = CreateWineDto;
|
|
261
480
|
type RequestHeaders = {};
|
|
262
|
-
type ResponseBody =
|
|
481
|
+
type ResponseBody = WineEntityDto;
|
|
263
482
|
}
|
|
264
483
|
/**
|
|
265
484
|
* No description
|
|
266
|
-
* @tags Admin Tenant
|
|
267
|
-
* @name
|
|
268
|
-
* @request
|
|
485
|
+
* @tags Admin Tenant Wine Brands
|
|
486
|
+
* @name CreateTenantWineBrand
|
|
487
|
+
* @request POST:/admin/tenants/{tenantId}/wine-brands
|
|
269
488
|
* @secure
|
|
270
|
-
* @response `
|
|
489
|
+
* @response `201` `WineBrandEntityDto`
|
|
271
490
|
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
272
491
|
*/
|
|
273
|
-
namespace
|
|
492
|
+
namespace CreateTenantWineBrand {
|
|
274
493
|
type RequestParams = {
|
|
275
494
|
tenantId: string;
|
|
276
|
-
userId: string;
|
|
277
495
|
};
|
|
278
496
|
type RequestQuery = {};
|
|
279
|
-
type RequestBody =
|
|
497
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
280
498
|
type RequestHeaders = {};
|
|
281
|
-
type ResponseBody =
|
|
499
|
+
type ResponseBody = WineBrandEntityDto;
|
|
282
500
|
}
|
|
283
501
|
/**
|
|
284
502
|
* No description
|
|
285
|
-
* @tags Admin Tenant
|
|
286
|
-
* @name
|
|
287
|
-
* @request
|
|
503
|
+
* @tags Admin Tenant Wine Producers
|
|
504
|
+
* @name CreateTenantWineProducer
|
|
505
|
+
* @request POST:/admin/tenants/{tenantId}/wine-producers
|
|
288
506
|
* @secure
|
|
289
|
-
* @response `
|
|
507
|
+
* @response `201` `WineProducerEntityDto`
|
|
290
508
|
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
291
509
|
*/
|
|
292
|
-
namespace
|
|
510
|
+
namespace CreateTenantWineProducer {
|
|
293
511
|
type RequestParams = {
|
|
294
512
|
tenantId: string;
|
|
295
513
|
};
|
|
296
|
-
type RequestQuery = {
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
514
|
+
type RequestQuery = {};
|
|
515
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
516
|
+
type RequestHeaders = {};
|
|
517
|
+
type ResponseBody = WineProducerEntityDto;
|
|
518
|
+
}
|
|
519
|
+
/**
|
|
520
|
+
* No description
|
|
521
|
+
* @tags Admin Tenant Wine Styles
|
|
522
|
+
* @name CreateTenantWineStyle
|
|
523
|
+
* @request POST:/admin/tenants/{tenantId}/wine-styles
|
|
524
|
+
* @secure
|
|
525
|
+
* @response `201` `WineStyleEntityDto`
|
|
526
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
527
|
+
*/
|
|
528
|
+
namespace CreateTenantWineStyle {
|
|
529
|
+
type RequestParams = {
|
|
530
|
+
tenantId: string;
|
|
312
531
|
};
|
|
313
|
-
type
|
|
532
|
+
type RequestQuery = {};
|
|
533
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
314
534
|
type RequestHeaders = {};
|
|
315
|
-
type ResponseBody =
|
|
535
|
+
type ResponseBody = WineStyleEntityDto;
|
|
316
536
|
}
|
|
317
|
-
}
|
|
318
|
-
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from "axios";
|
|
319
|
-
export type QueryParamsType = Record<string | number, any>;
|
|
320
|
-
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
321
|
-
/** set parameter to `true` for call `securityWorker` for this request */
|
|
322
|
-
secure?: boolean;
|
|
323
|
-
/** request path */
|
|
324
|
-
path: string;
|
|
325
|
-
/** content type of request body */
|
|
326
|
-
type?: ContentType;
|
|
327
|
-
/** query params */
|
|
328
|
-
query?: QueryParamsType;
|
|
329
|
-
/** format of response (i.e. response.json() -> format: "json") */
|
|
330
|
-
format?: ResponseType;
|
|
331
|
-
/** request body */
|
|
332
|
-
body?: unknown;
|
|
333
|
-
}
|
|
334
|
-
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
|
|
335
|
-
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
|
|
336
|
-
securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
|
|
337
|
-
secure?: boolean;
|
|
338
|
-
format?: ResponseType;
|
|
339
|
-
}
|
|
340
|
-
export declare enum ContentType {
|
|
341
|
-
Json = "application/json",
|
|
342
|
-
JsonApi = "application/vnd.api+json",
|
|
343
|
-
FormData = "multipart/form-data",
|
|
344
|
-
UrlEncoded = "application/x-www-form-urlencoded",
|
|
345
|
-
Text = "text/plain"
|
|
346
|
-
}
|
|
347
|
-
export declare class HttpClient<SecurityDataType = unknown> {
|
|
348
|
-
instance: AxiosInstance;
|
|
349
|
-
private securityData;
|
|
350
|
-
private securityWorker?;
|
|
351
|
-
private secure?;
|
|
352
|
-
private format?;
|
|
353
|
-
constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
|
|
354
|
-
setSecurityData: (data: SecurityDataType | null) => void;
|
|
355
|
-
protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
|
|
356
|
-
protected stringifyFormItem(formItem: unknown): string;
|
|
357
|
-
protected createFormData(input: Record<string, unknown>): FormData;
|
|
358
|
-
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
|
|
359
|
-
}
|
|
360
|
-
/**
|
|
361
|
-
* @title winehaus-api
|
|
362
|
-
* @version 0.0.1
|
|
363
|
-
* @baseUrl http://localhost:3000
|
|
364
|
-
* @contact
|
|
365
|
-
*/
|
|
366
|
-
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
367
537
|
/**
|
|
368
538
|
* No description
|
|
369
|
-
*
|
|
370
|
-
* @
|
|
371
|
-
* @
|
|
372
|
-
* @
|
|
373
|
-
* @response `
|
|
539
|
+
* @tags Admin Tenant Wine Types
|
|
540
|
+
* @name CreateTenantWineType
|
|
541
|
+
* @request POST:/admin/tenants/{tenantId}/wine-types
|
|
542
|
+
* @secure
|
|
543
|
+
* @response `201` `WineTypeEntityDto`
|
|
544
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
374
545
|
*/
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
546
|
+
namespace CreateTenantWineType {
|
|
547
|
+
type RequestParams = {
|
|
548
|
+
tenantId: string;
|
|
549
|
+
};
|
|
550
|
+
type RequestQuery = {};
|
|
551
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
552
|
+
type RequestHeaders = {};
|
|
553
|
+
type ResponseBody = WineTypeEntityDto;
|
|
554
|
+
}
|
|
555
|
+
/**
|
|
556
|
+
* No description
|
|
557
|
+
* @tags Admin Tenant Wine Varietals
|
|
558
|
+
* @name CreateTenantWineVarietal
|
|
559
|
+
* @request POST:/admin/tenants/{tenantId}/wine-varietals
|
|
560
|
+
* @secure
|
|
561
|
+
* @response `201` `WineVarietalEntityDto`
|
|
562
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
563
|
+
*/
|
|
564
|
+
namespace CreateTenantWineVarietal {
|
|
565
|
+
type RequestParams = {
|
|
566
|
+
tenantId: string;
|
|
567
|
+
};
|
|
568
|
+
type RequestQuery = {};
|
|
569
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
570
|
+
type RequestHeaders = {};
|
|
571
|
+
type ResponseBody = WineVarietalEntityDto;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* No description
|
|
575
|
+
* @tags Admin Tenant Wine Villages
|
|
576
|
+
* @name CreateTenantWineVillage
|
|
577
|
+
* @request POST:/admin/tenants/{tenantId}/wine-villages
|
|
578
|
+
* @secure
|
|
579
|
+
* @response `201` `WineVillageEntityDto`
|
|
580
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
581
|
+
*/
|
|
582
|
+
namespace CreateTenantWineVillage {
|
|
583
|
+
type RequestParams = {
|
|
584
|
+
tenantId: string;
|
|
585
|
+
};
|
|
586
|
+
type RequestQuery = {};
|
|
587
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
588
|
+
type RequestHeaders = {};
|
|
589
|
+
type ResponseBody = WineVillageEntityDto;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* No description
|
|
593
|
+
* @tags Admin Tenant Wine Vineyards
|
|
594
|
+
* @name CreateTenantWineVineyard
|
|
595
|
+
* @request POST:/admin/tenants/{tenantId}/wine-vineyards
|
|
596
|
+
* @secure
|
|
597
|
+
* @response `201` `WineVineyardEntityDto`
|
|
598
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
599
|
+
*/
|
|
600
|
+
namespace CreateTenantWineVineyard {
|
|
601
|
+
type RequestParams = {
|
|
602
|
+
tenantId: string;
|
|
603
|
+
};
|
|
604
|
+
type RequestQuery = {};
|
|
605
|
+
type RequestBody = CreateNameOnlyEntityDto;
|
|
606
|
+
type RequestHeaders = {};
|
|
607
|
+
type ResponseBody = WineVineyardEntityDto;
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* No description
|
|
611
|
+
* @tags Admin Tenant Wines
|
|
612
|
+
* @name DeleteTenantWine
|
|
613
|
+
* @request DELETE:/admin/tenants/{tenantId}/wines/{wineId}
|
|
614
|
+
* @secure
|
|
615
|
+
* @response `204` `void`
|
|
616
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
617
|
+
*/
|
|
618
|
+
namespace DeleteTenantWine {
|
|
619
|
+
type RequestParams = {
|
|
620
|
+
tenantId: string;
|
|
621
|
+
wineId: string;
|
|
622
|
+
};
|
|
623
|
+
type RequestQuery = {};
|
|
624
|
+
type RequestBody = never;
|
|
625
|
+
type RequestHeaders = {};
|
|
626
|
+
type ResponseBody = void;
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* No description
|
|
630
|
+
* @tags Admin Tenant Wine Brands
|
|
631
|
+
* @name DeleteTenantWineBrand
|
|
632
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-brands/{brandId}
|
|
633
|
+
* @secure
|
|
634
|
+
* @response `204` `void`
|
|
635
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
636
|
+
*/
|
|
637
|
+
namespace DeleteTenantWineBrand {
|
|
638
|
+
type RequestParams = {
|
|
639
|
+
brandId: string;
|
|
640
|
+
tenantId: string;
|
|
641
|
+
};
|
|
642
|
+
type RequestQuery = {};
|
|
643
|
+
type RequestBody = never;
|
|
644
|
+
type RequestHeaders = {};
|
|
645
|
+
type ResponseBody = void;
|
|
646
|
+
}
|
|
647
|
+
/**
|
|
648
|
+
* No description
|
|
649
|
+
* @tags Admin Tenant Wine Producers
|
|
650
|
+
* @name DeleteTenantWineProducer
|
|
651
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-producers/{producerId}
|
|
652
|
+
* @secure
|
|
653
|
+
* @response `204` `void`
|
|
654
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
655
|
+
*/
|
|
656
|
+
namespace DeleteTenantWineProducer {
|
|
657
|
+
type RequestParams = {
|
|
658
|
+
producerId: string;
|
|
659
|
+
tenantId: string;
|
|
660
|
+
};
|
|
661
|
+
type RequestQuery = {};
|
|
662
|
+
type RequestBody = never;
|
|
663
|
+
type RequestHeaders = {};
|
|
664
|
+
type ResponseBody = void;
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* No description
|
|
668
|
+
* @tags Admin Tenant Wine Styles
|
|
669
|
+
* @name DeleteTenantWineStyle
|
|
670
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-styles/{styleId}
|
|
671
|
+
* @secure
|
|
672
|
+
* @response `204` `void`
|
|
673
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
674
|
+
*/
|
|
675
|
+
namespace DeleteTenantWineStyle {
|
|
676
|
+
type RequestParams = {
|
|
677
|
+
styleId: string;
|
|
678
|
+
tenantId: string;
|
|
679
|
+
};
|
|
680
|
+
type RequestQuery = {};
|
|
681
|
+
type RequestBody = never;
|
|
682
|
+
type RequestHeaders = {};
|
|
683
|
+
type ResponseBody = void;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* No description
|
|
687
|
+
* @tags Admin Tenant Wine Types
|
|
688
|
+
* @name DeleteTenantWineType
|
|
689
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-types/{typeId}
|
|
690
|
+
* @secure
|
|
691
|
+
* @response `204` `void`
|
|
692
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
693
|
+
*/
|
|
694
|
+
namespace DeleteTenantWineType {
|
|
695
|
+
type RequestParams = {
|
|
696
|
+
tenantId: string;
|
|
697
|
+
typeId: string;
|
|
698
|
+
};
|
|
699
|
+
type RequestQuery = {};
|
|
700
|
+
type RequestBody = never;
|
|
701
|
+
type RequestHeaders = {};
|
|
702
|
+
type ResponseBody = void;
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* No description
|
|
706
|
+
* @tags Admin Tenant Wine Varietals
|
|
707
|
+
* @name DeleteTenantWineVarietal
|
|
708
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-varietals/{varietalId}
|
|
709
|
+
* @secure
|
|
710
|
+
* @response `204` `void`
|
|
711
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
712
|
+
*/
|
|
713
|
+
namespace DeleteTenantWineVarietal {
|
|
714
|
+
type RequestParams = {
|
|
715
|
+
tenantId: string;
|
|
716
|
+
varietalId: string;
|
|
717
|
+
};
|
|
718
|
+
type RequestQuery = {};
|
|
719
|
+
type RequestBody = never;
|
|
720
|
+
type RequestHeaders = {};
|
|
721
|
+
type ResponseBody = void;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* No description
|
|
725
|
+
* @tags Admin Tenant Wine Villages
|
|
726
|
+
* @name DeleteTenantWineVillage
|
|
727
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-villages/{villageId}
|
|
728
|
+
* @secure
|
|
729
|
+
* @response `204` `void`
|
|
730
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
731
|
+
*/
|
|
732
|
+
namespace DeleteTenantWineVillage {
|
|
733
|
+
type RequestParams = {
|
|
734
|
+
tenantId: string;
|
|
735
|
+
villageId: string;
|
|
736
|
+
};
|
|
737
|
+
type RequestQuery = {};
|
|
738
|
+
type RequestBody = never;
|
|
739
|
+
type RequestHeaders = {};
|
|
740
|
+
type ResponseBody = void;
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* No description
|
|
744
|
+
* @tags Admin Tenant Wine Vineyards
|
|
745
|
+
* @name DeleteTenantWineVineyard
|
|
746
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-vineyards/{vineyardId}
|
|
747
|
+
* @secure
|
|
748
|
+
* @response `204` `void`
|
|
749
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
750
|
+
*/
|
|
751
|
+
namespace DeleteTenantWineVineyard {
|
|
752
|
+
type RequestParams = {
|
|
753
|
+
tenantId: string;
|
|
754
|
+
vineyardId: string;
|
|
755
|
+
};
|
|
756
|
+
type RequestQuery = {};
|
|
757
|
+
type RequestBody = never;
|
|
758
|
+
type RequestHeaders = {};
|
|
759
|
+
type ResponseBody = void;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* No description
|
|
763
|
+
* @tags Admin Tenant Users
|
|
764
|
+
* @name DisableTenantUser
|
|
765
|
+
* @request PATCH:/admin/tenants/{tenantId}/users/{userId}/disable
|
|
766
|
+
* @secure
|
|
767
|
+
* @response `204` `void`
|
|
768
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
769
|
+
*/
|
|
770
|
+
namespace DisableTenantUser {
|
|
771
|
+
type RequestParams = {
|
|
772
|
+
tenantId: string;
|
|
773
|
+
userId: string;
|
|
774
|
+
};
|
|
775
|
+
type RequestQuery = {};
|
|
776
|
+
type RequestBody = never;
|
|
777
|
+
type RequestHeaders = {};
|
|
778
|
+
type ResponseBody = void;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* No description
|
|
782
|
+
* @tags Admin Tenant Users
|
|
783
|
+
* @name EnableTenantUser
|
|
784
|
+
* @request PATCH:/admin/tenants/{tenantId}/users/{userId}/enable
|
|
785
|
+
* @secure
|
|
786
|
+
* @response `204` `void`
|
|
787
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
788
|
+
*/
|
|
789
|
+
namespace EnableTenantUser {
|
|
790
|
+
type RequestParams = {
|
|
791
|
+
tenantId: string;
|
|
792
|
+
userId: string;
|
|
793
|
+
};
|
|
794
|
+
type RequestQuery = {};
|
|
795
|
+
type RequestBody = never;
|
|
796
|
+
type RequestHeaders = {};
|
|
797
|
+
type ResponseBody = void;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* No description
|
|
801
|
+
* @tags Admin Tenant Wine Brands
|
|
802
|
+
* @name GetTenantWineBrandById
|
|
803
|
+
* @request GET:/admin/tenants/{tenantId}/wine-brands/{brandId}
|
|
804
|
+
* @secure
|
|
805
|
+
* @response `200` `WineBrandEntityDto`
|
|
806
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
807
|
+
*/
|
|
808
|
+
namespace GetTenantWineBrandById {
|
|
809
|
+
type RequestParams = {
|
|
810
|
+
brandId: string;
|
|
811
|
+
tenantId: string;
|
|
812
|
+
};
|
|
813
|
+
type RequestQuery = {};
|
|
814
|
+
type RequestBody = never;
|
|
815
|
+
type RequestHeaders = {};
|
|
816
|
+
type ResponseBody = WineBrandEntityDto;
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* No description
|
|
820
|
+
* @tags Admin Tenant Wines
|
|
821
|
+
* @name GetTenantWineById
|
|
822
|
+
* @request GET:/admin/tenants/{tenantId}/wines/{wineId}
|
|
823
|
+
* @secure
|
|
824
|
+
* @response `200` `WineEntityDto`
|
|
825
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
826
|
+
*/
|
|
827
|
+
namespace GetTenantWineById {
|
|
828
|
+
type RequestParams = {
|
|
829
|
+
tenantId: string;
|
|
830
|
+
wineId: string;
|
|
831
|
+
};
|
|
832
|
+
type RequestQuery = {};
|
|
833
|
+
type RequestBody = never;
|
|
834
|
+
type RequestHeaders = {};
|
|
835
|
+
type ResponseBody = WineEntityDto;
|
|
836
|
+
}
|
|
837
|
+
/**
|
|
838
|
+
* No description
|
|
839
|
+
* @tags Admin Tenant Wine Producers
|
|
840
|
+
* @name GetTenantWineProducerById
|
|
841
|
+
* @request GET:/admin/tenants/{tenantId}/wine-producers/{producerId}
|
|
842
|
+
* @secure
|
|
843
|
+
* @response `200` `WineProducerEntityDto`
|
|
844
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
845
|
+
*/
|
|
846
|
+
namespace GetTenantWineProducerById {
|
|
847
|
+
type RequestParams = {
|
|
848
|
+
producerId: string;
|
|
849
|
+
tenantId: string;
|
|
850
|
+
};
|
|
851
|
+
type RequestQuery = {};
|
|
852
|
+
type RequestBody = never;
|
|
853
|
+
type RequestHeaders = {};
|
|
854
|
+
type ResponseBody = WineProducerEntityDto;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* No description
|
|
858
|
+
* @tags Admin Tenant Wine Styles
|
|
859
|
+
* @name GetTenantWineStyleById
|
|
860
|
+
* @request GET:/admin/tenants/{tenantId}/wine-styles/{styleId}
|
|
861
|
+
* @secure
|
|
862
|
+
* @response `200` `WineStyleEntityDto`
|
|
863
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
864
|
+
*/
|
|
865
|
+
namespace GetTenantWineStyleById {
|
|
866
|
+
type RequestParams = {
|
|
867
|
+
styleId: string;
|
|
868
|
+
tenantId: string;
|
|
869
|
+
};
|
|
870
|
+
type RequestQuery = {};
|
|
871
|
+
type RequestBody = never;
|
|
872
|
+
type RequestHeaders = {};
|
|
873
|
+
type ResponseBody = WineStyleEntityDto;
|
|
874
|
+
}
|
|
875
|
+
/**
|
|
876
|
+
* No description
|
|
877
|
+
* @tags Admin Tenant Wine Types
|
|
878
|
+
* @name GetTenantWineTypeById
|
|
879
|
+
* @request GET:/admin/tenants/{tenantId}/wine-types/{typeId}
|
|
880
|
+
* @secure
|
|
881
|
+
* @response `200` `WineTypeEntityDto`
|
|
882
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
883
|
+
*/
|
|
884
|
+
namespace GetTenantWineTypeById {
|
|
885
|
+
type RequestParams = {
|
|
886
|
+
tenantId: string;
|
|
887
|
+
typeId: string;
|
|
888
|
+
};
|
|
889
|
+
type RequestQuery = {};
|
|
890
|
+
type RequestBody = never;
|
|
891
|
+
type RequestHeaders = {};
|
|
892
|
+
type ResponseBody = WineTypeEntityDto;
|
|
893
|
+
}
|
|
894
|
+
/**
|
|
895
|
+
* No description
|
|
896
|
+
* @tags Admin Tenant Wine Varietals
|
|
897
|
+
* @name GetTenantWineVarietalById
|
|
898
|
+
* @request GET:/admin/tenants/{tenantId}/wine-varietals/{varietalId}
|
|
899
|
+
* @secure
|
|
900
|
+
* @response `200` `WineVarietalEntityDto`
|
|
901
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
902
|
+
*/
|
|
903
|
+
namespace GetTenantWineVarietalById {
|
|
904
|
+
type RequestParams = {
|
|
905
|
+
tenantId: string;
|
|
906
|
+
varietalId: string;
|
|
907
|
+
};
|
|
908
|
+
type RequestQuery = {};
|
|
909
|
+
type RequestBody = never;
|
|
910
|
+
type RequestHeaders = {};
|
|
911
|
+
type ResponseBody = WineVarietalEntityDto;
|
|
912
|
+
}
|
|
913
|
+
/**
|
|
914
|
+
* No description
|
|
915
|
+
* @tags Admin Tenant Wine Villages
|
|
916
|
+
* @name GetTenantWineVillageById
|
|
917
|
+
* @request GET:/admin/tenants/{tenantId}/wine-villages/{villageId}
|
|
918
|
+
* @secure
|
|
919
|
+
* @response `200` `WineVillageEntityDto`
|
|
920
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
921
|
+
*/
|
|
922
|
+
namespace GetTenantWineVillageById {
|
|
923
|
+
type RequestParams = {
|
|
924
|
+
tenantId: string;
|
|
925
|
+
villageId: string;
|
|
926
|
+
};
|
|
927
|
+
type RequestQuery = {};
|
|
928
|
+
type RequestBody = never;
|
|
929
|
+
type RequestHeaders = {};
|
|
930
|
+
type ResponseBody = WineVillageEntityDto;
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* No description
|
|
934
|
+
* @tags Admin Tenant Wine Vineyards
|
|
935
|
+
* @name GetTenantWineVineyardById
|
|
936
|
+
* @request GET:/admin/tenants/{tenantId}/wine-vineyards/{vineyardId}
|
|
937
|
+
* @secure
|
|
938
|
+
* @response `200` `WineVineyardEntityDto`
|
|
939
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
940
|
+
*/
|
|
941
|
+
namespace GetTenantWineVineyardById {
|
|
942
|
+
type RequestParams = {
|
|
943
|
+
tenantId: string;
|
|
944
|
+
vineyardId: string;
|
|
945
|
+
};
|
|
946
|
+
type RequestQuery = {};
|
|
947
|
+
type RequestBody = never;
|
|
948
|
+
type RequestHeaders = {};
|
|
949
|
+
type ResponseBody = WineVineyardEntityDto;
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* No description
|
|
953
|
+
* @tags Admin Tenant Users
|
|
954
|
+
* @name ListTenantUsers
|
|
955
|
+
* @request GET:/admin/tenants/{tenantId}/users
|
|
956
|
+
* @secure
|
|
957
|
+
* @response `200` `TenantUserEntityPaginatedDto`
|
|
958
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
959
|
+
*/
|
|
960
|
+
namespace ListTenantUsers {
|
|
961
|
+
type RequestParams = {
|
|
962
|
+
tenantId: string;
|
|
963
|
+
};
|
|
964
|
+
type RequestQuery = {
|
|
965
|
+
/**
|
|
966
|
+
* @default 10
|
|
967
|
+
* @example 10
|
|
968
|
+
*/
|
|
969
|
+
limit?: number;
|
|
970
|
+
orderBy?: OrderByEnum;
|
|
971
|
+
/**
|
|
972
|
+
* @default 1
|
|
973
|
+
* @example 1
|
|
974
|
+
*/
|
|
975
|
+
page?: number;
|
|
976
|
+
roles?: TenantRoleEnum[];
|
|
977
|
+
search?: string;
|
|
978
|
+
sortBy?: string[];
|
|
979
|
+
status?: TenantUserStatusEnum[];
|
|
980
|
+
};
|
|
981
|
+
type RequestBody = never;
|
|
982
|
+
type RequestHeaders = {};
|
|
983
|
+
type ResponseBody = TenantUserEntityPaginatedDto;
|
|
984
|
+
}
|
|
985
|
+
/**
|
|
986
|
+
* No description
|
|
987
|
+
* @tags Admin Tenant Wine Brands
|
|
988
|
+
* @name ListTenantWineBrands
|
|
989
|
+
* @request GET:/admin/tenants/{tenantId}/wine-brands
|
|
990
|
+
* @secure
|
|
991
|
+
* @response `200` `WineBrandEntityPaginatedDto`
|
|
992
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
993
|
+
*/
|
|
994
|
+
namespace ListTenantWineBrands {
|
|
995
|
+
type RequestParams = {
|
|
996
|
+
tenantId: string;
|
|
997
|
+
};
|
|
998
|
+
type RequestQuery = {
|
|
999
|
+
createdAt?: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* @default 10
|
|
1002
|
+
* @example 10
|
|
1003
|
+
*/
|
|
1004
|
+
limit?: number;
|
|
1005
|
+
orderBy?: OrderByEnum;
|
|
1006
|
+
/**
|
|
1007
|
+
* @default 1
|
|
1008
|
+
* @example 1
|
|
1009
|
+
*/
|
|
1010
|
+
page?: number;
|
|
1011
|
+
search?: string;
|
|
1012
|
+
sortBy?: string[];
|
|
1013
|
+
};
|
|
1014
|
+
type RequestBody = never;
|
|
1015
|
+
type RequestHeaders = {};
|
|
1016
|
+
type ResponseBody = WineBrandEntityPaginatedDto;
|
|
1017
|
+
}
|
|
1018
|
+
/**
|
|
1019
|
+
* No description
|
|
1020
|
+
* @tags Admin Tenant Wine Producers
|
|
1021
|
+
* @name ListTenantWineProducers
|
|
1022
|
+
* @request GET:/admin/tenants/{tenantId}/wine-producers
|
|
1023
|
+
* @secure
|
|
1024
|
+
* @response `200` `WineProducerEntityPaginatedDto`
|
|
1025
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1026
|
+
*/
|
|
1027
|
+
namespace ListTenantWineProducers {
|
|
1028
|
+
type RequestParams = {
|
|
1029
|
+
tenantId: string;
|
|
1030
|
+
};
|
|
1031
|
+
type RequestQuery = {
|
|
1032
|
+
createdAt?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* @default 10
|
|
1035
|
+
* @example 10
|
|
1036
|
+
*/
|
|
1037
|
+
limit?: number;
|
|
1038
|
+
orderBy?: OrderByEnum;
|
|
1039
|
+
/**
|
|
1040
|
+
* @default 1
|
|
1041
|
+
* @example 1
|
|
1042
|
+
*/
|
|
1043
|
+
page?: number;
|
|
1044
|
+
search?: string;
|
|
1045
|
+
sortBy?: string[];
|
|
1046
|
+
};
|
|
1047
|
+
type RequestBody = never;
|
|
1048
|
+
type RequestHeaders = {};
|
|
1049
|
+
type ResponseBody = WineProducerEntityPaginatedDto;
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* No description
|
|
1053
|
+
* @tags Admin Tenant Wines
|
|
1054
|
+
* @name ListTenantWines
|
|
1055
|
+
* @request GET:/admin/tenants/{tenantId}/wines
|
|
1056
|
+
* @secure
|
|
1057
|
+
* @response `200` `WineEntityPaginatedDto`
|
|
1058
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1059
|
+
*/
|
|
1060
|
+
namespace ListTenantWines {
|
|
1061
|
+
type RequestParams = {
|
|
1062
|
+
tenantId: string;
|
|
1063
|
+
};
|
|
1064
|
+
type RequestQuery = {
|
|
1065
|
+
brandIds?: string[];
|
|
1066
|
+
createdAt?: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* @default 10
|
|
1069
|
+
* @example 10
|
|
1070
|
+
*/
|
|
1071
|
+
limit?: number;
|
|
1072
|
+
orderBy?: OrderByEnum;
|
|
1073
|
+
/**
|
|
1074
|
+
* @default 1
|
|
1075
|
+
* @example 1
|
|
1076
|
+
*/
|
|
1077
|
+
page?: number;
|
|
1078
|
+
producerIds?: string[];
|
|
1079
|
+
sortBy?: string[];
|
|
1080
|
+
styleIds?: string[];
|
|
1081
|
+
typeIds?: string[];
|
|
1082
|
+
varietalIds?: string[];
|
|
1083
|
+
villageIds?: string[];
|
|
1084
|
+
vineyardIds?: string[];
|
|
1085
|
+
};
|
|
1086
|
+
type RequestBody = never;
|
|
1087
|
+
type RequestHeaders = {};
|
|
1088
|
+
type ResponseBody = WineEntityPaginatedDto;
|
|
1089
|
+
}
|
|
1090
|
+
/**
|
|
1091
|
+
* No description
|
|
1092
|
+
* @tags Admin Tenant Wine Styles
|
|
1093
|
+
* @name ListTenantWineStyles
|
|
1094
|
+
* @request GET:/admin/tenants/{tenantId}/wine-styles
|
|
1095
|
+
* @secure
|
|
1096
|
+
* @response `200` `WineStyleEntityPaginatedDto`
|
|
1097
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1098
|
+
*/
|
|
1099
|
+
namespace ListTenantWineStyles {
|
|
1100
|
+
type RequestParams = {
|
|
1101
|
+
tenantId: string;
|
|
1102
|
+
};
|
|
1103
|
+
type RequestQuery = {
|
|
1104
|
+
createdAt?: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* @default 10
|
|
1107
|
+
* @example 10
|
|
1108
|
+
*/
|
|
1109
|
+
limit?: number;
|
|
1110
|
+
orderBy?: OrderByEnum;
|
|
1111
|
+
/**
|
|
1112
|
+
* @default 1
|
|
1113
|
+
* @example 1
|
|
1114
|
+
*/
|
|
1115
|
+
page?: number;
|
|
1116
|
+
search?: string;
|
|
1117
|
+
sortBy?: string[];
|
|
1118
|
+
};
|
|
1119
|
+
type RequestBody = never;
|
|
1120
|
+
type RequestHeaders = {};
|
|
1121
|
+
type ResponseBody = WineStyleEntityPaginatedDto;
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* No description
|
|
1125
|
+
* @tags Admin Tenant Wine Types
|
|
1126
|
+
* @name ListTenantWineTypes
|
|
1127
|
+
* @request GET:/admin/tenants/{tenantId}/wine-types
|
|
1128
|
+
* @secure
|
|
1129
|
+
* @response `200` `WineTypeEntityPaginatedDto`
|
|
1130
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1131
|
+
*/
|
|
1132
|
+
namespace ListTenantWineTypes {
|
|
1133
|
+
type RequestParams = {
|
|
1134
|
+
tenantId: string;
|
|
1135
|
+
};
|
|
1136
|
+
type RequestQuery = {
|
|
1137
|
+
createdAt?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* @default 10
|
|
1140
|
+
* @example 10
|
|
1141
|
+
*/
|
|
1142
|
+
limit?: number;
|
|
1143
|
+
orderBy?: OrderByEnum;
|
|
1144
|
+
/**
|
|
1145
|
+
* @default 1
|
|
1146
|
+
* @example 1
|
|
1147
|
+
*/
|
|
1148
|
+
page?: number;
|
|
1149
|
+
search?: string;
|
|
1150
|
+
sortBy?: string[];
|
|
1151
|
+
};
|
|
1152
|
+
type RequestBody = never;
|
|
1153
|
+
type RequestHeaders = {};
|
|
1154
|
+
type ResponseBody = WineTypeEntityPaginatedDto;
|
|
1155
|
+
}
|
|
1156
|
+
/**
|
|
1157
|
+
* No description
|
|
1158
|
+
* @tags Admin Tenant Wine Varietals
|
|
1159
|
+
* @name ListTenantWineVarietals
|
|
1160
|
+
* @request GET:/admin/tenants/{tenantId}/wine-varietals
|
|
1161
|
+
* @secure
|
|
1162
|
+
* @response `200` `WineVarietalEntityPaginatedDto`
|
|
1163
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1164
|
+
*/
|
|
1165
|
+
namespace ListTenantWineVarietals {
|
|
1166
|
+
type RequestParams = {
|
|
1167
|
+
tenantId: string;
|
|
1168
|
+
};
|
|
1169
|
+
type RequestQuery = {
|
|
1170
|
+
createdAt?: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* @default 10
|
|
1173
|
+
* @example 10
|
|
1174
|
+
*/
|
|
1175
|
+
limit?: number;
|
|
1176
|
+
orderBy?: OrderByEnum;
|
|
1177
|
+
/**
|
|
1178
|
+
* @default 1
|
|
1179
|
+
* @example 1
|
|
1180
|
+
*/
|
|
1181
|
+
page?: number;
|
|
1182
|
+
search?: string;
|
|
1183
|
+
sortBy?: string[];
|
|
1184
|
+
};
|
|
1185
|
+
type RequestBody = never;
|
|
1186
|
+
type RequestHeaders = {};
|
|
1187
|
+
type ResponseBody = WineVarietalEntityPaginatedDto;
|
|
1188
|
+
}
|
|
1189
|
+
/**
|
|
1190
|
+
* No description
|
|
1191
|
+
* @tags Admin Tenant Wine Villages
|
|
1192
|
+
* @name ListTenantWineVillages
|
|
1193
|
+
* @request GET:/admin/tenants/{tenantId}/wine-villages
|
|
1194
|
+
* @secure
|
|
1195
|
+
* @response `200` `WineVillageEntityPaginatedDto`
|
|
1196
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1197
|
+
*/
|
|
1198
|
+
namespace ListTenantWineVillages {
|
|
1199
|
+
type RequestParams = {
|
|
1200
|
+
tenantId: string;
|
|
1201
|
+
};
|
|
1202
|
+
type RequestQuery = {
|
|
1203
|
+
createdAt?: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* @default 10
|
|
1206
|
+
* @example 10
|
|
1207
|
+
*/
|
|
1208
|
+
limit?: number;
|
|
1209
|
+
orderBy?: OrderByEnum;
|
|
1210
|
+
/**
|
|
1211
|
+
* @default 1
|
|
1212
|
+
* @example 1
|
|
1213
|
+
*/
|
|
1214
|
+
page?: number;
|
|
1215
|
+
search?: string;
|
|
1216
|
+
sortBy?: string[];
|
|
1217
|
+
};
|
|
1218
|
+
type RequestBody = never;
|
|
1219
|
+
type RequestHeaders = {};
|
|
1220
|
+
type ResponseBody = WineVillageEntityPaginatedDto;
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* No description
|
|
1224
|
+
* @tags Admin Tenant Wine Vineyards
|
|
1225
|
+
* @name ListTenantWineVineyards
|
|
1226
|
+
* @request GET:/admin/tenants/{tenantId}/wine-vineyards
|
|
1227
|
+
* @secure
|
|
1228
|
+
* @response `200` `WineVineyardEntityPaginatedDto`
|
|
1229
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1230
|
+
*/
|
|
1231
|
+
namespace ListTenantWineVineyards {
|
|
1232
|
+
type RequestParams = {
|
|
1233
|
+
tenantId: string;
|
|
1234
|
+
};
|
|
1235
|
+
type RequestQuery = {
|
|
1236
|
+
createdAt?: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* @default 10
|
|
1239
|
+
* @example 10
|
|
1240
|
+
*/
|
|
1241
|
+
limit?: number;
|
|
1242
|
+
orderBy?: OrderByEnum;
|
|
1243
|
+
/**
|
|
1244
|
+
* @default 1
|
|
1245
|
+
* @example 1
|
|
1246
|
+
*/
|
|
1247
|
+
page?: number;
|
|
1248
|
+
search?: string;
|
|
1249
|
+
sortBy?: string[];
|
|
1250
|
+
};
|
|
1251
|
+
type RequestBody = never;
|
|
1252
|
+
type RequestHeaders = {};
|
|
1253
|
+
type ResponseBody = WineVineyardEntityPaginatedDto;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* No description
|
|
1257
|
+
* @tags Admin Tenant Wines
|
|
1258
|
+
* @name UpdateTenantWine
|
|
1259
|
+
* @request PATCH:/admin/tenants/{tenantId}/wines/{wineId}
|
|
1260
|
+
* @secure
|
|
1261
|
+
* @response `200` `WineEntityDto`
|
|
1262
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1263
|
+
*/
|
|
1264
|
+
namespace UpdateTenantWine {
|
|
1265
|
+
type RequestParams = {
|
|
1266
|
+
tenantId: string;
|
|
1267
|
+
wineId: string;
|
|
1268
|
+
};
|
|
1269
|
+
type RequestQuery = {};
|
|
1270
|
+
type RequestBody = UpdateWineDto;
|
|
1271
|
+
type RequestHeaders = {};
|
|
1272
|
+
type ResponseBody = WineEntityDto;
|
|
1273
|
+
}
|
|
1274
|
+
/**
|
|
1275
|
+
* No description
|
|
1276
|
+
* @tags Admin Tenant Wine Brands
|
|
1277
|
+
* @name UpdateTenantWineBrand
|
|
1278
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-brands/{brandId}
|
|
1279
|
+
* @secure
|
|
1280
|
+
* @response `200` `WineBrandEntityDto`
|
|
1281
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1282
|
+
*/
|
|
1283
|
+
namespace UpdateTenantWineBrand {
|
|
1284
|
+
type RequestParams = {
|
|
1285
|
+
brandId: string;
|
|
1286
|
+
tenantId: string;
|
|
1287
|
+
};
|
|
1288
|
+
type RequestQuery = {};
|
|
1289
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1290
|
+
type RequestHeaders = {};
|
|
1291
|
+
type ResponseBody = WineBrandEntityDto;
|
|
1292
|
+
}
|
|
1293
|
+
/**
|
|
1294
|
+
* No description
|
|
1295
|
+
* @tags Admin Tenant Wine Producers
|
|
1296
|
+
* @name UpdateTenantWineProducer
|
|
1297
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-producers/{producerId}
|
|
1298
|
+
* @secure
|
|
1299
|
+
* @response `200` `WineProducerEntityDto`
|
|
1300
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1301
|
+
*/
|
|
1302
|
+
namespace UpdateTenantWineProducer {
|
|
1303
|
+
type RequestParams = {
|
|
1304
|
+
producerId: string;
|
|
1305
|
+
tenantId: string;
|
|
1306
|
+
};
|
|
1307
|
+
type RequestQuery = {};
|
|
1308
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1309
|
+
type RequestHeaders = {};
|
|
1310
|
+
type ResponseBody = WineProducerEntityDto;
|
|
1311
|
+
}
|
|
1312
|
+
/**
|
|
1313
|
+
* No description
|
|
1314
|
+
* @tags Admin Tenant Wine Styles
|
|
1315
|
+
* @name UpdateTenantWineStyle
|
|
1316
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-styles/{styleId}
|
|
1317
|
+
* @secure
|
|
1318
|
+
* @response `200` `WineStyleEntityDto`
|
|
1319
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1320
|
+
*/
|
|
1321
|
+
namespace UpdateTenantWineStyle {
|
|
1322
|
+
type RequestParams = {
|
|
1323
|
+
styleId: string;
|
|
1324
|
+
tenantId: string;
|
|
1325
|
+
};
|
|
1326
|
+
type RequestQuery = {};
|
|
1327
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1328
|
+
type RequestHeaders = {};
|
|
1329
|
+
type ResponseBody = WineStyleEntityDto;
|
|
1330
|
+
}
|
|
1331
|
+
/**
|
|
1332
|
+
* No description
|
|
1333
|
+
* @tags Admin Tenant Wine Types
|
|
1334
|
+
* @name UpdateTenantWineType
|
|
1335
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-types/{typeId}
|
|
1336
|
+
* @secure
|
|
1337
|
+
* @response `200` `WineTypeEntityDto`
|
|
1338
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1339
|
+
*/
|
|
1340
|
+
namespace UpdateTenantWineType {
|
|
1341
|
+
type RequestParams = {
|
|
1342
|
+
tenantId: string;
|
|
1343
|
+
typeId: string;
|
|
1344
|
+
};
|
|
1345
|
+
type RequestQuery = {};
|
|
1346
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1347
|
+
type RequestHeaders = {};
|
|
1348
|
+
type ResponseBody = WineTypeEntityDto;
|
|
1349
|
+
}
|
|
1350
|
+
/**
|
|
1351
|
+
* No description
|
|
1352
|
+
* @tags Admin Tenant Wine Varietals
|
|
1353
|
+
* @name UpdateTenantWineVarietal
|
|
1354
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-varietals/{varietalId}
|
|
1355
|
+
* @secure
|
|
1356
|
+
* @response `200` `WineVarietalEntityDto`
|
|
1357
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1358
|
+
*/
|
|
1359
|
+
namespace UpdateTenantWineVarietal {
|
|
1360
|
+
type RequestParams = {
|
|
1361
|
+
tenantId: string;
|
|
1362
|
+
varietalId: string;
|
|
1363
|
+
};
|
|
1364
|
+
type RequestQuery = {};
|
|
1365
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1366
|
+
type RequestHeaders = {};
|
|
1367
|
+
type ResponseBody = WineVarietalEntityDto;
|
|
1368
|
+
}
|
|
1369
|
+
/**
|
|
1370
|
+
* No description
|
|
1371
|
+
* @tags Admin Tenant Wine Villages
|
|
1372
|
+
* @name UpdateTenantWineVillage
|
|
1373
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-villages/{villageId}
|
|
1374
|
+
* @secure
|
|
1375
|
+
* @response `200` `WineVillageEntityDto`
|
|
1376
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1377
|
+
*/
|
|
1378
|
+
namespace UpdateTenantWineVillage {
|
|
1379
|
+
type RequestParams = {
|
|
1380
|
+
tenantId: string;
|
|
1381
|
+
villageId: string;
|
|
1382
|
+
};
|
|
1383
|
+
type RequestQuery = {};
|
|
1384
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1385
|
+
type RequestHeaders = {};
|
|
1386
|
+
type ResponseBody = WineVillageEntityDto;
|
|
1387
|
+
}
|
|
1388
|
+
/**
|
|
1389
|
+
* No description
|
|
1390
|
+
* @tags Admin Tenant Wine Vineyards
|
|
1391
|
+
* @name UpdateTenantWineVineyard
|
|
1392
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-vineyards/{vineyardId}
|
|
1393
|
+
* @secure
|
|
1394
|
+
* @response `200` `WineVineyardEntityDto`
|
|
1395
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1396
|
+
*/
|
|
1397
|
+
namespace UpdateTenantWineVineyard {
|
|
1398
|
+
type RequestParams = {
|
|
1399
|
+
tenantId: string;
|
|
1400
|
+
vineyardId: string;
|
|
1401
|
+
};
|
|
1402
|
+
type RequestQuery = {};
|
|
1403
|
+
type RequestBody = UpdateNameOnlyEntityDto;
|
|
1404
|
+
type RequestHeaders = {};
|
|
1405
|
+
type ResponseBody = WineVineyardEntityDto;
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from "axios";
|
|
1409
|
+
export type QueryParamsType = Record<string | number, any>;
|
|
1410
|
+
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
1411
|
+
/** set parameter to `true` for call `securityWorker` for this request */
|
|
1412
|
+
secure?: boolean;
|
|
1413
|
+
/** request path */
|
|
1414
|
+
path: string;
|
|
1415
|
+
/** content type of request body */
|
|
1416
|
+
type?: ContentType;
|
|
1417
|
+
/** query params */
|
|
1418
|
+
query?: QueryParamsType;
|
|
1419
|
+
/** format of response (i.e. response.json() -> format: "json") */
|
|
1420
|
+
format?: ResponseType;
|
|
1421
|
+
/** request body */
|
|
1422
|
+
body?: unknown;
|
|
1423
|
+
}
|
|
1424
|
+
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
|
|
1425
|
+
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
|
|
1426
|
+
securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
|
|
1427
|
+
secure?: boolean;
|
|
1428
|
+
format?: ResponseType;
|
|
1429
|
+
}
|
|
1430
|
+
export declare enum ContentType {
|
|
1431
|
+
Json = "application/json",
|
|
1432
|
+
JsonApi = "application/vnd.api+json",
|
|
1433
|
+
FormData = "multipart/form-data",
|
|
1434
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
1435
|
+
Text = "text/plain"
|
|
1436
|
+
}
|
|
1437
|
+
export declare class HttpClient<SecurityDataType = unknown> {
|
|
1438
|
+
instance: AxiosInstance;
|
|
1439
|
+
private securityData;
|
|
1440
|
+
private securityWorker?;
|
|
1441
|
+
private secure?;
|
|
1442
|
+
private format?;
|
|
1443
|
+
constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
|
|
1444
|
+
setSecurityData: (data: SecurityDataType | null) => void;
|
|
1445
|
+
protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
|
|
1446
|
+
protected stringifyFormItem(formItem: unknown): string;
|
|
1447
|
+
protected createFormData(input: Record<string, unknown>): FormData;
|
|
1448
|
+
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
|
|
1449
|
+
}
|
|
1450
|
+
/**
|
|
1451
|
+
* @title winehaus-api
|
|
1452
|
+
* @version 0.0.1
|
|
1453
|
+
* @baseUrl http://localhost:3000
|
|
1454
|
+
* @contact
|
|
1455
|
+
*/
|
|
1456
|
+
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
1457
|
+
/**
|
|
1458
|
+
* No description
|
|
1459
|
+
*
|
|
1460
|
+
* @tags App
|
|
1461
|
+
* @name Index
|
|
1462
|
+
* @request GET:/
|
|
1463
|
+
* @response `200` `void`
|
|
1464
|
+
*/
|
|
1465
|
+
index: (params?: RequestParams) => Promise<void>;
|
|
1466
|
+
auth: {
|
|
1467
|
+
/**
|
|
1468
|
+
* No description
|
|
1469
|
+
*
|
|
1470
|
+
* @tags Authentication
|
|
1471
|
+
* @name Logout
|
|
1472
|
+
* @request POST:/auth/logout
|
|
1473
|
+
* @secure
|
|
1474
|
+
* @response `204` `void`
|
|
1475
|
+
*/
|
|
1476
|
+
logout: (params?: RequestParams) => Promise<void>;
|
|
1477
|
+
/**
|
|
1478
|
+
* No description
|
|
1479
|
+
*
|
|
1480
|
+
* @tags Authentication
|
|
1481
|
+
* @name RequestPasswordReset
|
|
1482
|
+
* @request POST:/auth/request-password-reset
|
|
1483
|
+
* @secure
|
|
1484
|
+
* @response `204` `void`
|
|
1485
|
+
*/
|
|
1486
|
+
requestPasswordReset: (data: RequestPasswordResetDto, params?: RequestParams) => Promise<void>;
|
|
1487
|
+
/**
|
|
1488
|
+
* No description
|
|
1489
|
+
*
|
|
1490
|
+
* @tags Authentication
|
|
1491
|
+
* @name ResetPassword
|
|
1492
|
+
* @request PATCH:/auth/reset-password
|
|
1493
|
+
* @secure
|
|
1494
|
+
* @response `200` `SigninResponseDto`
|
|
1495
|
+
*/
|
|
1496
|
+
resetPassword: (data: ResetPasswordDto, params?: RequestParams) => Promise<SigninResponseDto>;
|
|
1497
|
+
/**
|
|
1498
|
+
* No description
|
|
1499
|
+
*
|
|
1500
|
+
* @tags Authentication
|
|
1501
|
+
* @name SignIn
|
|
1502
|
+
* @request POST:/auth/signin
|
|
1503
|
+
* @secure
|
|
1504
|
+
* @response `200` `SigninResponseDto`
|
|
1505
|
+
*/
|
|
1506
|
+
signIn: (data: SigninDto, params?: RequestParams) => Promise<SigninResponseDto>;
|
|
1507
|
+
};
|
|
1508
|
+
users: {
|
|
1509
|
+
/**
|
|
1510
|
+
* No description
|
|
1511
|
+
*
|
|
1512
|
+
* @tags Users
|
|
1513
|
+
* @name UpdateUserPassword
|
|
1514
|
+
* @request PATCH:/users/{userId}/password
|
|
1515
|
+
* @secure
|
|
1516
|
+
* @response `200` `UserEntityDto`
|
|
1517
|
+
* @response `403` `HttpExceptionDto` You're not enabled to make this operation.
|
|
1518
|
+
*/
|
|
1519
|
+
updateUserPassword: (userId: string, data: UpdateUserPasswordDto, params?: RequestParams) => Promise<UserEntityDto>;
|
|
1520
|
+
/**
|
|
1521
|
+
* No description
|
|
1522
|
+
*
|
|
1523
|
+
* @tags Users
|
|
1524
|
+
* @name UpdateUserProfile
|
|
1525
|
+
* @request PATCH:/users/{userId}
|
|
1526
|
+
* @secure
|
|
1527
|
+
* @response `200` `UserEntityDto`
|
|
1528
|
+
* @response `403` `HttpExceptionDto` You're not enabled to make this operation.
|
|
1529
|
+
*/
|
|
1530
|
+
updateUserProfile: (userId: string, data: UpdateUserProfileDto, params?: RequestParams) => Promise<UserEntityDto>;
|
|
1531
|
+
};
|
|
1532
|
+
admin: {
|
|
1533
|
+
/**
|
|
1534
|
+
* @description Gives some user access to the tenant. If there's no user account attached to this users, it creates a new one
|
|
1535
|
+
*
|
|
1536
|
+
* @tags Admin Tenant Users
|
|
1537
|
+
* @name CreateOrUpdateTenantUserAndPermissionsByUserEmail
|
|
1538
|
+
* @request POST:/admin/tenants/{tenantId}/users
|
|
1539
|
+
* @secure
|
|
1540
|
+
* @response `200` `TenantUserEntityDto`
|
|
1541
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1542
|
+
*/
|
|
1543
|
+
createOrUpdateTenantUserAndPermissionsByUserEmail: (tenantId: string, data: CreateTenantUserDto, params?: RequestParams) => Promise<TenantUserEntityDto>;
|
|
1544
|
+
/**
|
|
1545
|
+
* No description
|
|
1546
|
+
*
|
|
1547
|
+
* @tags Admin Tenant Wines
|
|
1548
|
+
* @name CreateTenantWine
|
|
1549
|
+
* @request POST:/admin/tenants/{tenantId}/wines
|
|
1550
|
+
* @secure
|
|
1551
|
+
* @response `201` `WineEntityDto`
|
|
1552
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1553
|
+
*/
|
|
1554
|
+
createTenantWine: (tenantId: string, data: CreateWineDto, params?: RequestParams) => Promise<WineEntityDto>;
|
|
1555
|
+
/**
|
|
1556
|
+
* No description
|
|
1557
|
+
*
|
|
1558
|
+
* @tags Admin Tenant Wine Brands
|
|
1559
|
+
* @name CreateTenantWineBrand
|
|
1560
|
+
* @request POST:/admin/tenants/{tenantId}/wine-brands
|
|
1561
|
+
* @secure
|
|
1562
|
+
* @response `201` `WineBrandEntityDto`
|
|
1563
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1564
|
+
*/
|
|
1565
|
+
createTenantWineBrand: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineBrandEntityDto>;
|
|
1566
|
+
/**
|
|
1567
|
+
* No description
|
|
1568
|
+
*
|
|
1569
|
+
* @tags Admin Tenant Wine Producers
|
|
1570
|
+
* @name CreateTenantWineProducer
|
|
1571
|
+
* @request POST:/admin/tenants/{tenantId}/wine-producers
|
|
1572
|
+
* @secure
|
|
1573
|
+
* @response `201` `WineProducerEntityDto`
|
|
1574
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1575
|
+
*/
|
|
1576
|
+
createTenantWineProducer: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineProducerEntityDto>;
|
|
1577
|
+
/**
|
|
1578
|
+
* No description
|
|
1579
|
+
*
|
|
1580
|
+
* @tags Admin Tenant Wine Styles
|
|
1581
|
+
* @name CreateTenantWineStyle
|
|
1582
|
+
* @request POST:/admin/tenants/{tenantId}/wine-styles
|
|
1583
|
+
* @secure
|
|
1584
|
+
* @response `201` `WineStyleEntityDto`
|
|
1585
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1586
|
+
*/
|
|
1587
|
+
createTenantWineStyle: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineStyleEntityDto>;
|
|
1588
|
+
/**
|
|
1589
|
+
* No description
|
|
1590
|
+
*
|
|
1591
|
+
* @tags Admin Tenant Wine Types
|
|
1592
|
+
* @name CreateTenantWineType
|
|
1593
|
+
* @request POST:/admin/tenants/{tenantId}/wine-types
|
|
1594
|
+
* @secure
|
|
1595
|
+
* @response `201` `WineTypeEntityDto`
|
|
1596
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1597
|
+
*/
|
|
1598
|
+
createTenantWineType: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineTypeEntityDto>;
|
|
1599
|
+
/**
|
|
1600
|
+
* No description
|
|
1601
|
+
*
|
|
1602
|
+
* @tags Admin Tenant Wine Varietals
|
|
1603
|
+
* @name CreateTenantWineVarietal
|
|
1604
|
+
* @request POST:/admin/tenants/{tenantId}/wine-varietals
|
|
1605
|
+
* @secure
|
|
1606
|
+
* @response `201` `WineVarietalEntityDto`
|
|
1607
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1608
|
+
*/
|
|
1609
|
+
createTenantWineVarietal: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineVarietalEntityDto>;
|
|
1610
|
+
/**
|
|
1611
|
+
* No description
|
|
1612
|
+
*
|
|
1613
|
+
* @tags Admin Tenant Wine Villages
|
|
1614
|
+
* @name CreateTenantWineVillage
|
|
1615
|
+
* @request POST:/admin/tenants/{tenantId}/wine-villages
|
|
1616
|
+
* @secure
|
|
1617
|
+
* @response `201` `WineVillageEntityDto`
|
|
1618
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1619
|
+
*/
|
|
1620
|
+
createTenantWineVillage: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineVillageEntityDto>;
|
|
1621
|
+
/**
|
|
1622
|
+
* No description
|
|
1623
|
+
*
|
|
1624
|
+
* @tags Admin Tenant Wine Vineyards
|
|
1625
|
+
* @name CreateTenantWineVineyard
|
|
1626
|
+
* @request POST:/admin/tenants/{tenantId}/wine-vineyards
|
|
1627
|
+
* @secure
|
|
1628
|
+
* @response `201` `WineVineyardEntityDto`
|
|
1629
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1630
|
+
*/
|
|
1631
|
+
createTenantWineVineyard: (tenantId: string, data: CreateNameOnlyEntityDto, params?: RequestParams) => Promise<WineVineyardEntityDto>;
|
|
1632
|
+
/**
|
|
1633
|
+
* No description
|
|
1634
|
+
*
|
|
1635
|
+
* @tags Admin Tenant Wines
|
|
1636
|
+
* @name DeleteTenantWine
|
|
1637
|
+
* @request DELETE:/admin/tenants/{tenantId}/wines/{wineId}
|
|
1638
|
+
* @secure
|
|
1639
|
+
* @response `204` `void`
|
|
1640
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1641
|
+
*/
|
|
1642
|
+
deleteTenantWine: (tenantId: string, wineId: string, params?: RequestParams) => Promise<void>;
|
|
1643
|
+
/**
|
|
1644
|
+
* No description
|
|
1645
|
+
*
|
|
1646
|
+
* @tags Admin Tenant Wine Brands
|
|
1647
|
+
* @name DeleteTenantWineBrand
|
|
1648
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-brands/{brandId}
|
|
1649
|
+
* @secure
|
|
1650
|
+
* @response `204` `void`
|
|
1651
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1652
|
+
*/
|
|
1653
|
+
deleteTenantWineBrand: (tenantId: string, brandId: string, params?: RequestParams) => Promise<void>;
|
|
1654
|
+
/**
|
|
1655
|
+
* No description
|
|
1656
|
+
*
|
|
1657
|
+
* @tags Admin Tenant Wine Producers
|
|
1658
|
+
* @name DeleteTenantWineProducer
|
|
1659
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-producers/{producerId}
|
|
1660
|
+
* @secure
|
|
1661
|
+
* @response `204` `void`
|
|
1662
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1663
|
+
*/
|
|
1664
|
+
deleteTenantWineProducer: (tenantId: string, producerId: string, params?: RequestParams) => Promise<void>;
|
|
1665
|
+
/**
|
|
1666
|
+
* No description
|
|
1667
|
+
*
|
|
1668
|
+
* @tags Admin Tenant Wine Styles
|
|
1669
|
+
* @name DeleteTenantWineStyle
|
|
1670
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-styles/{styleId}
|
|
1671
|
+
* @secure
|
|
1672
|
+
* @response `204` `void`
|
|
1673
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1674
|
+
*/
|
|
1675
|
+
deleteTenantWineStyle: (tenantId: string, styleId: string, params?: RequestParams) => Promise<void>;
|
|
1676
|
+
/**
|
|
1677
|
+
* No description
|
|
1678
|
+
*
|
|
1679
|
+
* @tags Admin Tenant Wine Types
|
|
1680
|
+
* @name DeleteTenantWineType
|
|
1681
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-types/{typeId}
|
|
1682
|
+
* @secure
|
|
1683
|
+
* @response `204` `void`
|
|
1684
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1685
|
+
*/
|
|
1686
|
+
deleteTenantWineType: (tenantId: string, typeId: string, params?: RequestParams) => Promise<void>;
|
|
1687
|
+
/**
|
|
1688
|
+
* No description
|
|
1689
|
+
*
|
|
1690
|
+
* @tags Admin Tenant Wine Varietals
|
|
1691
|
+
* @name DeleteTenantWineVarietal
|
|
1692
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-varietals/{varietalId}
|
|
1693
|
+
* @secure
|
|
1694
|
+
* @response `204` `void`
|
|
1695
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1696
|
+
*/
|
|
1697
|
+
deleteTenantWineVarietal: (tenantId: string, varietalId: string, params?: RequestParams) => Promise<void>;
|
|
1698
|
+
/**
|
|
1699
|
+
* No description
|
|
1700
|
+
*
|
|
1701
|
+
* @tags Admin Tenant Wine Villages
|
|
1702
|
+
* @name DeleteTenantWineVillage
|
|
1703
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-villages/{villageId}
|
|
1704
|
+
* @secure
|
|
1705
|
+
* @response `204` `void`
|
|
1706
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1707
|
+
*/
|
|
1708
|
+
deleteTenantWineVillage: (tenantId: string, villageId: string, params?: RequestParams) => Promise<void>;
|
|
1709
|
+
/**
|
|
1710
|
+
* No description
|
|
1711
|
+
*
|
|
1712
|
+
* @tags Admin Tenant Wine Vineyards
|
|
1713
|
+
* @name DeleteTenantWineVineyard
|
|
1714
|
+
* @request DELETE:/admin/tenants/{tenantId}/wine-vineyards/{vineyardId}
|
|
1715
|
+
* @secure
|
|
1716
|
+
* @response `204` `void`
|
|
1717
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1718
|
+
*/
|
|
1719
|
+
deleteTenantWineVineyard: (tenantId: string, vineyardId: string, params?: RequestParams) => Promise<void>;
|
|
1720
|
+
/**
|
|
1721
|
+
* No description
|
|
1722
|
+
*
|
|
1723
|
+
* @tags Admin Tenant Users
|
|
1724
|
+
* @name DisableTenantUser
|
|
1725
|
+
* @request PATCH:/admin/tenants/{tenantId}/users/{userId}/disable
|
|
1726
|
+
* @secure
|
|
1727
|
+
* @response `204` `void`
|
|
1728
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1729
|
+
*/
|
|
1730
|
+
disableTenantUser: (tenantId: string, userId: string, params?: RequestParams) => Promise<void>;
|
|
387
1731
|
/**
|
|
388
1732
|
* No description
|
|
389
1733
|
*
|
|
390
|
-
* @tags
|
|
391
|
-
* @name
|
|
392
|
-
* @request
|
|
1734
|
+
* @tags Admin Tenant Users
|
|
1735
|
+
* @name EnableTenantUser
|
|
1736
|
+
* @request PATCH:/admin/tenants/{tenantId}/users/{userId}/enable
|
|
393
1737
|
* @secure
|
|
394
1738
|
* @response `204` `void`
|
|
1739
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
395
1740
|
*/
|
|
396
|
-
|
|
1741
|
+
enableTenantUser: (tenantId: string, userId: string, params?: RequestParams) => Promise<void>;
|
|
397
1742
|
/**
|
|
398
1743
|
* No description
|
|
399
1744
|
*
|
|
400
|
-
* @tags
|
|
401
|
-
* @name
|
|
402
|
-
* @request
|
|
1745
|
+
* @tags Admin Tenant Wine Brands
|
|
1746
|
+
* @name GetTenantWineBrandById
|
|
1747
|
+
* @request GET:/admin/tenants/{tenantId}/wine-brands/{brandId}
|
|
403
1748
|
* @secure
|
|
404
|
-
* @response `200` `
|
|
1749
|
+
* @response `200` `WineBrandEntityDto`
|
|
1750
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
405
1751
|
*/
|
|
406
|
-
|
|
1752
|
+
getTenantWineBrandById: (tenantId: string, brandId: string, params?: RequestParams) => Promise<WineBrandEntityDto>;
|
|
407
1753
|
/**
|
|
408
1754
|
* No description
|
|
409
1755
|
*
|
|
410
|
-
* @tags
|
|
411
|
-
* @name
|
|
412
|
-
* @request
|
|
1756
|
+
* @tags Admin Tenant Wines
|
|
1757
|
+
* @name GetTenantWineById
|
|
1758
|
+
* @request GET:/admin/tenants/{tenantId}/wines/{wineId}
|
|
413
1759
|
* @secure
|
|
414
|
-
* @response `200` `
|
|
1760
|
+
* @response `200` `WineEntityDto`
|
|
1761
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
415
1762
|
*/
|
|
416
|
-
|
|
417
|
-
};
|
|
418
|
-
users: {
|
|
1763
|
+
getTenantWineById: (tenantId: string, wineId: string, params?: RequestParams) => Promise<WineEntityDto>;
|
|
419
1764
|
/**
|
|
420
1765
|
* No description
|
|
421
1766
|
*
|
|
422
|
-
* @tags
|
|
423
|
-
* @name
|
|
424
|
-
* @request
|
|
1767
|
+
* @tags Admin Tenant Wine Producers
|
|
1768
|
+
* @name GetTenantWineProducerById
|
|
1769
|
+
* @request GET:/admin/tenants/{tenantId}/wine-producers/{producerId}
|
|
425
1770
|
* @secure
|
|
426
|
-
* @response `200` `
|
|
427
|
-
* @response `403` `HttpExceptionDto`
|
|
1771
|
+
* @response `200` `WineProducerEntityDto`
|
|
1772
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
428
1773
|
*/
|
|
429
|
-
|
|
1774
|
+
getTenantWineProducerById: (tenantId: string, producerId: string, params?: RequestParams) => Promise<WineProducerEntityDto>;
|
|
430
1775
|
/**
|
|
431
1776
|
* No description
|
|
432
1777
|
*
|
|
433
|
-
* @tags
|
|
434
|
-
* @name
|
|
435
|
-
* @request
|
|
1778
|
+
* @tags Admin Tenant Wine Styles
|
|
1779
|
+
* @name GetTenantWineStyleById
|
|
1780
|
+
* @request GET:/admin/tenants/{tenantId}/wine-styles/{styleId}
|
|
436
1781
|
* @secure
|
|
437
|
-
* @response `200` `
|
|
438
|
-
* @response `403` `HttpExceptionDto`
|
|
1782
|
+
* @response `200` `WineStyleEntityDto`
|
|
1783
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
439
1784
|
*/
|
|
440
|
-
|
|
441
|
-
};
|
|
442
|
-
admin: {
|
|
1785
|
+
getTenantWineStyleById: (tenantId: string, styleId: string, params?: RequestParams) => Promise<WineStyleEntityDto>;
|
|
443
1786
|
/**
|
|
444
|
-
*
|
|
1787
|
+
* No description
|
|
445
1788
|
*
|
|
446
|
-
* @tags Admin Tenant
|
|
447
|
-
* @name
|
|
448
|
-
* @request
|
|
1789
|
+
* @tags Admin Tenant Wine Types
|
|
1790
|
+
* @name GetTenantWineTypeById
|
|
1791
|
+
* @request GET:/admin/tenants/{tenantId}/wine-types/{typeId}
|
|
449
1792
|
* @secure
|
|
450
|
-
* @response `200` `
|
|
451
|
-
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1793
|
+
* @response `200` `WineTypeEntityDto`
|
|
1794
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
452
1795
|
*/
|
|
453
|
-
|
|
1796
|
+
getTenantWineTypeById: (tenantId: string, typeId: string, params?: RequestParams) => Promise<WineTypeEntityDto>;
|
|
454
1797
|
/**
|
|
455
1798
|
* No description
|
|
456
1799
|
*
|
|
457
|
-
* @tags Admin Tenant
|
|
458
|
-
* @name
|
|
459
|
-
* @request
|
|
1800
|
+
* @tags Admin Tenant Wine Varietals
|
|
1801
|
+
* @name GetTenantWineVarietalById
|
|
1802
|
+
* @request GET:/admin/tenants/{tenantId}/wine-varietals/{varietalId}
|
|
460
1803
|
* @secure
|
|
461
|
-
* @response `
|
|
462
|
-
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1804
|
+
* @response `200` `WineVarietalEntityDto`
|
|
1805
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
463
1806
|
*/
|
|
464
|
-
|
|
1807
|
+
getTenantWineVarietalById: (tenantId: string, varietalId: string, params?: RequestParams) => Promise<WineVarietalEntityDto>;
|
|
465
1808
|
/**
|
|
466
1809
|
* No description
|
|
467
1810
|
*
|
|
468
|
-
* @tags Admin Tenant
|
|
469
|
-
* @name
|
|
470
|
-
* @request
|
|
1811
|
+
* @tags Admin Tenant Wine Villages
|
|
1812
|
+
* @name GetTenantWineVillageById
|
|
1813
|
+
* @request GET:/admin/tenants/{tenantId}/wine-villages/{villageId}
|
|
471
1814
|
* @secure
|
|
472
|
-
* @response `
|
|
473
|
-
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
1815
|
+
* @response `200` `WineVillageEntityDto`
|
|
1816
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
474
1817
|
*/
|
|
475
|
-
|
|
1818
|
+
getTenantWineVillageById: (tenantId: string, villageId: string, params?: RequestParams) => Promise<WineVillageEntityDto>;
|
|
1819
|
+
/**
|
|
1820
|
+
* No description
|
|
1821
|
+
*
|
|
1822
|
+
* @tags Admin Tenant Wine Vineyards
|
|
1823
|
+
* @name GetTenantWineVineyardById
|
|
1824
|
+
* @request GET:/admin/tenants/{tenantId}/wine-vineyards/{vineyardId}
|
|
1825
|
+
* @secure
|
|
1826
|
+
* @response `200` `WineVineyardEntityDto`
|
|
1827
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1828
|
+
*/
|
|
1829
|
+
getTenantWineVineyardById: (tenantId: string, vineyardId: string, params?: RequestParams) => Promise<WineVineyardEntityDto>;
|
|
476
1830
|
/**
|
|
477
1831
|
* No description
|
|
478
1832
|
*
|
|
@@ -480,7 +1834,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
480
1834
|
* @name ListTenantUsers
|
|
481
1835
|
* @request GET:/admin/tenants/{tenantId}/users
|
|
482
1836
|
* @secure
|
|
483
|
-
* @response `200` `
|
|
1837
|
+
* @response `200` `TenantUserEntityPaginatedDto`
|
|
484
1838
|
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
485
1839
|
*/
|
|
486
1840
|
listTenantUsers: (tenantId: string, query?: {
|
|
@@ -499,6 +1853,308 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
499
1853
|
search?: string;
|
|
500
1854
|
sortBy?: string[];
|
|
501
1855
|
status?: TenantUserStatusEnum[];
|
|
502
|
-
}, params?: RequestParams) => Promise<
|
|
1856
|
+
}, params?: RequestParams) => Promise<TenantUserEntityPaginatedDto>;
|
|
1857
|
+
/**
|
|
1858
|
+
* No description
|
|
1859
|
+
*
|
|
1860
|
+
* @tags Admin Tenant Wine Brands
|
|
1861
|
+
* @name ListTenantWineBrands
|
|
1862
|
+
* @request GET:/admin/tenants/{tenantId}/wine-brands
|
|
1863
|
+
* @secure
|
|
1864
|
+
* @response `200` `WineBrandEntityPaginatedDto`
|
|
1865
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1866
|
+
*/
|
|
1867
|
+
listTenantWineBrands: (tenantId: string, query?: {
|
|
1868
|
+
createdAt?: string;
|
|
1869
|
+
/**
|
|
1870
|
+
* @default 10
|
|
1871
|
+
* @example 10
|
|
1872
|
+
*/
|
|
1873
|
+
limit?: number;
|
|
1874
|
+
orderBy?: OrderByEnum;
|
|
1875
|
+
/**
|
|
1876
|
+
* @default 1
|
|
1877
|
+
* @example 1
|
|
1878
|
+
*/
|
|
1879
|
+
page?: number;
|
|
1880
|
+
search?: string;
|
|
1881
|
+
sortBy?: string[];
|
|
1882
|
+
}, params?: RequestParams) => Promise<WineBrandEntityPaginatedDto>;
|
|
1883
|
+
/**
|
|
1884
|
+
* No description
|
|
1885
|
+
*
|
|
1886
|
+
* @tags Admin Tenant Wine Producers
|
|
1887
|
+
* @name ListTenantWineProducers
|
|
1888
|
+
* @request GET:/admin/tenants/{tenantId}/wine-producers
|
|
1889
|
+
* @secure
|
|
1890
|
+
* @response `200` `WineProducerEntityPaginatedDto`
|
|
1891
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1892
|
+
*/
|
|
1893
|
+
listTenantWineProducers: (tenantId: string, query?: {
|
|
1894
|
+
createdAt?: string;
|
|
1895
|
+
/**
|
|
1896
|
+
* @default 10
|
|
1897
|
+
* @example 10
|
|
1898
|
+
*/
|
|
1899
|
+
limit?: number;
|
|
1900
|
+
orderBy?: OrderByEnum;
|
|
1901
|
+
/**
|
|
1902
|
+
* @default 1
|
|
1903
|
+
* @example 1
|
|
1904
|
+
*/
|
|
1905
|
+
page?: number;
|
|
1906
|
+
search?: string;
|
|
1907
|
+
sortBy?: string[];
|
|
1908
|
+
}, params?: RequestParams) => Promise<WineProducerEntityPaginatedDto>;
|
|
1909
|
+
/**
|
|
1910
|
+
* No description
|
|
1911
|
+
*
|
|
1912
|
+
* @tags Admin Tenant Wines
|
|
1913
|
+
* @name ListTenantWines
|
|
1914
|
+
* @request GET:/admin/tenants/{tenantId}/wines
|
|
1915
|
+
* @secure
|
|
1916
|
+
* @response `200` `WineEntityPaginatedDto`
|
|
1917
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1918
|
+
*/
|
|
1919
|
+
listTenantWines: (tenantId: string, query?: {
|
|
1920
|
+
brandIds?: string[];
|
|
1921
|
+
createdAt?: string;
|
|
1922
|
+
/**
|
|
1923
|
+
* @default 10
|
|
1924
|
+
* @example 10
|
|
1925
|
+
*/
|
|
1926
|
+
limit?: number;
|
|
1927
|
+
orderBy?: OrderByEnum;
|
|
1928
|
+
/**
|
|
1929
|
+
* @default 1
|
|
1930
|
+
* @example 1
|
|
1931
|
+
*/
|
|
1932
|
+
page?: number;
|
|
1933
|
+
producerIds?: string[];
|
|
1934
|
+
sortBy?: string[];
|
|
1935
|
+
styleIds?: string[];
|
|
1936
|
+
typeIds?: string[];
|
|
1937
|
+
varietalIds?: string[];
|
|
1938
|
+
villageIds?: string[];
|
|
1939
|
+
vineyardIds?: string[];
|
|
1940
|
+
}, params?: RequestParams) => Promise<WineEntityPaginatedDto>;
|
|
1941
|
+
/**
|
|
1942
|
+
* No description
|
|
1943
|
+
*
|
|
1944
|
+
* @tags Admin Tenant Wine Styles
|
|
1945
|
+
* @name ListTenantWineStyles
|
|
1946
|
+
* @request GET:/admin/tenants/{tenantId}/wine-styles
|
|
1947
|
+
* @secure
|
|
1948
|
+
* @response `200` `WineStyleEntityPaginatedDto`
|
|
1949
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1950
|
+
*/
|
|
1951
|
+
listTenantWineStyles: (tenantId: string, query?: {
|
|
1952
|
+
createdAt?: string;
|
|
1953
|
+
/**
|
|
1954
|
+
* @default 10
|
|
1955
|
+
* @example 10
|
|
1956
|
+
*/
|
|
1957
|
+
limit?: number;
|
|
1958
|
+
orderBy?: OrderByEnum;
|
|
1959
|
+
/**
|
|
1960
|
+
* @default 1
|
|
1961
|
+
* @example 1
|
|
1962
|
+
*/
|
|
1963
|
+
page?: number;
|
|
1964
|
+
search?: string;
|
|
1965
|
+
sortBy?: string[];
|
|
1966
|
+
}, params?: RequestParams) => Promise<WineStyleEntityPaginatedDto>;
|
|
1967
|
+
/**
|
|
1968
|
+
* No description
|
|
1969
|
+
*
|
|
1970
|
+
* @tags Admin Tenant Wine Types
|
|
1971
|
+
* @name ListTenantWineTypes
|
|
1972
|
+
* @request GET:/admin/tenants/{tenantId}/wine-types
|
|
1973
|
+
* @secure
|
|
1974
|
+
* @response `200` `WineTypeEntityPaginatedDto`
|
|
1975
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
1976
|
+
*/
|
|
1977
|
+
listTenantWineTypes: (tenantId: string, query?: {
|
|
1978
|
+
createdAt?: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* @default 10
|
|
1981
|
+
* @example 10
|
|
1982
|
+
*/
|
|
1983
|
+
limit?: number;
|
|
1984
|
+
orderBy?: OrderByEnum;
|
|
1985
|
+
/**
|
|
1986
|
+
* @default 1
|
|
1987
|
+
* @example 1
|
|
1988
|
+
*/
|
|
1989
|
+
page?: number;
|
|
1990
|
+
search?: string;
|
|
1991
|
+
sortBy?: string[];
|
|
1992
|
+
}, params?: RequestParams) => Promise<WineTypeEntityPaginatedDto>;
|
|
1993
|
+
/**
|
|
1994
|
+
* No description
|
|
1995
|
+
*
|
|
1996
|
+
* @tags Admin Tenant Wine Varietals
|
|
1997
|
+
* @name ListTenantWineVarietals
|
|
1998
|
+
* @request GET:/admin/tenants/{tenantId}/wine-varietals
|
|
1999
|
+
* @secure
|
|
2000
|
+
* @response `200` `WineVarietalEntityPaginatedDto`
|
|
2001
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
2002
|
+
*/
|
|
2003
|
+
listTenantWineVarietals: (tenantId: string, query?: {
|
|
2004
|
+
createdAt?: string;
|
|
2005
|
+
/**
|
|
2006
|
+
* @default 10
|
|
2007
|
+
* @example 10
|
|
2008
|
+
*/
|
|
2009
|
+
limit?: number;
|
|
2010
|
+
orderBy?: OrderByEnum;
|
|
2011
|
+
/**
|
|
2012
|
+
* @default 1
|
|
2013
|
+
* @example 1
|
|
2014
|
+
*/
|
|
2015
|
+
page?: number;
|
|
2016
|
+
search?: string;
|
|
2017
|
+
sortBy?: string[];
|
|
2018
|
+
}, params?: RequestParams) => Promise<WineVarietalEntityPaginatedDto>;
|
|
2019
|
+
/**
|
|
2020
|
+
* No description
|
|
2021
|
+
*
|
|
2022
|
+
* @tags Admin Tenant Wine Villages
|
|
2023
|
+
* @name ListTenantWineVillages
|
|
2024
|
+
* @request GET:/admin/tenants/{tenantId}/wine-villages
|
|
2025
|
+
* @secure
|
|
2026
|
+
* @response `200` `WineVillageEntityPaginatedDto`
|
|
2027
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
2028
|
+
*/
|
|
2029
|
+
listTenantWineVillages: (tenantId: string, query?: {
|
|
2030
|
+
createdAt?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* @default 10
|
|
2033
|
+
* @example 10
|
|
2034
|
+
*/
|
|
2035
|
+
limit?: number;
|
|
2036
|
+
orderBy?: OrderByEnum;
|
|
2037
|
+
/**
|
|
2038
|
+
* @default 1
|
|
2039
|
+
* @example 1
|
|
2040
|
+
*/
|
|
2041
|
+
page?: number;
|
|
2042
|
+
search?: string;
|
|
2043
|
+
sortBy?: string[];
|
|
2044
|
+
}, params?: RequestParams) => Promise<WineVillageEntityPaginatedDto>;
|
|
2045
|
+
/**
|
|
2046
|
+
* No description
|
|
2047
|
+
*
|
|
2048
|
+
* @tags Admin Tenant Wine Vineyards
|
|
2049
|
+
* @name ListTenantWineVineyards
|
|
2050
|
+
* @request GET:/admin/tenants/{tenantId}/wine-vineyards
|
|
2051
|
+
* @secure
|
|
2052
|
+
* @response `200` `WineVineyardEntityPaginatedDto`
|
|
2053
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
|
|
2054
|
+
*/
|
|
2055
|
+
listTenantWineVineyards: (tenantId: string, query?: {
|
|
2056
|
+
createdAt?: string;
|
|
2057
|
+
/**
|
|
2058
|
+
* @default 10
|
|
2059
|
+
* @example 10
|
|
2060
|
+
*/
|
|
2061
|
+
limit?: number;
|
|
2062
|
+
orderBy?: OrderByEnum;
|
|
2063
|
+
/**
|
|
2064
|
+
* @default 1
|
|
2065
|
+
* @example 1
|
|
2066
|
+
*/
|
|
2067
|
+
page?: number;
|
|
2068
|
+
search?: string;
|
|
2069
|
+
sortBy?: string[];
|
|
2070
|
+
}, params?: RequestParams) => Promise<WineVineyardEntityPaginatedDto>;
|
|
2071
|
+
/**
|
|
2072
|
+
* No description
|
|
2073
|
+
*
|
|
2074
|
+
* @tags Admin Tenant Wines
|
|
2075
|
+
* @name UpdateTenantWine
|
|
2076
|
+
* @request PATCH:/admin/tenants/{tenantId}/wines/{wineId}
|
|
2077
|
+
* @secure
|
|
2078
|
+
* @response `200` `WineEntityDto`
|
|
2079
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2080
|
+
*/
|
|
2081
|
+
updateTenantWine: (tenantId: string, wineId: string, data: UpdateWineDto, params?: RequestParams) => Promise<WineEntityDto>;
|
|
2082
|
+
/**
|
|
2083
|
+
* No description
|
|
2084
|
+
*
|
|
2085
|
+
* @tags Admin Tenant Wine Brands
|
|
2086
|
+
* @name UpdateTenantWineBrand
|
|
2087
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-brands/{brandId}
|
|
2088
|
+
* @secure
|
|
2089
|
+
* @response `200` `WineBrandEntityDto`
|
|
2090
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2091
|
+
*/
|
|
2092
|
+
updateTenantWineBrand: (tenantId: string, brandId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineBrandEntityDto>;
|
|
2093
|
+
/**
|
|
2094
|
+
* No description
|
|
2095
|
+
*
|
|
2096
|
+
* @tags Admin Tenant Wine Producers
|
|
2097
|
+
* @name UpdateTenantWineProducer
|
|
2098
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-producers/{producerId}
|
|
2099
|
+
* @secure
|
|
2100
|
+
* @response `200` `WineProducerEntityDto`
|
|
2101
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2102
|
+
*/
|
|
2103
|
+
updateTenantWineProducer: (tenantId: string, producerId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineProducerEntityDto>;
|
|
2104
|
+
/**
|
|
2105
|
+
* No description
|
|
2106
|
+
*
|
|
2107
|
+
* @tags Admin Tenant Wine Styles
|
|
2108
|
+
* @name UpdateTenantWineStyle
|
|
2109
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-styles/{styleId}
|
|
2110
|
+
* @secure
|
|
2111
|
+
* @response `200` `WineStyleEntityDto`
|
|
2112
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2113
|
+
*/
|
|
2114
|
+
updateTenantWineStyle: (tenantId: string, styleId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineStyleEntityDto>;
|
|
2115
|
+
/**
|
|
2116
|
+
* No description
|
|
2117
|
+
*
|
|
2118
|
+
* @tags Admin Tenant Wine Types
|
|
2119
|
+
* @name UpdateTenantWineType
|
|
2120
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-types/{typeId}
|
|
2121
|
+
* @secure
|
|
2122
|
+
* @response `200` `WineTypeEntityDto`
|
|
2123
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2124
|
+
*/
|
|
2125
|
+
updateTenantWineType: (tenantId: string, typeId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineTypeEntityDto>;
|
|
2126
|
+
/**
|
|
2127
|
+
* No description
|
|
2128
|
+
*
|
|
2129
|
+
* @tags Admin Tenant Wine Varietals
|
|
2130
|
+
* @name UpdateTenantWineVarietal
|
|
2131
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-varietals/{varietalId}
|
|
2132
|
+
* @secure
|
|
2133
|
+
* @response `200` `WineVarietalEntityDto`
|
|
2134
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2135
|
+
*/
|
|
2136
|
+
updateTenantWineVarietal: (tenantId: string, varietalId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineVarietalEntityDto>;
|
|
2137
|
+
/**
|
|
2138
|
+
* No description
|
|
2139
|
+
*
|
|
2140
|
+
* @tags Admin Tenant Wine Villages
|
|
2141
|
+
* @name UpdateTenantWineVillage
|
|
2142
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-villages/{villageId}
|
|
2143
|
+
* @secure
|
|
2144
|
+
* @response `200` `WineVillageEntityDto`
|
|
2145
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2146
|
+
*/
|
|
2147
|
+
updateTenantWineVillage: (tenantId: string, villageId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineVillageEntityDto>;
|
|
2148
|
+
/**
|
|
2149
|
+
* No description
|
|
2150
|
+
*
|
|
2151
|
+
* @tags Admin Tenant Wine Vineyards
|
|
2152
|
+
* @name UpdateTenantWineVineyard
|
|
2153
|
+
* @request PATCH:/admin/tenants/{tenantId}/wine-vineyards/{vineyardId}
|
|
2154
|
+
* @secure
|
|
2155
|
+
* @response `200` `WineVineyardEntityDto`
|
|
2156
|
+
* @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin
|
|
2157
|
+
*/
|
|
2158
|
+
updateTenantWineVineyard: (tenantId: string, vineyardId: string, data: UpdateNameOnlyEntityDto, params?: RequestParams) => Promise<WineVineyardEntityDto>;
|
|
503
2159
|
};
|
|
504
2160
|
}
|