@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.
Files changed (139) hide show
  1. package/dist/cjs/notabene.cjs +1 -1
  2. package/dist/cjs/notabene.d.ts +77 -2
  3. package/dist/cjs/package.json +1 -1
  4. package/dist/esm/notabene.d.ts +77 -2
  5. package/dist/esm/notabene.js +19 -19
  6. package/dist/esm/package.json +1 -1
  7. package/dist/notabene.d.ts +77 -2
  8. package/dist/notabene.js +19 -19
  9. package/docs/README.md +227 -51
  10. package/docs/_media/TransactionOptions.md +19 -9
  11. package/docs/_media/getRefreshResult.md +35 -0
  12. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  13. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  14. package/docs/ivms/types/type-aliases/Address.md +1 -1
  15. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  16. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  17. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  18. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  19. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  20. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  21. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  22. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  23. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  24. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  25. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  26. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  27. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  28. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  29. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  30. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  31. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  32. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  33. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  34. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  35. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  36. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  37. package/docs/ivms/types/type-aliases/Person.md +1 -1
  38. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  39. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  40. package/docs/notabene/README.md +7 -1
  41. package/docs/notabene/classes/ConnectionManager.md +19 -5
  42. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  43. package/docs/notabene/classes/default.md +7 -7
  44. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  45. package/docs/notabene/functions/getRefreshResult.md +11 -3
  46. package/docs/notabene/interfaces/ConnectionData.md +8 -8
  47. package/docs/notabene/interfaces/ConnectionMetadata.md +6 -6
  48. package/docs/notabene/interfaces/ConnectionResponse.md +12 -12
  49. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  50. package/docs/notabene/type-aliases/ConnectionResult.md +17 -0
  51. package/docs/notabene/type-aliases/ConnectionStatus.md +1 -1
  52. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  53. package/docs/notabene/type-aliases/TransactionType.md +1 -1
  54. package/docs/types/README.md +3 -0
  55. package/docs/types/enumerations/AgentType.md +2 -2
  56. package/docs/types/enumerations/CMType.md +27 -7
  57. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  58. package/docs/types/enumerations/HMType.md +2 -2
  59. package/docs/types/enumerations/PersonType.md +3 -3
  60. package/docs/types/enumerations/ProofStatus.md +4 -4
  61. package/docs/types/enumerations/ProofTypes.md +39 -17
  62. package/docs/types/enumerations/Status.md +5 -5
  63. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  64. package/docs/types/enumerations/ValidationSections.md +4 -4
  65. package/docs/types/interfaces/Account.md +59 -0
  66. package/docs/types/interfaces/Agent.md +6 -6
  67. package/docs/types/interfaces/CallbackOptions.md +2 -2
  68. package/docs/types/interfaces/ComponentRequest.md +2 -2
  69. package/docs/types/interfaces/ComponentResponse.md +4 -4
  70. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  71. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  72. package/docs/types/interfaces/Counterparty.md +10 -10
  73. package/docs/types/interfaces/DeclarationProof.md +6 -6
  74. package/docs/types/interfaces/Deposit.md +25 -11
  75. package/docs/types/interfaces/DepositRequest.md +9 -9
  76. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  77. package/docs/types/interfaces/DepositTransaction.md +23 -9
  78. package/docs/types/interfaces/LegalPerson.md +13 -13
  79. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  80. package/docs/types/interfaces/NaturalPerson.md +13 -13
  81. package/docs/types/interfaces/OwnershipProof.md +4 -4
  82. package/docs/types/interfaces/RefreshSource.md +2 -2
  83. package/docs/types/interfaces/Refreshable.md +1 -1
  84. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  85. package/docs/types/interfaces/SignatureProof.md +14 -12
  86. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  87. package/docs/types/interfaces/Transaction.md +18 -8
  88. package/docs/types/interfaces/TransactionOptions.md +19 -9
  89. package/docs/types/interfaces/TransactionResponse.md +9 -9
  90. package/docs/types/interfaces/VASP.md +19 -9
  91. package/docs/types/interfaces/Wallet.md +8 -8
  92. package/docs/types/interfaces/Withdrawal.md +24 -10
  93. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  94. package/docs/types/type-aliases/CAIP10.md +1 -1
  95. package/docs/types/type-aliases/CAIP19.md +1 -1
  96. package/docs/types/type-aliases/CAIP2.md +1 -1
  97. package/docs/types/type-aliases/CAIP220.md +1 -1
  98. package/docs/types/type-aliases/Cancel.md +1 -1
  99. package/docs/types/type-aliases/Completed.md +1 -1
  100. package/docs/types/type-aliases/ComponentMessage.md +5 -2
  101. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  102. package/docs/types/type-aliases/CounterpartyAssistConfig.md +2 -2
  103. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  104. package/docs/types/type-aliases/DID.md +1 -1
  105. package/docs/types/type-aliases/DTI.md +1 -1
  106. package/docs/types/type-aliases/Destination.md +1 -1
  107. package/docs/types/type-aliases/Error.md +1 -1
  108. package/docs/types/type-aliases/FieldOptions.md +2 -2
  109. package/docs/types/type-aliases/FieldTypes.md +1 -1
  110. package/docs/types/type-aliases/HostMessage.md +1 -1
  111. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  112. package/docs/types/type-aliases/Info.md +37 -0
  113. package/docs/types/type-aliases/InvalidValue.md +1 -1
  114. package/docs/types/type-aliases/LEI.md +1 -1
  115. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  116. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  117. package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
  118. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  119. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  120. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  121. package/docs/types/type-aliases/Ready.md +1 -1
  122. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  123. package/docs/types/type-aliases/Source.md +1 -1
  124. package/docs/types/type-aliases/Theme.md +1 -1
  125. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  126. package/docs/types/type-aliases/TravelAddress.md +1 -1
  127. package/docs/types/type-aliases/URI.md +1 -1
  128. package/docs/types/type-aliases/UUID.md +1 -1
  129. package/docs/types/type-aliases/UpdateValue.md +1 -1
  130. package/docs/types/type-aliases/V1Asset.md +1 -1
  131. package/docs/types/type-aliases/V1Transaction.md +1 -1
  132. package/docs/types/type-aliases/VASPOptions.md +1 -1
  133. package/docs/types/type-aliases/ValidationError.md +1 -1
  134. package/docs/types/type-aliases/Warning.md +37 -0
  135. package/package.json +1 -1
  136. package/src/notabene.ts +6 -0
  137. package/src/types.ts +81 -4
  138. package/src/utils/connections.ts +1 -0
  139. package/docs/notabene/interfaces/ConnectionResult.md +0 -61
package/docs/types/enumerations/ValidationSections.md CHANGED
@@ -20,7 +20,7 @@ Sections in a WithdrawalAssist screen
20
20
 
21
21
  #### Defined in
22
22
 
23
- [types.ts:810](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L810)
23
+ [types.ts:819](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L819)
24
24
 
25
25
  ***
26
26
 
@@ -32,7 +32,7 @@ Sections in a WithdrawalAssist screen
32
32
 
33
33
  #### Defined in
34
34
 
35
- [types.ts:807](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L807)
35
+ [types.ts:816](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L816)
36
36
 
37
37
  ***
38
38
 
@@ -44,7 +44,7 @@ Sections in a WithdrawalAssist screen
44
44
 
45
45
  #### Defined in
46
46
 
47
- [types.ts:809](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L809)
47
+ [types.ts:818](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L818)
48
48
 
49
49
  ***
50
50
 
@@ -56,4 +56,4 @@ Sections in a WithdrawalAssist screen
56
56
 
57
57
  #### Defined in
58
58
 
59
- [types.ts:808](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L808)
59
+ [types.ts:817](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L817)
package/docs/types/interfaces/Account.md ADDED
@@ -0,0 +1,59 @@
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
+
3
+ ***
4
+
5
+ [@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Account
6
+
7
+ # Interface: Account
8
+
9
+ A blockchain account
10
+
11
+ ## Properties
12
+
13
+ ### blockchainAddress?
14
+
15
+ > `optional` **blockchainAddress**: `string`
16
+
17
+ #### Defined in
18
+
19
+ [types.ts:322](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L322)
20
+
21
+ ***
22
+
23
+ ### caip10?
24
+
25
+ > `optional` **caip10**: \`$\{string\}:$\{string\}:$\{string\}\`
26
+
27
+ #### Defined in
28
+
29
+ [types.ts:324](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L324)
30
+
31
+ ***
32
+
33
+ ### chain?
34
+
35
+ > `optional` **chain**: \`$\{string\}:$\{string\}\`
36
+
37
+ #### Defined in
38
+
39
+ [types.ts:323](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L323)
40
+
41
+ ***
42
+
43
+ ### did?
44
+
45
+ > `optional` **did**: \`did:$\{string\}:$\{string\}\`
46
+
47
+ #### Defined in
48
+
49
+ [types.ts:321](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L321)
50
+
51
+ ***
52
+
53
+ ### identifier?
54
+
55
+ > `optional` **identifier**: `string`
56
+
57
+ #### Defined in
58
+
59
+ [types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L325)
package/docs/types/interfaces/Agent.md CHANGED
@@ -21,7 +21,7 @@ Who is the agent acting on behalf of the counterparty
21
21
 
22
22
  #### Defined in
23
23
 
24
- [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L260)
24
+ [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L260)
25
25
 
26
26
  ***
27
27
 
@@ -31,7 +31,7 @@ Who is the agent acting on behalf of the counterparty
31
31
 
32
32
  #### Defined in
33
33
 
34
- [types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L262)
34
+ [types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L262)
35
35
 
36
36
  ***
37
37
 
@@ -41,7 +41,7 @@ Who is the agent acting on behalf of the counterparty
41
41
 
42
42
  #### Defined in
43
43
 
44
- [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L264)
44
+ [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L264)
45
45
 
46
46
  ***
47
47
 
@@ -51,7 +51,7 @@ Who is the agent acting on behalf of the counterparty
51
51
 
52
52
  #### Defined in
53
53
 
54
- [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L261)
54
+ [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L261)
55
55
 
56
56
  ***
57
57
 
@@ -61,7 +61,7 @@ Who is the agent acting on behalf of the counterparty
61
61
 
62
62
  #### Defined in
63
63
 
64
- [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L263)
64
+ [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L263)
65
65
 
66
66
  ***
67
67
 
@@ -71,4 +71,4 @@ Who is the agent acting on behalf of the counterparty
71
71
 
72
72
  #### Defined in
73
73
 
74
- [types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L265)
74
+ [types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L265)
package/docs/types/interfaces/CallbackOptions.md CHANGED
@@ -16,7 +16,7 @@ Options for callback and redirect URIs
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:1040](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1040)
19
+ [types.ts:1081](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1081)
20
20
 
21
21
  ***
22
22
 
@@ -26,4 +26,4 @@ Options for callback and redirect URIs
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:1041](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1041)
29
+ [types.ts:1082](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1082)
package/docs/types/interfaces/ComponentRequest.md CHANGED
@@ -37,7 +37,7 @@ This interface is extended by specific request types like:
37
37
 
38
38
  #### Defined in
39
39
 
40
- [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L524)
40
+ [types.ts:537](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L537)
41
41
 
42
42
  ***
43
43
 
@@ -47,4 +47,4 @@ This interface is extended by specific request types like:
47
47
 
48
48
  #### Defined in
49
49
 
50
- [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L523)
50
+ [types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L536)
package/docs/types/interfaces/ComponentResponse.md CHANGED
@@ -38,7 +38,7 @@ This interface is extended by specific response types like:
38
38
 
39
39
  #### Defined in
40
40
 
41
- [types.ts:699](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L699)
41
+ [types.ts:713](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L713)
42
42
 
43
43
  ***
44
44
 
@@ -48,7 +48,7 @@ This interface is extended by specific response types like:
48
48
 
49
49
  #### Defined in
50
50
 
51
- [types.ts:696](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L696)
51
+ [types.ts:710](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L710)
52
52
 
53
53
  ***
54
54
 
@@ -58,7 +58,7 @@ This interface is extended by specific response types like:
58
58
 
59
59
  #### Defined in
60
60
 
61
- [types.ts:698](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L698)
61
+ [types.ts:712](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L712)
62
62
 
63
63
  ***
64
64
 
@@ -68,4 +68,4 @@ This interface is extended by specific response types like:
68
68
 
69
69
  #### Defined in
70
70
 
71
- [types.ts:697](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L697)
71
+ [types.ts:711](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L711)
package/docs/types/interfaces/ConnectionRecord.md CHANGED
@@ -36,7 +36,7 @@ associated with the claimed address.
36
36
 
37
37
  #### Defined in
38
38
 
39
- [types.ts:1134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1134)
39
+ [types.ts:1179](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1179)
40
40
 
41
41
  ***
42
42
 
@@ -46,7 +46,7 @@ associated with the claimed address.
46
46
 
47
47
  #### Defined in
48
48
 
49
- [types.ts:1205](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1205)
49
+ [types.ts:1252](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1252)
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ associated with the claimed address.
60
60
 
61
61
  #### Defined in
62
62
 
63
- [types.ts:1133](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1133)
63
+ [types.ts:1178](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1178)
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ associated with the claimed address.
70
70
 
71
71
  #### Defined in
72
72
 
73
- [types.ts:1204](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1204)
73
+ [types.ts:1251](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1251)
74
74
 
75
75
  ***
76
76
 
@@ -84,7 +84,7 @@ associated with the claimed address.
84
84
 
85
85
  #### Defined in
86
86
 
87
- [types.ts:1132](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1132)
87
+ [types.ts:1177](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1177)
88
88
 
89
89
  ***
90
90
 
@@ -98,7 +98,7 @@ associated with the claimed address.
98
98
 
99
99
  #### Defined in
100
100
 
101
- [types.ts:1203](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1203)
101
+ [types.ts:1250](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1250)
102
102
 
103
103
  ***
104
104
 
@@ -108,4 +108,4 @@ associated with the claimed address.
108
108
 
109
109
  #### Defined in
110
110
 
111
- [types.ts:1206](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1206)
111
+ [types.ts:1253](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1253)
package/docs/types/interfaces/ConnectionRequest.md CHANGED
@@ -20,7 +20,7 @@ An object representing a connection request
20
20
 
21
21
  #### Defined in
22
22
 
23
- [types.ts:618](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L618)
23
+ [types.ts:632](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L632)
24
24
 
25
25
  ***
26
26
 
@@ -34,7 +34,7 @@ An object representing a connection request
34
34
 
35
35
  #### Defined in
36
36
 
37
- [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L524)
37
+ [types.ts:537](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L537)
38
38
 
39
39
  ***
40
40
 
@@ -48,4 +48,4 @@ An object representing a connection request
48
48
 
49
49
  #### Defined in
50
50
 
51
- [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L523)
51
+ [types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L536)
package/docs/types/interfaces/Counterparty.md CHANGED
@@ -42,7 +42,7 @@ This interface serves as the base for more specific counterparty types:
42
42
 
43
43
  #### Defined in
44
44
 
45
- [types.ts:343](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L343)
45
+ [types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L356)
46
46
 
47
47
  ***
48
48
 
@@ -52,7 +52,7 @@ This interface serves as the base for more specific counterparty types:
52
52
 
53
53
  #### Defined in
54
54
 
55
- [types.ts:344](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L344)
55
+ [types.ts:357](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L357)
56
56
 
57
57
  ***
58
58
 
@@ -62,7 +62,7 @@ This interface serves as the base for more specific counterparty types:
62
62
 
63
63
  #### Defined in
64
64
 
65
- [types.ts:351](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L351)
65
+ [types.ts:364](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L364)
66
66
 
67
67
  ***
68
68
 
@@ -72,7 +72,7 @@ This interface serves as the base for more specific counterparty types:
72
72
 
73
73
  #### Defined in
74
74
 
75
- [types.ts:347](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L347)
75
+ [types.ts:360](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L360)
76
76
 
77
77
  ***
78
78
 
@@ -82,7 +82,7 @@ This interface serves as the base for more specific counterparty types:
82
82
 
83
83
  #### Defined in
84
84
 
85
- [types.ts:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L342)
85
+ [types.ts:355](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L355)
86
86
 
87
87
  ***
88
88
 
@@ -92,7 +92,7 @@ This interface serves as the base for more specific counterparty types:
92
92
 
93
93
  #### Defined in
94
94
 
95
- [types.ts:348](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L348)
95
+ [types.ts:361](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L361)
96
96
 
97
97
  ***
98
98
 
@@ -102,7 +102,7 @@ This interface serves as the base for more specific counterparty types:
102
102
 
103
103
  #### Defined in
104
104
 
105
- [types.ts:350](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L350)
105
+ [types.ts:363](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L363)
106
106
 
107
107
  ***
108
108
 
@@ -112,7 +112,7 @@ This interface serves as the base for more specific counterparty types:
112
112
 
113
113
  #### Defined in
114
114
 
115
- [types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L345)
115
+ [types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L358)
116
116
 
117
117
  ***
118
118
 
@@ -122,7 +122,7 @@ This interface serves as the base for more specific counterparty types:
122
122
 
123
123
  #### Defined in
124
124
 
125
- [types.ts:346](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L346)
125
+ [types.ts:359](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L359)
126
126
 
127
127
  ***
128
128
 
@@ -132,4 +132,4 @@ This interface serves as the base for more specific counterparty types:
132
132
 
133
133
  #### Defined in
134
134
 
135
- [types.ts:349](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L349)
135
+ [types.ts:362](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L362)
package/docs/types/interfaces/DeclarationProof.md CHANGED
@@ -24,7 +24,7 @@ Ownership Proof using Self Declaration
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:1134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1134)
27
+ [types.ts:1179](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1179)
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ Ownership Proof using Self Declaration
34
34
 
35
35
  #### Defined in
36
36
 
37
- [types.ts:1185](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1185)
37
+ [types.ts:1232](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1232)
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ Ownership Proof using Self Declaration
44
44
 
45
45
  #### Defined in
46
46
 
47
- [types.ts:1186](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1186)
47
+ [types.ts:1233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1233)
48
48
 
49
49
  ***
50
50
 
@@ -58,7 +58,7 @@ Ownership Proof using Self Declaration
58
58
 
59
59
  #### Defined in
60
60
 
61
- [types.ts:1133](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1133)
61
+ [types.ts:1178](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1178)
62
62
 
63
63
  ***
64
64
 
@@ -72,7 +72,7 @@ Ownership Proof using Self Declaration
72
72
 
73
73
  #### Defined in
74
74
 
75
- [types.ts:1132](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1132)
75
+ [types.ts:1177](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1177)
76
76
 
77
77
  ***
78
78
 
@@ -86,4 +86,4 @@ Ownership Proof using Self Declaration
86
86
 
87
87
  #### Defined in
88
88
 
89
- [types.ts:1184](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1184)
89
+ [types.ts:1231](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1231)
package/docs/types/interfaces/Deposit.md CHANGED
@@ -14,6 +14,20 @@ An object representing a deposit transaction
14
14
 
15
15
  ## Properties
16
16
 
17
+ ### account?
18
+
19
+ > `optional` **account**: [`Account`](Account.md)
20
+
21
+ #### Inherited from
22
+
23
+ [`DepositTransaction`](DepositTransaction.md).[`account`](DepositTransaction.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 deposit transaction
24
38
 
25
39
  #### Defined in
26
40
 
27
- [types.ts:551](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L551)
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 deposit transaction
38
52
 
39
53
  #### Defined in
40
54
 
41
- [types.ts:554](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L554)
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 deposit transaction
52
66
 
53
67
  #### Defined in
54
68
 
55
- [types.ts:553](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L553)
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 deposit transaction
74
88
 
75
89
  #### Defined in
76
90
 
77
- [types.ts:556](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L556)
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 deposit transaction
88
102
 
89
103
  #### Defined in
90
104
 
91
- [types.ts:552](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L552)
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 deposit transaction
102
116
 
103
117
  #### Defined in
104
118
 
105
- [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L524)
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 deposit transaction
116
130
 
117
131
  #### Defined in
118
132
 
119
- [types.ts:555](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L555)
133
+ [types.ts:568](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L568)
120
134
 
121
135
  ***
122
136
 
@@ -130,7 +144,7 @@ An object representing a deposit transaction
130
144
 
131
145
  #### Defined in
132
146
 
133
- [types.ts:568](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L568)
147
+ [types.ts:582](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L582)
134
148
 
135
149
  ***
136
150
 
@@ -144,7 +158,7 @@ An object representing a deposit transaction
144
158
 
145
159
  #### Defined in
146
160
 
147
- [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L523)
161
+ [types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L536)
148
162
 
149
163
  ***
150
164
 
@@ -158,7 +172,7 @@ An object representing a deposit transaction
158
172
 
159
173
  #### Defined in
160
174
 
161
- [types.ts:481](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L481)
175
+ [types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L494)
162
176
 
163
177
  ***
164
178
 
@@ -172,4 +186,4 @@ An object representing a deposit transaction
172
186
 
173
187
  #### Defined in
174
188
 
175
- [types.ts:576](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L576)
189
+ [types.ts:590](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L590)
package/docs/types/interfaces/DepositRequest.md CHANGED
@@ -14,9 +14,9 @@ An object representing a request for a deposit
14
14
 
15
15
  ## Properties
16
16
 
17
- ### amountDecimal?
17
+ ### amountDecimal
18
18
 
19
- > `optional` **amountDecimal**: `number`
19
+ > **amountDecimal**: `number`
20
20
 
21
21
  #### Inherited from
22
22
 
@@ -24,7 +24,7 @@ An object representing a request for a deposit
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:499](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L499)
27
+ [types.ts:512](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L512)
28
28
 
29
29
  ***
30
30
 
@@ -38,7 +38,7 @@ An object representing a request for a deposit
38
38
 
39
39
  #### Defined in
40
40
 
41
- [types.ts:498](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L498)
41
+ [types.ts:511](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L511)
42
42
 
43
43
  ***
44
44
 
@@ -52,7 +52,7 @@ An object representing a request for a deposit
52
52
 
53
53
  #### Defined in
54
54
 
55
- [types.ts:501](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L501)
55
+ [types.ts:514](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L514)
56
56
 
57
57
  ***
58
58
 
@@ -66,7 +66,7 @@ An object representing a request for a deposit
66
66
 
67
67
  #### Defined in
68
68
 
69
- [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L524)
69
+ [types.ts:537](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L537)
70
70
 
71
71
  ***
72
72
 
@@ -80,7 +80,7 @@ An object representing a request for a deposit
80
80
 
81
81
  #### Defined in
82
82
 
83
- [types.ts:497](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L497)
83
+ [types.ts:510](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L510)
84
84
 
85
85
  ***
86
86
 
@@ -94,7 +94,7 @@ An object representing a request for a deposit
94
94
 
95
95
  #### Defined in
96
96
 
97
- [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L523)
97
+ [types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L536)
98
98
 
99
99
  ***
100
100
 
@@ -108,4 +108,4 @@ An object representing a request for a deposit
108
108
 
109
109
  #### Defined in
110
110
 
111
- [types.ts:500](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L500)
111
+ [types.ts:513](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L513)
package/docs/types/interfaces/DepositRequestOptions.md CHANGED
@@ -16,4 +16,4 @@ An object representing options for a Deposit Request
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:610](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L610)
19
+ [types.ts:624](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L624)