@notabene/javascript-sdk 2.5.2 → 2.5.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.
Files changed (114) hide show
  1. package/README.md +4 -1
  2. package/dist/notabene.d.ts +10 -1
  3. package/docs/README.md +65 -2
  4. package/docs/_media/TransactionOptions.md +6 -6
  5. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  6. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  7. package/docs/ivms/types/type-aliases/Address.md +1 -1
  8. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  9. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  10. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  11. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  12. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  13. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  14. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  15. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  16. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  17. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  18. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  19. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  20. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  21. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  22. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  23. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  24. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  25. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  26. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  27. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  28. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  29. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  30. package/docs/ivms/types/type-aliases/Person.md +1 -1
  31. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  32. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  33. package/docs/notabene/README.md +6 -0
  34. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  35. package/docs/notabene/classes/default.md +44 -6
  36. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  37. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  38. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  39. package/docs/types/README.md +1 -0
  40. package/docs/types/enumerations/AgentType.md +2 -2
  41. package/docs/types/enumerations/CMType.md +7 -7
  42. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  43. package/docs/types/enumerations/HMType.md +2 -2
  44. package/docs/types/enumerations/PersonType.md +3 -3
  45. package/docs/types/enumerations/ProofStatus.md +4 -4
  46. package/docs/types/enumerations/ProofTypes.md +14 -14
  47. package/docs/types/enumerations/Status.md +5 -5
  48. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  49. package/docs/types/enumerations/ValidationSections.md +4 -4
  50. package/docs/types/interfaces/Agent.md +6 -6
  51. package/docs/types/interfaces/CallbackOptions.md +2 -2
  52. package/docs/types/interfaces/ComponentRequest.md +2 -2
  53. package/docs/types/interfaces/ComponentResponse.md +4 -4
  54. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  55. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  56. package/docs/types/interfaces/Counterparty.md +10 -10
  57. package/docs/types/interfaces/DeclarationProof.md +6 -6
  58. package/docs/types/interfaces/Deposit.md +32 -18
  59. package/docs/types/interfaces/DepositRequest.md +7 -7
  60. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  61. package/docs/types/interfaces/DepositTransaction.md +147 -0
  62. package/docs/types/interfaces/LegalPerson.md +13 -13
  63. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  64. package/docs/types/interfaces/NaturalPerson.md +13 -13
  65. package/docs/types/interfaces/OwnershipProof.md +4 -4
  66. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  67. package/docs/types/interfaces/SignatureProof.md +8 -8
  68. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  69. package/docs/types/interfaces/Transaction.md +9 -9
  70. package/docs/types/interfaces/TransactionOptions.md +6 -6
  71. package/docs/types/interfaces/TransactionResponse.md +18 -8
  72. package/docs/types/interfaces/VASP.md +9 -9
  73. package/docs/types/interfaces/Wallet.md +8 -8
  74. package/docs/types/interfaces/Withdrawal.md +9 -9
  75. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  76. package/docs/types/type-aliases/CAIP10.md +1 -1
  77. package/docs/types/type-aliases/CAIP19.md +1 -1
  78. package/docs/types/type-aliases/CAIP2.md +1 -1
  79. package/docs/types/type-aliases/CAIP220.md +1 -1
  80. package/docs/types/type-aliases/Cancel.md +1 -1
  81. package/docs/types/type-aliases/Completed.md +1 -1
  82. package/docs/types/type-aliases/ComponentMessage.md +1 -1
  83. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  84. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  85. package/docs/types/type-aliases/DID.md +1 -1
  86. package/docs/types/type-aliases/DTI.md +1 -1
  87. package/docs/types/type-aliases/Destination.md +1 -1
  88. package/docs/types/type-aliases/Error.md +1 -1
  89. package/docs/types/type-aliases/FieldOptions.md +1 -1
  90. package/docs/types/type-aliases/FieldTypes.md +1 -1
  91. package/docs/types/type-aliases/HostMessage.md +1 -1
  92. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  93. package/docs/types/type-aliases/InvalidValue.md +1 -1
  94. package/docs/types/type-aliases/LEI.md +1 -1
  95. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  96. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  97. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  98. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  99. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  100. package/docs/types/type-aliases/Ready.md +1 -1
  101. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  102. package/docs/types/type-aliases/Source.md +1 -1
  103. package/docs/types/type-aliases/Theme.md +1 -1
  104. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  105. package/docs/types/type-aliases/TravelAddress.md +1 -1
  106. package/docs/types/type-aliases/URI.md +1 -1
  107. package/docs/types/type-aliases/UUID.md +1 -1
  108. package/docs/types/type-aliases/UpdateValue.md +1 -1
  109. package/docs/types/type-aliases/V1Asset.md +1 -1
  110. package/docs/types/type-aliases/V1Transaction.md +5 -1
  111. package/docs/types/type-aliases/VASPOptions.md +1 -1
  112. package/docs/types/type-aliases/ValidationError.md +1 -1
  113. package/package.json +1 -1
  114. package/src/types.ts +10 -1
@@ -38,7 +38,7 @@ This interface is extended by specific response types like:
38
38
 
39
39
  #### Defined in
40
40
 
41
- [types.ts:646](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L646)
41
+ [types.ts:656](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L656)
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:643](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L643)
51
+ [types.ts:653](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L653)
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:645](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L645)
61
+ [types.ts:655](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L655)
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:644](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L644)
71
+ [types.ts:654](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L654)
@@ -36,7 +36,7 @@ associated with the claimed address.
36
36
 
37
37
  #### Defined in
38
38
 
39
- [types.ts:1048](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1048)
39
+ [types.ts:1060](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1060)
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:1113](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1113)
49
+ [types.ts:1125](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1125)
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:1047](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1047)
63
+ [types.ts:1059](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1059)
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:1112](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1112)
73
+ [types.ts:1124](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1124)
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:1046](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1046)
87
+ [types.ts:1058](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1058)
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:1111](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1111)
101
+ [types.ts:1123](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1123)
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:1114](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1114)
111
+ [types.ts:1126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1126)
@@ -20,7 +20,7 @@ An object representing a connection request
20
20
 
21
21
  #### Defined in
22
22
 
23
- [types.ts:567](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L567)
23
+ [types.ts:575](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L575)
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:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L496)
37
+ [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L496)
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:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L495)
51
+ [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L495)
@@ -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:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L342)
45
+ [types.ts:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L342)
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:343](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L343)
55
+ [types.ts:343](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L343)
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:350](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L350)
65
+ [types.ts:350](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L350)
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:346](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L346)
75
+ [types.ts:346](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L346)
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:341](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L341)
85
+ [types.ts:341](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L341)
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:347](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L347)
95
+ [types.ts:347](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L347)
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:349](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L349)
105
+ [types.ts:349](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L349)
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:344](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L344)
115
+ [types.ts:344](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L344)
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:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L345)
125
+ [types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L345)
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:348](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L348)
135
+ [types.ts:348](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L348)
@@ -24,7 +24,7 @@ Ownership Proof using Self Declaration
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:1048](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1048)
27
+ [types.ts:1060](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1060)
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:1093](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1093)
37
+ [types.ts:1105](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1105)
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:1094](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1094)
47
+ [types.ts:1106](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1106)
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:1047](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1047)
61
+ [types.ts:1059](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1059)
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:1046](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1046)
75
+ [types.ts:1058](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1058)
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:1092](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L1092)
89
+ [types.ts:1104](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L1104)
@@ -10,7 +10,7 @@ An object representing a deposit transaction
10
10
 
11
11
  ## Extends
12
12
 
13
- - `OriginatorFields`.[`Transaction`](Transaction.md)
13
+ - `OriginatorFields`.[`DepositTransaction`](DepositTransaction.md)
14
14
 
15
15
  ## Properties
16
16
 
@@ -20,11 +20,11 @@ An object representing a deposit transaction
20
20
 
21
21
  #### Inherited from
22
22
 
23
- [`Transaction`](Transaction.md).[`agent`](Transaction.md#agent)
23
+ [`DepositTransaction`](DepositTransaction.md).[`agent`](DepositTransaction.md#agent)
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L523)
27
+ [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L523)
28
28
 
29
29
  ***
30
30
 
@@ -34,11 +34,11 @@ An object representing a deposit transaction
34
34
 
35
35
  #### Inherited from
36
36
 
37
- [`Transaction`](Transaction.md).[`amountDecimal`](Transaction.md#amountdecimal)
37
+ [`DepositTransaction`](DepositTransaction.md).[`amountDecimal`](DepositTransaction.md#amountdecimal)
38
38
 
39
39
  #### Defined in
40
40
 
41
- [types.ts:526](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L526)
41
+ [types.ts:526](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L526)
42
42
 
43
43
  ***
44
44
 
@@ -48,11 +48,11 @@ An object representing a deposit transaction
48
48
 
49
49
  #### Inherited from
50
50
 
51
- [`Transaction`](Transaction.md).[`asset`](Transaction.md#asset)
51
+ [`DepositTransaction`](DepositTransaction.md).[`asset`](DepositTransaction.md#asset)
52
52
 
53
53
  #### Defined in
54
54
 
55
- [types.ts:525](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L525)
55
+ [types.ts:525](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L525)
56
56
 
57
57
  ***
58
58
 
@@ -70,11 +70,11 @@ An object representing a deposit transaction
70
70
 
71
71
  #### Inherited from
72
72
 
73
- [`Transaction`](Transaction.md).[`assetPrice`](Transaction.md#assetprice)
73
+ [`DepositTransaction`](DepositTransaction.md).[`assetPrice`](DepositTransaction.md#assetprice)
74
74
 
75
75
  #### Defined in
76
76
 
77
- [types.ts:528](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L528)
77
+ [types.ts:528](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L528)
78
78
 
79
79
  ***
80
80
 
@@ -84,11 +84,11 @@ An object representing a deposit transaction
84
84
 
85
85
  #### Inherited from
86
86
 
87
- [`Transaction`](Transaction.md).[`counterparty`](Transaction.md#counterparty)
87
+ [`DepositTransaction`](DepositTransaction.md).[`counterparty`](DepositTransaction.md#counterparty)
88
88
 
89
89
  #### Defined in
90
90
 
91
- [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L524)
91
+ [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L524)
92
92
 
93
93
  ***
94
94
 
@@ -98,11 +98,11 @@ An object representing a deposit transaction
98
98
 
99
99
  #### Inherited from
100
100
 
101
- [`Transaction`](Transaction.md).[`customer`](Transaction.md#customer)
101
+ [`DepositTransaction`](DepositTransaction.md).[`customer`](DepositTransaction.md#customer)
102
102
 
103
103
  #### Defined in
104
104
 
105
- [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L496)
105
+ [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L496)
106
106
 
107
107
  ***
108
108
 
@@ -112,11 +112,11 @@ An object representing a deposit transaction
112
112
 
113
113
  #### Inherited from
114
114
 
115
- [`Transaction`](Transaction.md).[`proof`](Transaction.md#proof)
115
+ [`DepositTransaction`](DepositTransaction.md).[`proof`](DepositTransaction.md#proof)
116
116
 
117
117
  #### Defined in
118
118
 
119
- [types.ts:527](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L527)
119
+ [types.ts:527](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L527)
120
120
 
121
121
  ***
122
122
 
@@ -126,11 +126,11 @@ An object representing a deposit transaction
126
126
 
127
127
  #### Inherited from
128
128
 
129
- [`Transaction`](Transaction.md).[`requestId`](Transaction.md#requestid)
129
+ [`DepositTransaction`](DepositTransaction.md).[`requestId`](DepositTransaction.md#requestid)
130
130
 
131
131
  #### Defined in
132
132
 
133
- [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L495)
133
+ [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L495)
134
134
 
135
135
  ***
136
136
 
@@ -144,4 +144,18 @@ An object representing a deposit transaction
144
144
 
145
145
  #### Defined in
146
146
 
147
- [types.ts:453](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L453)
147
+ [types.ts:453](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L453)
148
+
149
+ ***
150
+
151
+ ### transactionId?
152
+
153
+ > `optional` **transactionId**: `string`
154
+
155
+ #### Inherited from
156
+
157
+ [`DepositTransaction`](DepositTransaction.md).[`transactionId`](DepositTransaction.md#transactionid)
158
+
159
+ #### Defined in
160
+
161
+ [types.ts:539](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L539)
@@ -24,7 +24,7 @@ An object representing a request for a deposit
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:471](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L471)
27
+ [types.ts:471](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L471)
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:470](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L470)
41
+ [types.ts:470](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L470)
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:473](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L473)
55
+ [types.ts:473](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L473)
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:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L496)
69
+ [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L496)
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:469](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L469)
83
+ [types.ts:469](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L469)
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:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L495)
97
+ [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L495)
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:472](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L472)
111
+ [types.ts:472](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L472)
@@ -16,4 +16,4 @@ An object representing options for a Deposit Request
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:559](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L559)
19
+ [types.ts:567](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L567)
@@ -0,0 +1,147 @@
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
+
3
+ ***
4
+
5
+ [@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / DepositTransaction
6
+
7
+ # Interface: DepositTransaction
8
+
9
+ Extended transaction interface for deposits
10
+
11
+ ## Extends
12
+
13
+ - [`Transaction`](Transaction.md)
14
+
15
+ ## Extended by
16
+
17
+ - [`Deposit`](Deposit.md)
18
+
19
+ ## Properties
20
+
21
+ ### agent
22
+
23
+ > **agent**: [`Agent`](Agent.md)
24
+
25
+ #### Inherited from
26
+
27
+ [`Transaction`](Transaction.md).[`agent`](Transaction.md#agent)
28
+
29
+ #### Defined in
30
+
31
+ [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L523)
32
+
33
+ ***
34
+
35
+ ### amountDecimal
36
+
37
+ > **amountDecimal**: `number`
38
+
39
+ #### Inherited from
40
+
41
+ [`Transaction`](Transaction.md).[`amountDecimal`](Transaction.md#amountdecimal)
42
+
43
+ #### Defined in
44
+
45
+ [types.ts:526](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L526)
46
+
47
+ ***
48
+
49
+ ### asset
50
+
51
+ > **asset**: `string`
52
+
53
+ #### Inherited from
54
+
55
+ [`Transaction`](Transaction.md).[`asset`](Transaction.md#asset)
56
+
57
+ #### Defined in
58
+
59
+ [types.ts:525](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L525)
60
+
61
+ ***
62
+
63
+ ### assetPrice?
64
+
65
+ > `optional` **assetPrice**: `object`
66
+
67
+ #### currency
68
+
69
+ > **currency**: `string`
70
+
71
+ #### price
72
+
73
+ > **price**: `number`
74
+
75
+ #### Inherited from
76
+
77
+ [`Transaction`](Transaction.md).[`assetPrice`](Transaction.md#assetprice)
78
+
79
+ #### Defined in
80
+
81
+ [types.ts:528](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L528)
82
+
83
+ ***
84
+
85
+ ### counterparty
86
+
87
+ > **counterparty**: [`Counterparty`](Counterparty.md)
88
+
89
+ #### Inherited from
90
+
91
+ [`Transaction`](Transaction.md).[`counterparty`](Transaction.md#counterparty)
92
+
93
+ #### Defined in
94
+
95
+ [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L524)
96
+
97
+ ***
98
+
99
+ ### customer?
100
+
101
+ > `optional` **customer**: [`Counterparty`](Counterparty.md)
102
+
103
+ #### Inherited from
104
+
105
+ [`Transaction`](Transaction.md).[`customer`](Transaction.md#customer)
106
+
107
+ #### Defined in
108
+
109
+ [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L496)
110
+
111
+ ***
112
+
113
+ ### proof?
114
+
115
+ > `optional` **proof**: [`OwnershipProof`](OwnershipProof.md)
116
+
117
+ #### Inherited from
118
+
119
+ [`Transaction`](Transaction.md).[`proof`](Transaction.md#proof)
120
+
121
+ #### Defined in
122
+
123
+ [types.ts:527](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L527)
124
+
125
+ ***
126
+
127
+ ### requestId?
128
+
129
+ > `optional` **requestId**: `string`
130
+
131
+ #### Inherited from
132
+
133
+ [`Transaction`](Transaction.md).[`requestId`](Transaction.md#requestid)
134
+
135
+ #### Defined in
136
+
137
+ [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L495)
138
+
139
+ ***
140
+
141
+ ### transactionId?
142
+
143
+ > `optional` **transactionId**: `string`
144
+
145
+ #### Defined in
146
+
147
+ [types.ts:539](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L539)