@vality/swag-wallets 0.1.3
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 +236 -0
- package/api/api.d.ts +23 -0
- package/api/currencies.service.d.ts +41 -0
- package/api/deposits.service.d.ts +171 -0
- package/api/downloads.service.d.ts +41 -0
- package/api/identities.service.d.ts +134 -0
- package/api/providers.service.d.ts +70 -0
- package/api/reports.service.d.ts +116 -0
- package/api/residences.service.d.ts +41 -0
- package/api/w2W.service.d.ts +71 -0
- package/api/wallets.service.d.ts +199 -0
- package/api/webhooks.service.d.ts +132 -0
- package/api/withdrawals.service.d.ts +410 -0
- package/api.base.service.d.ts +12 -0
- package/api.module.d.ts +11 -0
- package/configuration.d.ts +106 -0
- package/encoder.d.ts +11 -0
- package/fesm2022/vality-swag-wallets.mjs +3577 -0
- package/fesm2022/vality-swag-wallets.mjs.map +1 -0
- package/index.d.ts +6 -0
- package/model/asset.d.ts +22 -0
- package/model/badRequest.d.ts +38 -0
- package/model/bankCardDestinationResource.d.ts +29 -0
- package/model/bankCardReceiverResource.d.ts +33 -0
- package/model/bankCardReceiverResourceParams.d.ts +29 -0
- package/model/bankCardSenderResource.d.ts +33 -0
- package/model/bankCardSenderResourceParams.d.ts +33 -0
- package/model/browserGetRequest.d.ts +16 -0
- package/model/browserPostRequest.d.ts +21 -0
- package/model/browserRequest.d.ts +15 -0
- package/model/conflictRequest.d.ts +23 -0
- package/model/contactInfo.d.ts +22 -0
- package/model/cryptoWallet.d.ts +22 -0
- package/model/cryptoWalletDestinationResource.d.ts +25 -0
- package/model/currency.d.ts +34 -0
- package/model/deposit.d.ts +56 -0
- package/model/depositAdjustment.d.ts +40 -0
- package/model/depositAdjustmentFailure.d.ts +17 -0
- package/model/depositAdjustmentStatus.d.ts +25 -0
- package/model/depositAdjustmentStatusFailure.d.ts +20 -0
- package/model/depositAllOfBody.d.ts +22 -0
- package/model/depositAllOfFee.d.ts +22 -0
- package/model/depositFailure.d.ts +17 -0
- package/model/depositRevert.d.ts +51 -0
- package/model/depositRevertAllOfBody.d.ts +22 -0
- package/model/depositRevertFailure.d.ts +17 -0
- package/model/depositRevertStatus.d.ts +25 -0
- package/model/depositRevertStatusFailure.d.ts +20 -0
- package/model/depositStatus.d.ts +25 -0
- package/model/depositStatusFailure.d.ts +20 -0
- package/model/destination.d.ts +65 -0
- package/model/destinationAuthData.d.ts +24 -0
- package/model/destinationGrantRequest.d.ts +22 -0
- package/model/destinationResource.d.ts +26 -0
- package/model/destinationStatus.d.ts +26 -0
- package/model/destinationsTopic.d.ts +27 -0
- package/model/digitalWallet.d.ts +34 -0
- package/model/digitalWalletDestinationResource.d.ts +37 -0
- package/model/fileDownload.d.ts +19 -0
- package/model/getWithdrawalMethods200Response.d.ts +13 -0
- package/model/identity.d.ts +46 -0
- package/model/invalidOperationParameters.d.ts +15 -0
- package/model/listDepositAdjustments200Response.d.ts +20 -0
- package/model/listDepositReverts200Response.d.ts +20 -0
- package/model/listDeposits200Response.d.ts +20 -0
- package/model/listDestinations200Response.d.ts +20 -0
- package/model/listIdentities200Response.d.ts +20 -0
- package/model/listWallets200Response.d.ts +20 -0
- package/model/listWithdrawals200Response.d.ts +20 -0
- package/model/models.d.ts +104 -0
- package/model/provider.d.ts +26 -0
- package/model/quoteParameters.d.ts +24 -0
- package/model/quoteParametersBody.d.ts +22 -0
- package/model/receiverResource.d.ts +24 -0
- package/model/receiverResourceParams.d.ts +24 -0
- package/model/redirect.d.ts +14 -0
- package/model/report.d.ts +49 -0
- package/model/reportFilesInner.d.ts +15 -0
- package/model/reportParams.d.ts +29 -0
- package/model/residence.d.ts +26 -0
- package/model/securedBankCard.d.ts +26 -0
- package/model/senderReceiverDestinationAuthData.d.ts +25 -0
- package/model/senderResource.d.ts +24 -0
- package/model/senderResourceParams.d.ts +24 -0
- package/model/subFailure.d.ts +19 -0
- package/model/userInteraction.d.ts +15 -0
- package/model/userInteractionChange.d.ts +22 -0
- package/model/userInteractionCreated.d.ts +16 -0
- package/model/userInteractionFinished.d.ts +14 -0
- package/model/userInteractionFormInner.d.ts +19 -0
- package/model/w2WTransfer.d.ts +38 -0
- package/model/w2WTransferFailure.d.ts +20 -0
- package/model/w2WTransferParameters.d.ts +28 -0
- package/model/w2WTransferParametersBody.d.ts +22 -0
- package/model/w2WTransferStatus.d.ts +25 -0
- package/model/w2WTransferStatusFailure.d.ts +20 -0
- package/model/wallet.d.ts +46 -0
- package/model/walletAccount.d.ts +18 -0
- package/model/walletAccountAvailable.d.ts +22 -0
- package/model/walletAccountOwn.d.ts +22 -0
- package/model/walletGrantRequest.d.ts +24 -0
- package/model/walletGrantRequestAsset.d.ts +22 -0
- package/model/webhook.d.ts +33 -0
- package/model/webhookScope.d.ts +25 -0
- package/model/withdrawal.d.ts +58 -0
- package/model/withdrawalAllOfBody.d.ts +22 -0
- package/model/withdrawalAllOfQuote.d.ts +24 -0
- package/model/withdrawalEvent.d.ts +24 -0
- package/model/withdrawalEventChange.d.ts +24 -0
- package/model/withdrawalFailure.d.ts +17 -0
- package/model/withdrawalMethod.d.ts +23 -0
- package/model/withdrawalMethodBankCard.d.ts +18 -0
- package/model/withdrawalMethodDigitalWallet.d.ts +18 -0
- package/model/withdrawalMethodGeneric.d.ts +18 -0
- package/model/withdrawalParameters.d.ts +70 -0
- package/model/withdrawalQuote.d.ts +30 -0
- package/model/withdrawalQuoteCashFrom.d.ts +22 -0
- package/model/withdrawalQuoteCashTo.d.ts +22 -0
- package/model/withdrawalQuoteParams.d.ts +44 -0
- package/model/withdrawalQuoteParamsCash.d.ts +22 -0
- package/model/withdrawalReadQuote.d.ts +26 -0
- package/model/withdrawalStatus.d.ts +25 -0
- package/model/withdrawalStatusChanged.d.ts +29 -0
- package/model/withdrawalStatusFailure.d.ts +20 -0
- package/model/withdrawalsTopic.d.ts +31 -0
- package/package.json +34 -0
- package/param.d.ts +37 -0
- package/variables.d.ts +8 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { WithdrawalQuoteCashFrom } from './withdrawalQuoteCashFrom';
|
|
11
|
+
import { WithdrawalQuoteCashTo } from './withdrawalQuoteCashTo';
|
|
12
|
+
/**
|
|
13
|
+
* Quote data for withdrawal
|
|
14
|
+
*/
|
|
15
|
+
export interface WithdrawalQuote {
|
|
16
|
+
cashFrom: WithdrawalQuoteCashFrom;
|
|
17
|
+
cashTo: WithdrawalQuoteCashTo;
|
|
18
|
+
/**
|
|
19
|
+
* Date and time the quote was received
|
|
20
|
+
*/
|
|
21
|
+
readonly createdAt: string;
|
|
22
|
+
/**
|
|
23
|
+
* Quote expiration date and time
|
|
24
|
+
*/
|
|
25
|
+
readonly expiresOn: string;
|
|
26
|
+
/**
|
|
27
|
+
* Quote at which funds should be withdrawn. Must be provided when creating withdrawal with conversion
|
|
28
|
+
*/
|
|
29
|
+
quoteToken: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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
|
+
/**
|
|
11
|
+
* Amount of funds in source currency
|
|
12
|
+
*/
|
|
13
|
+
export interface WithdrawalQuoteCashFrom {
|
|
14
|
+
/**
|
|
15
|
+
* The amount of money in minor units, for example, in cents
|
|
16
|
+
*/
|
|
17
|
+
amount: number;
|
|
18
|
+
/**
|
|
19
|
+
* Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
|
|
20
|
+
*/
|
|
21
|
+
currency: string;
|
|
22
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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
|
+
/**
|
|
11
|
+
* Amount of funds in target currency
|
|
12
|
+
*/
|
|
13
|
+
export interface WithdrawalQuoteCashTo {
|
|
14
|
+
/**
|
|
15
|
+
* The amount of money in minor units, for example, in cents
|
|
16
|
+
*/
|
|
17
|
+
amount: number;
|
|
18
|
+
/**
|
|
19
|
+
* Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
|
|
20
|
+
*/
|
|
21
|
+
currency: string;
|
|
22
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { WithdrawalQuoteParamsCash } from './withdrawalQuoteParamsCash';
|
|
11
|
+
/**
|
|
12
|
+
* Quote parameters for withdrawal
|
|
13
|
+
*/
|
|
14
|
+
export interface WithdrawalQuoteParams {
|
|
15
|
+
/**
|
|
16
|
+
* The unique identifier of the entity on your side. When specified, will be used to ensure idempotent processing of the operation.
|
|
17
|
+
*/
|
|
18
|
+
externalID?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Identifier of the wallet
|
|
21
|
+
*/
|
|
22
|
+
walletID: string;
|
|
23
|
+
/**
|
|
24
|
+
* Destination identifier
|
|
25
|
+
*/
|
|
26
|
+
destinationID?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Source currency code
|
|
29
|
+
*/
|
|
30
|
+
currencyFrom: string;
|
|
31
|
+
/**
|
|
32
|
+
* Target currency code
|
|
33
|
+
*/
|
|
34
|
+
currencyTo: string;
|
|
35
|
+
cash: WithdrawalQuoteParamsCash;
|
|
36
|
+
/**
|
|
37
|
+
* A token that gives the right to withdraw from the wallet to pay for the withdrawal. It is necessary to provide if the withdrawal is made at the expense of the funds of a _foreign_ wallet. The owner of the specified wallet can [issue this right](#operation/issueWalletGrant)
|
|
38
|
+
*/
|
|
39
|
+
walletGrant?: string;
|
|
40
|
+
/**
|
|
41
|
+
* A token that gives the right to withdraw. Must be provided if the withdrawal is made through a _foreign_ fund recipient. The owner of the specified recipient can [grant this right](#operation/issueDestinationGrant)
|
|
42
|
+
*/
|
|
43
|
+
destinationGrant?: string;
|
|
44
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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
|
+
/**
|
|
11
|
+
* The amount of funds for receiving a quote in one of the exchange currencies
|
|
12
|
+
*/
|
|
13
|
+
export interface WithdrawalQuoteParamsCash {
|
|
14
|
+
/**
|
|
15
|
+
* The amount of money in minor units, for example, in cents
|
|
16
|
+
*/
|
|
17
|
+
amount: number;
|
|
18
|
+
/**
|
|
19
|
+
* Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
|
|
20
|
+
*/
|
|
21
|
+
currency: string;
|
|
22
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { WithdrawalQuoteCashFrom } from './withdrawalQuoteCashFrom';
|
|
11
|
+
import { WithdrawalQuoteCashTo } from './withdrawalQuoteCashTo';
|
|
12
|
+
/**
|
|
13
|
+
* Quote data for withdrawal
|
|
14
|
+
*/
|
|
15
|
+
export interface WithdrawalReadQuote {
|
|
16
|
+
cashFrom: WithdrawalQuoteCashFrom;
|
|
17
|
+
cashTo: WithdrawalQuoteCashTo;
|
|
18
|
+
/**
|
|
19
|
+
* Date and time the quote was received
|
|
20
|
+
*/
|
|
21
|
+
readonly createdAt: string;
|
|
22
|
+
/**
|
|
23
|
+
* Quote expiration date and time
|
|
24
|
+
*/
|
|
25
|
+
readonly expiresOn: string;
|
|
26
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { WithdrawalStatusFailure } from './withdrawalStatusFailure';
|
|
11
|
+
export interface WithdrawalStatus {
|
|
12
|
+
/**
|
|
13
|
+
* Withdrawal status. | Meaning | Explanation | | ----------- | ------------------------------------ | | `Pending` | Withdrawal in progress | | `Succeeded` | Withdrawal completed successfully | | `Failed` | Withdrawal failed |
|
|
14
|
+
*/
|
|
15
|
+
readonly status?: WithdrawalStatus.StatusEnum;
|
|
16
|
+
failure?: WithdrawalStatusFailure;
|
|
17
|
+
}
|
|
18
|
+
export declare namespace WithdrawalStatus {
|
|
19
|
+
type StatusEnum = 'Pending' | 'Succeeded' | 'Failed';
|
|
20
|
+
const StatusEnum: {
|
|
21
|
+
Pending: StatusEnum;
|
|
22
|
+
Succeeded: StatusEnum;
|
|
23
|
+
Failed: StatusEnum;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { WithdrawalEventChange } from './withdrawalEventChange';
|
|
11
|
+
import { WithdrawalStatusFailure } from './withdrawalStatusFailure';
|
|
12
|
+
/**
|
|
13
|
+
* Change of withdrawal status
|
|
14
|
+
*/
|
|
15
|
+
export interface WithdrawalStatusChanged extends WithdrawalEventChange {
|
|
16
|
+
/**
|
|
17
|
+
* Withdrawal status. | Meaning | Explanation | | ----------- | ------------------------------------ | | `Pending` | Withdrawal in progress | | `Succeeded` | Withdrawal completed successfully | | `Failed` | Withdrawal failed |
|
|
18
|
+
*/
|
|
19
|
+
readonly status?: WithdrawalStatusChanged.StatusEnum;
|
|
20
|
+
failure?: WithdrawalStatusFailure;
|
|
21
|
+
}
|
|
22
|
+
export declare namespace WithdrawalStatusChanged {
|
|
23
|
+
type StatusEnum = 'Pending' | 'Succeeded' | 'Failed';
|
|
24
|
+
const StatusEnum: {
|
|
25
|
+
Pending: StatusEnum;
|
|
26
|
+
Succeeded: StatusEnum;
|
|
27
|
+
Failed: StatusEnum;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { SubFailure } from './subFailure';
|
|
11
|
+
/**
|
|
12
|
+
* > If `status` == `Failed` Explaining the reason for failure
|
|
13
|
+
*/
|
|
14
|
+
export interface WithdrawalStatusFailure {
|
|
15
|
+
/**
|
|
16
|
+
* Withdrawal error code
|
|
17
|
+
*/
|
|
18
|
+
code: string;
|
|
19
|
+
subError?: SubFailure;
|
|
20
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vality Wallet API
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@vality.dev
|
|
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 { WebhookScope } from './webhookScope';
|
|
11
|
+
/**
|
|
12
|
+
* Scope that includes withdrawal events within a specific wallet
|
|
13
|
+
*/
|
|
14
|
+
export interface WithdrawalsTopic extends WebhookScope {
|
|
15
|
+
/**
|
|
16
|
+
* Identifier of the wallet
|
|
17
|
+
*/
|
|
18
|
+
walletID?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Set of withdrawal event types to be notified about
|
|
21
|
+
*/
|
|
22
|
+
eventTypes: Array<WithdrawalsTopic.EventTypesEnum>;
|
|
23
|
+
}
|
|
24
|
+
export declare namespace WithdrawalsTopic {
|
|
25
|
+
type EventTypesEnum = 'WithdrawalStarted' | 'WithdrawalSucceeded' | 'WithdrawalFailed';
|
|
26
|
+
const EventTypesEnum: {
|
|
27
|
+
WithdrawalStarted: EventTypesEnum;
|
|
28
|
+
WithdrawalSucceeded: EventTypesEnum;
|
|
29
|
+
WithdrawalFailed: EventTypesEnum;
|
|
30
|
+
};
|
|
31
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@vality/swag-wallets",
|
|
3
|
+
"version": "0.1.3",
|
|
4
|
+
"description": "OpenAPI client for @vality/swag-wallets",
|
|
5
|
+
"author": "OpenAPI-Generator Contributors",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"openapi-client",
|
|
8
|
+
"openapi-generator"
|
|
9
|
+
],
|
|
10
|
+
"license": "Apache-2.0",
|
|
11
|
+
"peerDependencies": {
|
|
12
|
+
"@angular/core": "*",
|
|
13
|
+
"rxjs": "*"
|
|
14
|
+
},
|
|
15
|
+
"module": "fesm2022/vality-swag-wallets.mjs",
|
|
16
|
+
"typings": "index.d.ts",
|
|
17
|
+
"exports": {
|
|
18
|
+
"./package.json": {
|
|
19
|
+
"default": "./package.json"
|
|
20
|
+
},
|
|
21
|
+
".": {
|
|
22
|
+
"types": "./index.d.ts",
|
|
23
|
+
"default": "./fesm2022/vality-swag-wallets.mjs"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"sideEffects": false,
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"tslib": "^2.3.0"
|
|
29
|
+
},
|
|
30
|
+
"publishConfig": {
|
|
31
|
+
"access": "public",
|
|
32
|
+
"registry": "https://registry.npmjs.org/"
|
|
33
|
+
}
|
|
34
|
+
}
|
package/param.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
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
|
+
}
|