@notabene/javascript-sdk 2.10.0 → 2.11.0-next.2
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/notabene.cjs +1 -1
- package/dist/cjs/notabene.d.ts +77 -2
- package/dist/cjs/package.json +1 -1
- package/dist/esm/notabene.d.ts +77 -2
- package/dist/esm/notabene.js +19 -19
- package/dist/esm/package.json +1 -1
- package/dist/notabene.d.ts +77 -2
- package/dist/notabene.js +19 -19
- package/docs/README.md +227 -51
- package/docs/_media/TransactionOptions.md +19 -9
- package/docs/_media/getRefreshResult.md +35 -0
- package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
- package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
- package/docs/ivms/types/type-aliases/Address.md +1 -1
- package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
- package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
- package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
- package/docs/ivms/types/type-aliases/ISODate.md +1 -1
- package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
- package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
- package/docs/ivms/types/type-aliases/Originator.md +1 -1
- package/docs/ivms/types/type-aliases/Person.md +1 -1
- package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
- package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
- package/docs/notabene/README.md +7 -1
- package/docs/notabene/classes/ConnectionManager.md +19 -5
- package/docs/notabene/classes/EmbeddedComponent.md +17 -17
- package/docs/notabene/classes/default.md +7 -7
- package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
- package/docs/notabene/functions/getRefreshResult.md +11 -3
- package/docs/notabene/interfaces/ConnectionData.md +8 -8
- package/docs/notabene/interfaces/ConnectionMetadata.md +6 -6
- package/docs/notabene/interfaces/ConnectionResponse.md +12 -12
- package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
- package/docs/notabene/type-aliases/ConnectionResult.md +17 -0
- package/docs/notabene/type-aliases/ConnectionStatus.md +1 -1
- package/docs/notabene/type-aliases/MessageCallback.md +1 -1
- package/docs/notabene/type-aliases/TransactionType.md +1 -1
- package/docs/types/README.md +3 -0
- package/docs/types/enumerations/AgentType.md +2 -2
- package/docs/types/enumerations/CMType.md +27 -7
- package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
- package/docs/types/enumerations/HMType.md +2 -2
- package/docs/types/enumerations/PersonType.md +3 -3
- package/docs/types/enumerations/ProofStatus.md +4 -4
- package/docs/types/enumerations/ProofTypes.md +39 -17
- package/docs/types/enumerations/Status.md +5 -5
- package/docs/types/enumerations/VASPSearchControl.md +2 -2
- package/docs/types/enumerations/ValidationSections.md +4 -4
- package/docs/types/interfaces/Account.md +59 -0
- package/docs/types/interfaces/Agent.md +6 -6
- package/docs/types/interfaces/CallbackOptions.md +2 -2
- package/docs/types/interfaces/ComponentRequest.md +2 -2
- package/docs/types/interfaces/ComponentResponse.md +4 -4
- package/docs/types/interfaces/ConnectionRecord.md +7 -7
- package/docs/types/interfaces/ConnectionRequest.md +3 -3
- package/docs/types/interfaces/Counterparty.md +10 -10
- package/docs/types/interfaces/DeclarationProof.md +6 -6
- package/docs/types/interfaces/Deposit.md +25 -11
- package/docs/types/interfaces/DepositRequest.md +9 -9
- package/docs/types/interfaces/DepositRequestOptions.md +1 -1
- package/docs/types/interfaces/DepositTransaction.md +23 -9
- package/docs/types/interfaces/LegalPerson.md +13 -13
- package/docs/types/interfaces/MicroTransferProof.md +9 -9
- package/docs/types/interfaces/NaturalPerson.md +13 -13
- package/docs/types/interfaces/OwnershipProof.md +4 -4
- package/docs/types/interfaces/RefreshSource.md +2 -2
- package/docs/types/interfaces/Refreshable.md +1 -1
- package/docs/types/interfaces/ScreenshotProof.md +5 -5
- package/docs/types/interfaces/SignatureProof.md +14 -12
- package/docs/types/interfaces/ThresholdOptions.md +3 -3
- package/docs/types/interfaces/Transaction.md +18 -8
- package/docs/types/interfaces/TransactionOptions.md +19 -9
- package/docs/types/interfaces/TransactionResponse.md +9 -9
- package/docs/types/interfaces/VASP.md +19 -9
- package/docs/types/interfaces/Wallet.md +8 -8
- package/docs/types/interfaces/Withdrawal.md +24 -10
- package/docs/types/type-aliases/BlockchainAddress.md +1 -1
- package/docs/types/type-aliases/CAIP10.md +1 -1
- package/docs/types/type-aliases/CAIP19.md +1 -1
- package/docs/types/type-aliases/CAIP2.md +1 -1
- package/docs/types/type-aliases/CAIP220.md +1 -1
- package/docs/types/type-aliases/Cancel.md +1 -1
- package/docs/types/type-aliases/Completed.md +1 -1
- package/docs/types/type-aliases/ComponentMessage.md +5 -2
- package/docs/types/type-aliases/ConnectionOptions.md +1 -1
- package/docs/types/type-aliases/CounterpartyAssistConfig.md +2 -2
- package/docs/types/type-aliases/CryptoCredential.md +1 -1
- package/docs/types/type-aliases/DID.md +1 -1
- package/docs/types/type-aliases/DTI.md +1 -1
- package/docs/types/type-aliases/Destination.md +1 -1
- package/docs/types/type-aliases/Error.md +1 -1
- package/docs/types/type-aliases/FieldOptions.md +2 -2
- package/docs/types/type-aliases/FieldTypes.md +1 -1
- package/docs/types/type-aliases/HostMessage.md +1 -1
- package/docs/types/type-aliases/ISOCurrency.md +1 -1
- package/docs/types/type-aliases/Info.md +37 -0
- package/docs/types/type-aliases/InvalidValue.md +1 -1
- package/docs/types/type-aliases/LEI.md +1 -1
- package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/LegalPersonFields.md +1 -1
- package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
- package/docs/types/type-aliases/NotabeneAsset.md +1 -1
- package/docs/types/type-aliases/Ready.md +1 -1
- package/docs/types/type-aliases/ResizeRequest.md +1 -1
- package/docs/types/type-aliases/Source.md +1 -1
- package/docs/types/type-aliases/Theme.md +1 -1
- package/docs/types/type-aliases/TransactionAsset.md +1 -1
- package/docs/types/type-aliases/TravelAddress.md +1 -1
- package/docs/types/type-aliases/URI.md +1 -1
- package/docs/types/type-aliases/UUID.md +1 -1
- package/docs/types/type-aliases/UpdateValue.md +1 -1
- package/docs/types/type-aliases/V1Asset.md +1 -1
- package/docs/types/type-aliases/V1Transaction.md +1 -1
- package/docs/types/type-aliases/VASPOptions.md +1 -1
- package/docs/types/type-aliases/ValidationError.md +1 -1
- package/docs/types/type-aliases/Warning.md +37 -0
- package/package.json +1 -1
- package/src/notabene.ts +6 -0
- package/src/types.ts +81 -4
- package/src/utils/connections.ts +1 -0
- package/docs/notabene/interfaces/ConnectionResult.md +0 -61
|
@@ -41,13 +41,23 @@ This interface serves as the base for specific transaction types like:
|
|
|
41
41
|
|
|
42
42
|
## Properties
|
|
43
43
|
|
|
44
|
+
### account?
|
|
45
|
+
|
|
46
|
+
> `optional` **account**: [`Account`](Account.md)
|
|
47
|
+
|
|
48
|
+
#### Defined in
|
|
49
|
+
|
|
50
|
+
[types.ts:573](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L573)
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
44
54
|
### agent
|
|
45
55
|
|
|
46
56
|
> **agent**: [`Agent`](Agent.md)
|
|
47
57
|
|
|
48
58
|
#### Defined in
|
|
49
59
|
|
|
50
|
-
[types.ts:
|
|
60
|
+
[types.ts:564](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L564)
|
|
51
61
|
|
|
52
62
|
***
|
|
53
63
|
|
|
@@ -57,7 +67,7 @@ This interface serves as the base for specific transaction types like:
|
|
|
57
67
|
|
|
58
68
|
#### Defined in
|
|
59
69
|
|
|
60
|
-
[types.ts:
|
|
70
|
+
[types.ts:567](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L567)
|
|
61
71
|
|
|
62
72
|
***
|
|
63
73
|
|
|
@@ -67,7 +77,7 @@ This interface serves as the base for specific transaction types like:
|
|
|
67
77
|
|
|
68
78
|
#### Defined in
|
|
69
79
|
|
|
70
|
-
[types.ts:
|
|
80
|
+
[types.ts:566](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L566)
|
|
71
81
|
|
|
72
82
|
***
|
|
73
83
|
|
|
@@ -85,7 +95,7 @@ This interface serves as the base for specific transaction types like:
|
|
|
85
95
|
|
|
86
96
|
#### Defined in
|
|
87
97
|
|
|
88
|
-
[types.ts:
|
|
98
|
+
[types.ts:569](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L569)
|
|
89
99
|
|
|
90
100
|
***
|
|
91
101
|
|
|
@@ -95,7 +105,7 @@ This interface serves as the base for specific transaction types like:
|
|
|
95
105
|
|
|
96
106
|
#### Defined in
|
|
97
107
|
|
|
98
|
-
[types.ts:
|
|
108
|
+
[types.ts:565](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L565)
|
|
99
109
|
|
|
100
110
|
***
|
|
101
111
|
|
|
@@ -109,7 +119,7 @@ This interface serves as the base for specific transaction types like:
|
|
|
109
119
|
|
|
110
120
|
#### Defined in
|
|
111
121
|
|
|
112
|
-
[types.ts:
|
|
122
|
+
[types.ts:537](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L537)
|
|
113
123
|
|
|
114
124
|
***
|
|
115
125
|
|
|
@@ -119,7 +129,7 @@ This interface serves as the base for specific transaction types like:
|
|
|
119
129
|
|
|
120
130
|
#### Defined in
|
|
121
131
|
|
|
122
|
-
[types.ts:
|
|
132
|
+
[types.ts:568](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L568)
|
|
123
133
|
|
|
124
134
|
***
|
|
125
135
|
|
|
@@ -133,4 +143,4 @@ This interface serves as the base for specific transaction types like:
|
|
|
133
143
|
|
|
134
144
|
#### Defined in
|
|
135
145
|
|
|
136
|
-
[types.ts:
|
|
146
|
+
[types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L536)
|
|
@@ -16,7 +16,7 @@ Configuration options for Transaction components
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[types.ts:
|
|
19
|
+
[types.ts:854](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L854)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -26,17 +26,17 @@ Configuration options for Transaction components
|
|
|
26
26
|
|
|
27
27
|
#### Defined in
|
|
28
28
|
|
|
29
|
-
[types.ts:
|
|
29
|
+
[types.ts:855](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L855)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
33
|
-
###
|
|
33
|
+
### counterpartyAssist?
|
|
34
34
|
|
|
35
|
-
> `optional` **
|
|
35
|
+
> `optional` **counterpartyAssist**: [`CounterpartyAssistConfig`](../type-aliases/CounterpartyAssistConfig.md)
|
|
36
36
|
|
|
37
37
|
#### Defined in
|
|
38
38
|
|
|
39
|
-
[types.ts:
|
|
39
|
+
[types.ts:859](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L859)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ Configuration options for Transaction components
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[types.ts:
|
|
49
|
+
[types.ts:856](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L856)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -56,7 +56,17 @@ Configuration options for Transaction components
|
|
|
56
56
|
|
|
57
57
|
#### Defined in
|
|
58
58
|
|
|
59
|
-
[types.ts:
|
|
59
|
+
[types.ts:858](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L858)
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### jurisdiction?
|
|
64
|
+
|
|
65
|
+
> `optional` **jurisdiction**: `string`
|
|
66
|
+
|
|
67
|
+
#### Defined in
|
|
68
|
+
|
|
69
|
+
[types.ts:853](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L853)
|
|
60
70
|
|
|
61
71
|
***
|
|
62
72
|
|
|
@@ -94,7 +104,7 @@ Configuration options for Transaction components
|
|
|
94
104
|
|
|
95
105
|
#### Defined in
|
|
96
106
|
|
|
97
|
-
[types.ts:
|
|
107
|
+
[types.ts:843](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L843)
|
|
98
108
|
|
|
99
109
|
***
|
|
100
110
|
|
|
@@ -104,4 +114,4 @@ Configuration options for Transaction components
|
|
|
104
114
|
|
|
105
115
|
#### Defined in
|
|
106
116
|
|
|
107
|
-
[types.ts:
|
|
117
|
+
[types.ts:857](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L857)
|
|
@@ -46,7 +46,7 @@ Type of the transaction value being returned
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[types.ts:
|
|
49
|
+
[types.ts:713](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L713)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ Type of the transaction value being returned
|
|
|
56
56
|
|
|
57
57
|
#### Defined in
|
|
58
58
|
|
|
59
|
-
[types.ts:
|
|
59
|
+
[types.ts:737](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L737)
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ Type of the transaction value being returned
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[types.ts:
|
|
69
|
+
[types.ts:738](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L738)
|
|
70
70
|
|
|
71
71
|
***
|
|
72
72
|
|
|
@@ -80,7 +80,7 @@ Type of the transaction value being returned
|
|
|
80
80
|
|
|
81
81
|
#### Defined in
|
|
82
82
|
|
|
83
|
-
[types.ts:
|
|
83
|
+
[types.ts:710](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L710)
|
|
84
84
|
|
|
85
85
|
***
|
|
86
86
|
|
|
@@ -94,7 +94,7 @@ Type of the transaction value being returned
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[types.ts:
|
|
97
|
+
[types.ts:712](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L712)
|
|
98
98
|
|
|
99
99
|
***
|
|
100
100
|
|
|
@@ -104,7 +104,7 @@ Type of the transaction value being returned
|
|
|
104
104
|
|
|
105
105
|
#### Defined in
|
|
106
106
|
|
|
107
|
-
[types.ts:
|
|
107
|
+
[types.ts:739](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L739)
|
|
108
108
|
|
|
109
109
|
***
|
|
110
110
|
|
|
@@ -114,7 +114,7 @@ Type of the transaction value being returned
|
|
|
114
114
|
|
|
115
115
|
#### Defined in
|
|
116
116
|
|
|
117
|
-
[types.ts:
|
|
117
|
+
[types.ts:740](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L740)
|
|
118
118
|
|
|
119
119
|
***
|
|
120
120
|
|
|
@@ -128,7 +128,7 @@ Type of the transaction value being returned
|
|
|
128
128
|
|
|
129
129
|
#### Defined in
|
|
130
130
|
|
|
131
|
-
[types.ts:
|
|
131
|
+
[types.ts:711](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L711)
|
|
132
132
|
|
|
133
133
|
***
|
|
134
134
|
|
|
@@ -138,4 +138,4 @@ Type of the transaction value being returned
|
|
|
138
138
|
|
|
139
139
|
#### Defined in
|
|
140
140
|
|
|
141
|
-
[types.ts:
|
|
141
|
+
[types.ts:736](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L736)
|
|
@@ -20,7 +20,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
20
20
|
|
|
21
21
|
#### Defined in
|
|
22
22
|
|
|
23
|
-
[types.ts:303](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
23
|
+
[types.ts:303](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L303)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -34,7 +34,17 @@ A VASP agent acting on behalf of the counterparty
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
37
|
+
[types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L260)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### jurisdictions?
|
|
42
|
+
|
|
43
|
+
> `optional` **jurisdictions**: `string`
|
|
44
|
+
|
|
45
|
+
#### Defined in
|
|
46
|
+
|
|
47
|
+
[types.ts:304](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L304)
|
|
38
48
|
|
|
39
49
|
***
|
|
40
50
|
|
|
@@ -44,7 +54,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
44
54
|
|
|
45
55
|
#### Defined in
|
|
46
56
|
|
|
47
|
-
[types.ts:300](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
57
|
+
[types.ts:300](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L300)
|
|
48
58
|
|
|
49
59
|
***
|
|
50
60
|
|
|
@@ -58,7 +68,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
58
68
|
|
|
59
69
|
#### Defined in
|
|
60
70
|
|
|
61
|
-
[types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
71
|
+
[types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L301)
|
|
62
72
|
|
|
63
73
|
***
|
|
64
74
|
|
|
@@ -72,7 +82,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
72
82
|
|
|
73
83
|
#### Defined in
|
|
74
84
|
|
|
75
|
-
[types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
85
|
+
[types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L264)
|
|
76
86
|
|
|
77
87
|
***
|
|
78
88
|
|
|
@@ -86,7 +96,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
86
96
|
|
|
87
97
|
#### Defined in
|
|
88
98
|
|
|
89
|
-
[types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
99
|
+
[types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L261)
|
|
90
100
|
|
|
91
101
|
***
|
|
92
102
|
|
|
@@ -100,7 +110,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
100
110
|
|
|
101
111
|
#### Defined in
|
|
102
112
|
|
|
103
|
-
[types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
113
|
+
[types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L263)
|
|
104
114
|
|
|
105
115
|
***
|
|
106
116
|
|
|
@@ -114,7 +124,7 @@ A VASP agent acting on behalf of the counterparty
|
|
|
114
124
|
|
|
115
125
|
#### Defined in
|
|
116
126
|
|
|
117
|
-
[types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
127
|
+
[types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L265)
|
|
118
128
|
|
|
119
129
|
***
|
|
120
130
|
|
|
@@ -124,4 +134,4 @@ A VASP agent acting on behalf of the counterparty
|
|
|
124
134
|
|
|
125
135
|
#### Defined in
|
|
126
136
|
|
|
127
|
-
[types.ts:302](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
137
|
+
[types.ts:302](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L302)
|
|
@@ -24,7 +24,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
27
|
+
[types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L260)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
@@ -38,7 +38,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
41
|
+
[types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L262)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -52,7 +52,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
52
52
|
|
|
53
53
|
#### Defined in
|
|
54
54
|
|
|
55
|
-
[types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
55
|
+
[types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L264)
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
@@ -62,7 +62,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
62
62
|
|
|
63
63
|
#### Defined in
|
|
64
64
|
|
|
65
|
-
[types.ts:
|
|
65
|
+
[types.ts:312](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L312)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -76,7 +76,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
76
76
|
|
|
77
77
|
#### Defined in
|
|
78
78
|
|
|
79
|
-
[types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
79
|
+
[types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L261)
|
|
80
80
|
|
|
81
81
|
***
|
|
82
82
|
|
|
@@ -90,7 +90,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
90
90
|
|
|
91
91
|
#### Defined in
|
|
92
92
|
|
|
93
|
-
[types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
93
|
+
[types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L263)
|
|
94
94
|
|
|
95
95
|
***
|
|
96
96
|
|
|
@@ -104,7 +104,7 @@ A wallet agent acting on behalf of the counterparty
|
|
|
104
104
|
|
|
105
105
|
#### Defined in
|
|
106
106
|
|
|
107
|
-
[types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
107
|
+
[types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L265)
|
|
108
108
|
|
|
109
109
|
***
|
|
110
110
|
|
|
@@ -114,4 +114,4 @@ A wallet agent acting on behalf of the counterparty
|
|
|
114
114
|
|
|
115
115
|
#### Defined in
|
|
116
116
|
|
|
117
|
-
[types.ts:
|
|
117
|
+
[types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L313)
|
|
@@ -14,6 +14,20 @@ An object representing a withdrawal transaction
|
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
17
|
+
### account?
|
|
18
|
+
|
|
19
|
+
> `optional` **account**: [`Account`](Account.md)
|
|
20
|
+
|
|
21
|
+
#### Inherited from
|
|
22
|
+
|
|
23
|
+
[`Transaction`](Transaction.md).[`account`](Transaction.md#account)
|
|
24
|
+
|
|
25
|
+
#### Defined in
|
|
26
|
+
|
|
27
|
+
[types.ts:573](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L573)
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
17
31
|
### agent
|
|
18
32
|
|
|
19
33
|
> **agent**: [`Agent`](Agent.md)
|
|
@@ -24,7 +38,7 @@ An object representing a withdrawal transaction
|
|
|
24
38
|
|
|
25
39
|
#### Defined in
|
|
26
40
|
|
|
27
|
-
[types.ts:
|
|
41
|
+
[types.ts:564](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L564)
|
|
28
42
|
|
|
29
43
|
***
|
|
30
44
|
|
|
@@ -38,7 +52,7 @@ An object representing a withdrawal transaction
|
|
|
38
52
|
|
|
39
53
|
#### Defined in
|
|
40
54
|
|
|
41
|
-
[types.ts:
|
|
55
|
+
[types.ts:567](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L567)
|
|
42
56
|
|
|
43
57
|
***
|
|
44
58
|
|
|
@@ -52,7 +66,7 @@ An object representing a withdrawal transaction
|
|
|
52
66
|
|
|
53
67
|
#### Defined in
|
|
54
68
|
|
|
55
|
-
[types.ts:
|
|
69
|
+
[types.ts:566](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L566)
|
|
56
70
|
|
|
57
71
|
***
|
|
58
72
|
|
|
@@ -74,7 +88,7 @@ An object representing a withdrawal transaction
|
|
|
74
88
|
|
|
75
89
|
#### Defined in
|
|
76
90
|
|
|
77
|
-
[types.ts:
|
|
91
|
+
[types.ts:569](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L569)
|
|
78
92
|
|
|
79
93
|
***
|
|
80
94
|
|
|
@@ -88,7 +102,7 @@ An object representing a withdrawal transaction
|
|
|
88
102
|
|
|
89
103
|
#### Defined in
|
|
90
104
|
|
|
91
|
-
[types.ts:
|
|
105
|
+
[types.ts:565](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L565)
|
|
92
106
|
|
|
93
107
|
***
|
|
94
108
|
|
|
@@ -102,7 +116,7 @@ An object representing a withdrawal transaction
|
|
|
102
116
|
|
|
103
117
|
#### Defined in
|
|
104
118
|
|
|
105
|
-
[types.ts:
|
|
119
|
+
[types.ts:537](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L537)
|
|
106
120
|
|
|
107
121
|
***
|
|
108
122
|
|
|
@@ -116,7 +130,7 @@ An object representing a withdrawal transaction
|
|
|
116
130
|
|
|
117
131
|
#### Defined in
|
|
118
132
|
|
|
119
|
-
[types.ts:
|
|
133
|
+
[types.ts:502](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L502)
|
|
120
134
|
|
|
121
135
|
***
|
|
122
136
|
|
|
@@ -130,7 +144,7 @@ An object representing a withdrawal transaction
|
|
|
130
144
|
|
|
131
145
|
#### Defined in
|
|
132
146
|
|
|
133
|
-
[types.ts:
|
|
147
|
+
[types.ts:568](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L568)
|
|
134
148
|
|
|
135
149
|
***
|
|
136
150
|
|
|
@@ -144,7 +158,7 @@ An object representing a withdrawal transaction
|
|
|
144
158
|
|
|
145
159
|
#### Defined in
|
|
146
160
|
|
|
147
|
-
[types.ts:
|
|
161
|
+
[types.ts:582](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L582)
|
|
148
162
|
|
|
149
163
|
***
|
|
150
164
|
|
|
@@ -158,4 +172,4 @@ An object representing a withdrawal transaction
|
|
|
158
172
|
|
|
159
173
|
#### Defined in
|
|
160
174
|
|
|
161
|
-
[types.ts:
|
|
175
|
+
[types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L536)
|
|
@@ -33,4 +33,4 @@ The address format and validation rules depend on the underlying blockchain.
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[types.ts:167](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
36
|
+
[types.ts:167](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L167)
|
|
@@ -36,4 +36,4 @@ Format: `{caip2}:{address}`
|
|
|
36
36
|
|
|
37
37
|
## Defined in
|
|
38
38
|
|
|
39
|
-
[types.ts:74](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
39
|
+
[types.ts:74](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L74)
|
|
@@ -37,4 +37,4 @@ Format: `{caip2}/{asset_namespace}:{asset_reference}`
|
|
|
37
37
|
|
|
38
38
|
## Defined in
|
|
39
39
|
|
|
40
|
-
[types.ts:92](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
40
|
+
[types.ts:92](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L92)
|
|
@@ -36,4 +36,4 @@ Format: `namespace:reference`
|
|
|
36
36
|
|
|
37
37
|
## Defined in
|
|
38
38
|
|
|
39
|
-
[types.ts:57](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
39
|
+
[types.ts:57](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L57)
|
|
@@ -12,4 +12,4 @@ Chain Agnostic Payload Identifier
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:98](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:98](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L98)
|
|
@@ -20,4 +20,4 @@ Represents a cancel component message
|
|
|
20
20
|
|
|
21
21
|
## Defined in
|
|
22
22
|
|
|
23
|
-
[types.ts:
|
|
23
|
+
[types.ts:944](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L944)
|
|
@@ -32,4 +32,4 @@ The Response object which wraps T
|
|
|
32
32
|
|
|
33
33
|
## Defined in
|
|
34
34
|
|
|
35
|
-
[types.ts:
|
|
35
|
+
[types.ts:893](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L893)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Type Alias: ComponentMessage\<T\>
|
|
8
8
|
|
|
9
|
-
> **ComponentMessage**\<`T`\>: [`Completed`](Completed.md)\<`T`\> \| [`Cancel`](Cancel.md) \| [`Error`](Error.md) \| [`Ready`](Ready.md) \| [`ResizeRequest`](ResizeRequest.md) \| [`InvalidValue`](InvalidValue.md)\<`T`\>
|
|
9
|
+
> **ComponentMessage**\<`T`\>: [`Completed`](Completed.md)\<`T`\> \| [`Cancel`](Cancel.md) \| [`Error`](Error.md) \| [`Ready`](Ready.md) \| [`ResizeRequest`](ResizeRequest.md) \| [`InvalidValue`](InvalidValue.md)\<`T`\> \| [`Warning`](Warning.md) \| [`Info`](Info.md)
|
|
10
10
|
|
|
11
11
|
Union type representing all possible messages that can be sent from a component
|
|
12
12
|
|
|
@@ -31,9 +31,12 @@ through these message types:
|
|
|
31
31
|
- [Completed](Completed.md) For successful completion message format
|
|
32
32
|
- [Cancel](Cancel.md) For cancellation message format
|
|
33
33
|
- [Error](Error.md) For error message format
|
|
34
|
+
- [Ready](Ready.md) For ready message format
|
|
34
35
|
- [ResizeRequest](ResizeRequest.md) For resize message format
|
|
35
36
|
- [InvalidValue](InvalidValue.md) For validation failure message format
|
|
37
|
+
- [Warning](Warning.md) For warning message format
|
|
38
|
+
- [Info](Info.md) For info message format
|
|
36
39
|
|
|
37
40
|
## Defined in
|
|
38
41
|
|
|
39
|
-
[types.ts:
|
|
42
|
+
[types.ts:1009](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1009)
|
|
@@ -12,4 +12,4 @@ An object representing options for a Connection Request
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:
|
|
15
|
+
[types.ts:640](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L640)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Type Alias: CounterpartyAssistConfig
|
|
8
8
|
|
|
9
|
-
> **CounterpartyAssistConfig**:
|
|
9
|
+
> **CounterpartyAssistConfig**: `boolean` \| \{ `counterpartyTypes`: [`PersonType`](../enumerations/PersonType.md)[]; \}
|
|
10
10
|
|
|
11
11
|
Counterparty Assist Configuration options for recipient selection
|
|
12
12
|
|
|
@@ -16,4 +16,4 @@ Controls for each person type, whether to show the share feature or not.
|
|
|
16
16
|
|
|
17
17
|
## Defined in
|
|
18
18
|
|
|
19
|
-
[types.ts:
|
|
19
|
+
[types.ts:804](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L804)
|
|
@@ -12,4 +12,4 @@ A crypto credential
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:192](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:192](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L192)
|
|
@@ -12,4 +12,4 @@ A Decentralized Identifier
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:220](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:220](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L220)
|
|
@@ -35,4 +35,4 @@ Format: `DTI[NNNNN]` where N is a digit
|
|
|
35
35
|
|
|
36
36
|
## Defined in
|
|
37
37
|
|
|
38
|
-
[types.ts:118](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
38
|
+
[types.ts:118](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L118)
|
|
@@ -12,4 +12,4 @@ The destination of a transaction either a blockchain address, a CAIP-19 address,
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:198](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:198](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L198)
|
|
@@ -42,4 +42,4 @@ Identifier code of the error message
|
|
|
42
42
|
|
|
43
43
|
## Defined in
|
|
44
44
|
|
|
45
|
-
[types.ts:
|
|
45
|
+
[types.ts:933](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L933)
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
# Type Alias: FieldOptions
|
|
8
8
|
|
|
9
|
-
> **FieldOptions**: `boolean` \| `string`[] \| \{ `optional`: `boolean`;
|
|
9
|
+
> **FieldOptions**: `boolean` \| `string`[] \| \{ `optional`: `boolean`; \}
|
|
10
10
|
|
|
11
11
|
Field properties
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:
|
|
15
|
+
[types.ts:756](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L756)
|