@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
package/src/types.ts CHANGED
@@ -531,6 +531,14 @@ export interface Transaction extends ComponentRequest {
531
531
  };
532
532
  }
533
533
 
534
+ /**
535
+ * Extended transaction interface for deposits
536
+ * @public
537
+ */
538
+ export interface DepositTransaction extends Transaction {
539
+ transactionId?: string; // Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
540
+ }
541
+
534
542
  /**
535
543
  * An object representing a withdrawal transaction
536
544
  * @public
@@ -541,7 +549,7 @@ export interface Withdrawal extends BeneficiaryFields, Transaction {}
541
549
  * An object representing a deposit transaction
542
550
  * @public
543
551
  */
544
- export interface Deposit extends OriginatorFields, Transaction {}
552
+ export interface Deposit extends OriginatorFields, DepositTransaction {}
545
553
 
546
554
  /**
547
555
  * An object representing a request for a deposit
@@ -619,6 +627,7 @@ export type V1Transaction = {
619
627
  originatorProof?: OwnershipProof;
620
628
  originator?: Originator;
621
629
  beneficiary: Beneficiary;
630
+ transactionId?: string;
622
631
  };
623
632
 
624
633
  /**