@indigina/wms-api 0.0.81 → 0.0.82
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/README.md +75 -126
- package/fesm2022/indigina-wms-api.mjs +972 -3144
- package/fesm2022/indigina-wms-api.mjs.map +1 -1
- package/index.d.ts +3781 -6
- package/package.json +2 -2
- package/api/analytics.service.d.ts +0 -210
- package/api/api.d.ts +0 -45
- package/api/carrierProviderIntegrations.service.d.ts +0 -42
- package/api/companies.service.d.ts +0 -63
- package/api/dcs.service.d.ts +0 -161
- package/api/deliveries.service.d.ts +0 -287
- package/api/deliveryItems.service.d.ts +0 -130
- package/api/dispatchItems.service.d.ts +0 -43
- package/api/dispatches.service.d.ts +0 -178
- package/api/health.service.d.ts +0 -36
- package/api/notes.service.d.ts +0 -96
- package/api/permissions.service.d.ts +0 -37
- package/api/productMasters.service.d.ts +0 -42
- package/api/productQuantities.service.d.ts +0 -42
- package/api/reasons.service.d.ts +0 -42
- package/api/replenishment.service.d.ts +0 -42
- package/api/settings.service.d.ts +0 -147
- package/api/summary.service.d.ts +0 -38
- package/api/taskCompletionTime.service.d.ts +0 -128
- package/api/taskOperations.service.d.ts +0 -128
- package/api/taskUserRecords.service.d.ts +0 -201
- package/api/user.service.d.ts +0 -103
- package/api/usersInternal.service.d.ts +0 -42
- package/api.module.d.ts +0 -11
- package/configuration.d.ts +0 -104
- package/encoder.d.ts +0 -11
- package/model/access.d.ts +0 -14
- package/model/applicationSetting.d.ts +0 -14
- package/model/carrierProviderIntegration.d.ts +0 -18
- package/model/carrierProviderIntegrations.d.ts +0 -14
- package/model/commandStatusResult.d.ts +0 -12
- package/model/companies.d.ts +0 -14
- package/model/company.d.ts +0 -14
- package/model/countingSummary.d.ts +0 -16
- package/model/currentUser.d.ts +0 -24
- package/model/dc.d.ts +0 -16
- package/model/dcs.d.ts +0 -14
- package/model/deliveries.d.ts +0 -14
- package/model/delivery.d.ts +0 -37
- package/model/deliveryGridView.d.ts +0 -44
- package/model/deliveryItem.d.ts +0 -31
- package/model/deliveryItemView.d.ts +0 -29
- package/model/deliveryItems.d.ts +0 -14
- package/model/deliverySummary.d.ts +0 -36
- package/model/deliveryType.d.ts +0 -17
- package/model/deliveryView.d.ts +0 -32
- package/model/deviceType.d.ts +0 -15
- package/model/dispatch.d.ts +0 -85
- package/model/dispatchGridView.d.ts +0 -60
- package/model/dispatchItemView.d.ts +0 -32
- package/model/dispatchItems.d.ts +0 -14
- package/model/dispatchSummary.d.ts +0 -17
- package/model/dispatchSummaryView.d.ts +0 -86
- package/model/dispatchView.d.ts +0 -53
- package/model/dispatches.d.ts +0 -14
- package/model/embedReport.d.ts +0 -18
- package/model/embedTokenDto.d.ts +0 -13
- package/model/entityList.d.ts +0 -13
- package/model/failures.d.ts +0 -16
- package/model/group.d.ts +0 -20
- package/model/modelError.d.ts +0 -15
- package/model/models.d.ts +0 -75
- package/model/note.d.ts +0 -20
- package/model/noteCategory.d.ts +0 -16
- package/model/noteSourceType.d.ts +0 -14
- package/model/noteView.d.ts +0 -16
- package/model/notes.d.ts +0 -14
- package/model/orderStatus.d.ts +0 -30
- package/model/orderType.d.ts +0 -20
- package/model/packingProcesses.d.ts +0 -20
- package/model/pickingProcesses.d.ts +0 -20
- package/model/productMaster.d.ts +0 -20
- package/model/productMasters.d.ts +0 -14
- package/model/productQuantities.d.ts +0 -14
- package/model/productQuantity.d.ts +0 -14
- package/model/qcType.d.ts +0 -13
- package/model/reason.d.ts +0 -17
- package/model/reasonType.d.ts +0 -14
- package/model/reasons.d.ts +0 -14
- package/model/receivingSummary.d.ts +0 -16
- package/model/recordType.d.ts +0 -14
- package/model/replenishmentAccessGridView.d.ts +0 -18
- package/model/replenishmentAccessView.d.ts +0 -14
- package/model/replenishmentSummary.d.ts +0 -16
- package/model/report.d.ts +0 -26
- package/model/setNewFeaturesVisibilityCommand.d.ts +0 -12
- package/model/settingValue.d.ts +0 -13
- package/model/settingView.d.ts +0 -14
- package/model/taskCompletionTime.d.ts +0 -16
- package/model/taskCompletionTimes.d.ts +0 -14
- package/model/taskOperation.d.ts +0 -18
- package/model/taskOperations.d.ts +0 -14
- package/model/taskUserRecord.d.ts +0 -24
- package/model/taskUserRecordSelf.d.ts +0 -17
- package/model/taskUserRecordView.d.ts +0 -29
- package/model/taskUserRecords.d.ts +0 -14
- package/model/userApplication.d.ts +0 -13
- package/model/userApplications.d.ts +0 -13
- package/model/userCompanyType.d.ts +0 -22
- package/model/userInfo.d.ts +0 -14
- package/model/userInfos.d.ts +0 -14
- package/model/userPermissions.d.ts +0 -12
- package/param.d.ts +0 -37
- package/variables.d.ts +0 -8
package/model/recordType.d.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export type RecordType = 'Web' | 'Hub';
|
|
11
|
-
export declare const RecordType: {
|
|
12
|
-
Web: RecordType;
|
|
13
|
-
Hub: RecordType;
|
|
14
|
-
};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface ReplenishmentAccessGridView {
|
|
11
|
-
id: string;
|
|
12
|
-
clientId: string;
|
|
13
|
-
createdUserId: string;
|
|
14
|
-
client: string;
|
|
15
|
-
systemReplenishment: boolean;
|
|
16
|
-
createdDate: string;
|
|
17
|
-
createdBy: string;
|
|
18
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface ReplenishmentAccessView {
|
|
11
|
-
id: string;
|
|
12
|
-
clientId: string;
|
|
13
|
-
createdUserId: string;
|
|
14
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface ReplenishmentSummary {
|
|
11
|
-
unallocatedCount: number;
|
|
12
|
-
allocatedCount: number;
|
|
13
|
-
completedCount: number;
|
|
14
|
-
cancelledCount: number;
|
|
15
|
-
clientName: string;
|
|
16
|
-
}
|
package/model/report.d.ts
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface Report {
|
|
11
|
-
id?: number;
|
|
12
|
-
name: string;
|
|
13
|
-
columnOrder: number;
|
|
14
|
-
sortOrder: number;
|
|
15
|
-
isEmbeddingAllowed: boolean;
|
|
16
|
-
isPaginated: boolean;
|
|
17
|
-
showPagesPane: boolean;
|
|
18
|
-
serviceId: string;
|
|
19
|
-
permission?: string;
|
|
20
|
-
displayName?: string;
|
|
21
|
-
reportId?: string;
|
|
22
|
-
powerBiTenant?: string;
|
|
23
|
-
workspaceId?: string;
|
|
24
|
-
pageName?: string;
|
|
25
|
-
groupId: number;
|
|
26
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface SetNewFeaturesVisibilityCommand {
|
|
11
|
-
value: boolean;
|
|
12
|
-
}
|
package/model/settingValue.d.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface SettingValue {
|
|
11
|
-
value?: string;
|
|
12
|
-
group: string | null;
|
|
13
|
-
}
|
package/model/settingView.d.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface SettingView {
|
|
11
|
-
key: string;
|
|
12
|
-
value?: string;
|
|
13
|
-
group: string | null;
|
|
14
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface TaskCompletionTime {
|
|
11
|
-
id?: number;
|
|
12
|
-
/**
|
|
13
|
-
* Value should be provided in the format \'hh:mm:ss\'
|
|
14
|
-
*/
|
|
15
|
-
completionTime: string;
|
|
16
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { TaskCompletionTime } from './taskCompletionTime';
|
|
11
|
-
export interface TaskCompletionTimes {
|
|
12
|
-
total: number;
|
|
13
|
-
data: Array<TaskCompletionTime>;
|
|
14
|
-
}
|
package/model/taskOperation.d.ts
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface TaskOperation {
|
|
11
|
-
id?: number;
|
|
12
|
-
title: string;
|
|
13
|
-
notes: string;
|
|
14
|
-
/**
|
|
15
|
-
* Indicates if the task operation has any user records associated with it.
|
|
16
|
-
*/
|
|
17
|
-
hasRecords?: boolean;
|
|
18
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { TaskOperation } from './taskOperation';
|
|
11
|
-
export interface TaskOperations {
|
|
12
|
-
total: number;
|
|
13
|
-
data: Array<TaskOperation>;
|
|
14
|
-
}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { DeviceType } from './deviceType';
|
|
11
|
-
export interface TaskUserRecord {
|
|
12
|
-
taskOperationId: number;
|
|
13
|
-
clientId?: string;
|
|
14
|
-
startedDeviceType: DeviceType;
|
|
15
|
-
id?: number;
|
|
16
|
-
userId?: string | null;
|
|
17
|
-
startedUserId?: string | null;
|
|
18
|
-
startedDate?: string;
|
|
19
|
-
finishedUserId?: string | null;
|
|
20
|
-
finishedDate?: string | null;
|
|
21
|
-
finishedDeviceType?: DeviceType;
|
|
22
|
-
}
|
|
23
|
-
export declare namespace TaskUserRecord {
|
|
24
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { DeviceType } from './deviceType';
|
|
11
|
-
export interface TaskUserRecordSelf {
|
|
12
|
-
taskOperationId: number;
|
|
13
|
-
clientId?: string;
|
|
14
|
-
startedDeviceType: DeviceType;
|
|
15
|
-
}
|
|
16
|
-
export declare namespace TaskUserRecordSelf {
|
|
17
|
-
}
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { DeviceType } from './deviceType';
|
|
11
|
-
export interface TaskUserRecordView {
|
|
12
|
-
id?: number;
|
|
13
|
-
userId?: string | null;
|
|
14
|
-
userName?: string;
|
|
15
|
-
taskOperationId: number;
|
|
16
|
-
taskOperationName: string;
|
|
17
|
-
clientId?: string;
|
|
18
|
-
clientName?: string;
|
|
19
|
-
startedUserId?: string | null;
|
|
20
|
-
startedUserName?: string;
|
|
21
|
-
startedDate?: string;
|
|
22
|
-
startedDeviceType: DeviceType;
|
|
23
|
-
finishedUserId?: string | null;
|
|
24
|
-
finishedUserName?: string;
|
|
25
|
-
finishedDate?: string | null;
|
|
26
|
-
finishedDeviceType?: DeviceType;
|
|
27
|
-
}
|
|
28
|
-
export declare namespace TaskUserRecordView {
|
|
29
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { TaskUserRecordView } from './taskUserRecordView';
|
|
11
|
-
export interface TaskUserRecords {
|
|
12
|
-
total: number;
|
|
13
|
-
data: Array<TaskUserRecordView>;
|
|
14
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface UserApplication {
|
|
11
|
-
name: string;
|
|
12
|
-
url: string | null;
|
|
13
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { UserApplication } from './userApplication';
|
|
11
|
-
export interface UserApplications {
|
|
12
|
-
applications: Array<UserApplication>;
|
|
13
|
-
}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export type UserCompanyType = 'DC' | 'Client' | 'OriginAgent' | 'DestinationAgent' | 'Vendor' | 'Integration' | 'SystemAdmin' | 'ReportAdmin' | 'SS_SysAdmin' | 'SS_ReportAdmin';
|
|
11
|
-
export declare const UserCompanyType: {
|
|
12
|
-
Dc: UserCompanyType;
|
|
13
|
-
Client: UserCompanyType;
|
|
14
|
-
OriginAgent: UserCompanyType;
|
|
15
|
-
DestinationAgent: UserCompanyType;
|
|
16
|
-
Vendor: UserCompanyType;
|
|
17
|
-
Integration: UserCompanyType;
|
|
18
|
-
SystemAdmin: UserCompanyType;
|
|
19
|
-
ReportAdmin: UserCompanyType;
|
|
20
|
-
SsSysAdmin: UserCompanyType;
|
|
21
|
-
SsReportAdmin: UserCompanyType;
|
|
22
|
-
};
|
package/model/userInfo.d.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface UserInfo {
|
|
11
|
-
id?: string;
|
|
12
|
-
userName: string;
|
|
13
|
-
fullName: string;
|
|
14
|
-
}
|
package/model/userInfos.d.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
import { UserInfo } from './userInfo';
|
|
11
|
-
export interface UserInfos {
|
|
12
|
-
total: number;
|
|
13
|
-
data: Array<UserInfo>;
|
|
14
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wms.API.Client
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
-
* https://openapi-generator.tech
|
|
8
|
-
* Do not edit the class manually.
|
|
9
|
-
*/
|
|
10
|
-
export interface UserPermissions {
|
|
11
|
-
permissions: Array<string>;
|
|
12
|
-
}
|
package/param.d.ts
DELETED
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Standard parameter styles defined by OpenAPI spec
|
|
3
|
-
*/
|
|
4
|
-
export type StandardParamStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
|
|
5
|
-
/**
|
|
6
|
-
* The OpenAPI standard {@link StandardParamStyle}s may be extended by custom styles by the user.
|
|
7
|
-
*/
|
|
8
|
-
export type ParamStyle = StandardParamStyle | string;
|
|
9
|
-
/**
|
|
10
|
-
* Standard parameter locations defined by OpenAPI spec
|
|
11
|
-
*/
|
|
12
|
-
export type ParamLocation = 'query' | 'header' | 'path' | 'cookie';
|
|
13
|
-
/**
|
|
14
|
-
* Standard types as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
|
|
15
|
-
*/
|
|
16
|
-
export type StandardDataType = "integer" | "number" | "boolean" | "string" | "object" | "array";
|
|
17
|
-
/**
|
|
18
|
-
* Standard {@link DataType}s plus your own types/classes.
|
|
19
|
-
*/
|
|
20
|
-
export type DataType = StandardDataType | string;
|
|
21
|
-
/**
|
|
22
|
-
* Standard formats as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
|
|
23
|
-
*/
|
|
24
|
-
export type StandardDataFormat = "int32" | "int64" | "float" | "double" | "byte" | "binary" | "date" | "date-time" | "password";
|
|
25
|
-
export type DataFormat = StandardDataFormat | string;
|
|
26
|
-
/**
|
|
27
|
-
* The parameter to encode.
|
|
28
|
-
*/
|
|
29
|
-
export interface Param {
|
|
30
|
-
name: string;
|
|
31
|
-
value: unknown;
|
|
32
|
-
in: ParamLocation;
|
|
33
|
-
style: ParamStyle;
|
|
34
|
-
explode: boolean;
|
|
35
|
-
dataType: DataType;
|
|
36
|
-
dataFormat: DataFormat | undefined;
|
|
37
|
-
}
|