@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/README.md CHANGED
@@ -44,6 +44,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
44
44
  - [Deposit Assist](#deposit-assist)
45
45
  - [Parameters](#parameters-3)
46
46
  - [Error handling](#error-handling)
47
+ - [Error reference](#error-reference)
47
48
  - [Transaction parameters](#transaction-parameters)
48
49
  - [Asset specification](#asset-specification)
49
50
  - [Transaction amount](#transaction-amount)
@@ -63,8 +64,8 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
63
64
  - [Full Example](#full-example)
64
65
  - [Field reference](#field-reference)
65
66
  - [Locales](#locales)
66
- - [License](#license)
67
67
  - [Theming](#theming)
68
+ - [License](#license)
68
69
 
69
70
  ## Installation
70
71
 
@@ -409,6 +410,7 @@ const deposit = notabene.createDepositAssist(
409
410
  amountDecimal: 1.23,
410
411
  origin: '0x...',
411
412
  destination: '0x...',
413
+ transactionId: "UUID"
412
414
  },
413
415
  {
414
416
  // Optional transaction options
@@ -422,6 +424,7 @@ const deposit = notabene.createDepositAssist(
422
424
  - `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
423
425
  - `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
424
426
  - `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
427
+ - `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
425
428
 
426
429
  If any of the required parameters are missing the component will just show the Notabene badge.
427
430
 
@@ -383,7 +383,7 @@ export declare function decodeFragmentToObject(fragment: string): Record<string,
383
383
  * An object representing a deposit transaction
384
384
  * @public
385
385
  */
386
- export declare interface Deposit extends OriginatorFields, Transaction {
386
+ export declare interface Deposit extends OriginatorFields, DepositTransaction {
387
387
  }
388
388
 
389
389
  /**
@@ -413,6 +413,14 @@ declare interface DepositRequestOptions {
413
413
  showQrCode?: boolean;
414
414
  }
415
415
 
416
+ /**
417
+ * Extended transaction interface for deposits
418
+ * @public
419
+ */
420
+ declare interface DepositTransaction extends Transaction {
421
+ transactionId?: string;
422
+ }
423
+
416
424
  /**
417
425
  * The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
418
426
  * @public
@@ -1539,6 +1547,7 @@ export declare type V1Transaction = {
1539
1547
  originatorProof?: OwnershipProof;
1540
1548
  originator?: Originator;
1541
1549
  beneficiary: Beneficiary;
1550
+ transactionId?: string;
1542
1551
  };
1543
1552
 
1544
1553
  /**
package/docs/README.md CHANGED
@@ -48,6 +48,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
48
48
  - [Deposit Assist](#deposit-assist)
49
49
  - [Parameters](#parameters-3)
50
50
  - [Error handling](#error-handling)
51
+ - [Error reference](#error-reference)
51
52
  - [Transaction parameters](#transaction-parameters)
52
53
  - [Asset specification](#asset-specification)
53
54
  - [Transaction amount](#transaction-amount)
@@ -67,6 +68,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
67
68
  - [Full Example](#full-example)
68
69
  - [Field reference](#field-reference)
69
70
  - [Locales](#locales)
71
+ - [Theming](#theming)
70
72
  - [License](#license)
71
73
 
72
74
  ## Installation
@@ -202,6 +204,14 @@ To be notified of any validation errors use:
202
204
  withdrawal.on('error',error => ...)
203
205
  ```
204
206
 
207
+ To be notified when the component is Ready:
208
+
209
+ ```js
210
+ withdrawal.on('ready', ({ type }) => {
211
+ console.log(type === 'ready');
212
+ });
213
+ ```
214
+
205
215
  Calling `on` returns a function that will allow you to cleanly unsubscribe.
206
216
 
207
217
  ```js
@@ -404,6 +414,7 @@ const deposit = notabene.createDepositAssist(
404
414
  amountDecimal: 1.23,
405
415
  origin: '0x...',
406
416
  destination: '0x...',
417
+ transactionId: "UUID"
407
418
  },
408
419
  {
409
420
  // Optional transaction options
@@ -417,6 +428,7 @@ const deposit = notabene.createDepositAssist(
417
428
  - `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
418
429
  - `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
419
430
  - `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
431
+ - `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
420
432
 
421
433
  If any of the required parameters are missing the component will just show the Notabene badge.
422
434
 
@@ -427,9 +439,43 @@ If any of the required parameters are missing the component will just show the N
427
439
  If any error occurs, the `error` event is passed containing a message.
428
440
 
429
441
  ```ts
430
- withdrawal.on('error', {message} => ...)
442
+ withdrawal.on('error', (error) => ...)
443
+ ```
444
+
445
+ An example error object.
446
+
447
+ ```ts
448
+ type Error = {
449
+ type: CMType.Error;
450
+ message: string;
451
+ description: string;
452
+ identifier: ErrorIdentifierCode;
453
+ };
454
+ ```
455
+ Errors can be handled in this way:
456
+
457
+ ```ts
458
+ component.on('error', (error) => {
459
+ if (error.type === CMType.Error) {
460
+ switch (error.identifier) {
461
+ case ErrorIdentifierCode.SERVICE_UNAVAILABLE:
462
+ // handle the error
463
+ break;
464
+ //...
465
+ }
466
+ }
467
+ });
431
468
  ```
432
469
 
470
+ #### Error reference
471
+
472
+ | ErrorIdentifierCode | Description/Message | In Use |
473
+ |--------------------------|----------------------------------------------------------------------------------------------------------|---|
474
+ | SERVICE_UNAVAILABLE | The Notabene service is currently unavailable | ✅ |
475
+ | TOKEN_INVALID | Auth Token is Invalid | ✅ |
476
+ | WALLET_CONNECTION_FAILED | The connection to the wallet service failed, possibly due to network issues or unsupported wallet types. | ✅ |
477
+ | WALLET_NOT_SUPPORTED | The wallet used does not support the required functionality or blockchain. | |
478
+
433
479
  ## Transaction parameters
434
480
 
435
481
  ### Asset specification
@@ -497,7 +543,7 @@ const options: TransactionOptions = {
497
543
  amountSubunits: '12344',
498
544
  timeout: 86440,
499
545
  },
500
- fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self_declaration']
546
+ fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self-declaration']
501
547
  deminimis: {
502
548
  threshold: 1000,
503
549
  currency: 'EUR',
@@ -733,6 +779,23 @@ const options: TransactionOptions = {
733
779
 
734
780
  See [locales](_media/locales.ts) for the list of supported locales.
735
781
 
782
+ ## Theming
783
+
784
+ You can optionally theme the UI when creating an instance of `Notabene`
785
+
786
+ ```js
787
+ const notabene = new Notabene({
788
+ nodeUrl: 'https://api.notabene.id',
789
+ authToken: 'YOUR_CUSTOMER_TOKEN',
790
+ theme: {
791
+ mode: 'light', // 'light', 'dark'
792
+ primaryColor: '#0a852d',
793
+ secondaryColor: '#f5f7fa',
794
+ fontFamily: 'Montserrat' // Google Fonts Supported
795
+ }
796
+ });
797
+ ```
798
+
736
799
  ## [License](_media/LICENSE.md)
737
800
 
738
801
  MIT © Notabene Inc.
@@ -16,7 +16,7 @@ Configuration options for Transaction components
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:769](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L769)
19
+ [types.ts:781](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L781)
20
20
 
21
21
  ***
22
22
 
@@ -26,7 +26,7 @@ Configuration options for Transaction components
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:770](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L770)
29
+ [types.ts:782](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L782)
30
30
 
31
31
  ***
32
32
 
@@ -36,7 +36,7 @@ Configuration options for Transaction components
36
36
 
37
37
  #### Defined in
38
38
 
39
- [types.ts:771](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L771)
39
+ [types.ts:783](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L783)
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:773](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L773)
49
+ [types.ts:785](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L785)
50
50
 
51
51
  ***
52
52
 
@@ -80,7 +80,7 @@ Configuration options for Transaction components
80
80
 
81
81
  #### Defined in
82
82
 
83
- [types.ts:760](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L760)
83
+ [types.ts:772](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L772)
84
84
 
85
85
  ***
86
86
 
@@ -90,4 +90,4 @@ Configuration options for Transaction components
90
90
 
91
91
  #### Defined in
92
92
 
93
- [types.ts:772](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/types.ts#L772)
93
+ [types.ts:784](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L784)
@@ -18,7 +18,7 @@ Published May 2020
18
18
 
19
19
  #### Defined in
20
20
 
21
- [ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L365)
21
+ [ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L365)
22
22
 
23
23
  ***
24
24
 
@@ -30,4 +30,4 @@ Published August 2023
30
30
 
31
31
  #### Defined in
32
32
 
33
- [ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L367)
33
+ [ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L367)
@@ -19,7 +19,7 @@ The version of IVMS 101 to which the payload complies.
19
19
 
20
20
  #### Defined in
21
21
 
22
- [ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L358)
22
+ [ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L358)
23
23
 
24
24
  ***
25
25
 
@@ -31,4 +31,4 @@ The method used to map from a national system of writing to Latin script.
31
31
 
32
32
  #### Defined in
33
33
 
34
- [ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L356)
34
+ [ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L356)
@@ -111,4 +111,4 @@ Name of a built-up area, with defined boundaries, and a local government.
111
111
 
112
112
  ## Defined in
113
113
 
114
- [ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L119)
114
+ [ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L119)
@@ -13,4 +13,4 @@ Specifies the type of address
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L44)
16
+ [ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L44)
@@ -27,4 +27,4 @@ Array of persons associated with the beneficiary
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L313)
30
+ [ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L313)
@@ -21,4 +21,4 @@ The beneficiary VASP information
21
21
 
22
22
  ## Defined in
23
23
 
24
- [ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L335)
24
+ [ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L335)
@@ -27,4 +27,4 @@ Place of birth (max 70 characters)
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L107)
30
+ [ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L107)
@@ -19,4 +19,4 @@ ISO-3166 Alpha-2 country code
19
19
 
20
20
  ## Defined in
21
21
 
22
- [ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L6)
22
+ [ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L6)
@@ -20,4 +20,4 @@ Format: YYYY-MM-DD
20
20
 
21
21
  ## Defined in
22
22
 
23
- [ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L14)
23
+ [ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L14)
@@ -38,4 +38,4 @@ IVMS101 definition
38
38
 
39
39
  ## Defined in
40
40
 
41
- [ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L375)
41
+ [ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L375)
@@ -27,4 +27,4 @@ The sequence number of this VASP in the transfer path
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L289)
30
+ [ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L289)
@@ -45,4 +45,4 @@ A distinct identifier used by governments to uniquely identify a legal person
45
45
 
46
46
  ## Defined in
47
47
 
48
- [ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L259)
48
+ [ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L259)
@@ -33,4 +33,4 @@ Array of phonetic name identifiers
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L245)
36
+ [ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L245)
@@ -27,4 +27,4 @@ The nature of the name specified
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L233)
30
+ [ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L233)
@@ -13,4 +13,4 @@ Specifies the type of name for a legal person
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L34)
16
+ [ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L34)
@@ -27,4 +27,4 @@ Type of legal person name identifier
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L221)
30
+ [ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L221)
@@ -33,4 +33,4 @@ Secondary identifier, maximum 100 characters in local format
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L159)
36
+ [ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L159)
@@ -39,4 +39,4 @@ Registration authority (format: RA followed by 6 digits)
39
39
 
40
40
  ## Defined in
41
41
 
42
- [ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L91)
42
+ [ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L91)
@@ -13,4 +13,4 @@ Specifies the type of national identifier
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L54)
16
+ [ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L54)
@@ -51,4 +51,4 @@ A distinct identifier used by governments to uniquely identify a natural person
51
51
 
52
52
  ## Defined in
53
53
 
54
- [ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L201)
54
+ [ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L201)
@@ -33,4 +33,4 @@ Array of phonetic name identifiers
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L187)
36
+ [ivms/types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L187)
@@ -33,4 +33,4 @@ Secondary identifier, maximum 100 characters
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L173)
36
+ [ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L173)
@@ -13,4 +13,4 @@ Specifies the type of name for a natural person
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L22)
16
+ [ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L22)
@@ -21,4 +21,4 @@ The originating VASP information
21
21
 
22
22
  ## Defined in
23
23
 
24
- [ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L325)
24
+ [ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L325)
@@ -27,4 +27,4 @@ Array of persons associated with the originator
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L301)
30
+ [ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L301)
@@ -27,4 +27,4 @@ Natural person information
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L277)
30
+ [ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L277)
@@ -21,4 +21,4 @@ Array of intermediary VASPs involved in the transfer
21
21
 
22
22
  ## Defined in
23
23
 
24
- [ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L345)
24
+ [ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L345)
@@ -13,4 +13,4 @@ Specifies the method used to transliterate text
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/ivms/types.ts#L71)
16
+ [ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L71)
@@ -159,6 +159,12 @@ Re-exports [Error](../types/type-aliases/Error.md)
159
159
 
160
160
  ***
161
161
 
162
+ ### ErrorIdentifierCode
163
+
164
+ Re-exports [ErrorIdentifierCode](../types/enumerations/ErrorIdentifierCode.md)
165
+
166
+ ***
167
+
162
168
  ### FieldTypes
163
169
 
164
170
  Re-exports [FieldTypes](../types/type-aliases/FieldTypes.md)
@@ -46,7 +46,7 @@ The initial transaction value
46
46
 
47
47
  #### Defined in
48
48
 
49
- [components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L34)
49
+ [components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L34)
50
50
 
51
51
  ## Accessors
52
52
 
@@ -62,7 +62,7 @@ The initial transaction value
62
62
 
63
63
  #### Defined in
64
64
 
65
- [components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L72)
65
+ [components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L72)
66
66
 
67
67
  ***
68
68
 
@@ -78,7 +78,7 @@ The initial transaction value
78
78
 
79
79
  #### Defined in
80
80
 
81
- [components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L68)
81
+ [components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L68)
82
82
 
83
83
  ***
84
84
 
@@ -98,7 +98,7 @@ The URL of the embedded component
98
98
 
99
99
  #### Defined in
100
100
 
101
- [components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L56)
101
+ [components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L56)
102
102
 
103
103
  ***
104
104
 
@@ -118,7 +118,7 @@ The current transaction value
118
118
 
119
119
  #### Defined in
120
120
 
121
- [components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L64)
121
+ [components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L64)
122
122
 
123
123
  ## Methods
124
124
 
@@ -134,7 +134,7 @@ Closes the modal dialog
134
134
 
135
135
  #### Defined in
136
136
 
137
- [components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L240)
137
+ [components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L240)
138
138
 
139
139
  ***
140
140
 
@@ -152,7 +152,7 @@ A promise that resolves with the transaction response
152
152
 
153
153
  #### Defined in
154
154
 
155
- [components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L173)
155
+ [components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L173)
156
156
 
157
157
  ***
158
158
 
@@ -180,7 +180,7 @@ The parent element to embed the component into
180
180
 
181
181
  #### Defined in
182
182
 
183
- [components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L100)
183
+ [components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L100)
184
184
 
185
185
  ***
186
186
 
@@ -208,7 +208,7 @@ Will throw an error if the parent element is not found
208
208
 
209
209
  #### Defined in
210
210
 
211
- [components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L90)
211
+ [components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L90)
212
212
 
213
213
  ***
214
214
 
@@ -238,7 +238,7 @@ The callback function to remove
238
238
 
239
239
  #### Defined in
240
240
 
241
- [components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L154)
241
+ [components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L154)
242
242
 
243
243
  ***
244
244
 
@@ -272,7 +272,7 @@ The callback function to execute when the message is received
272
272
 
273
273
  #### Defined in
274
274
 
275
- [components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L144)
275
+ [components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L144)
276
276
 
277
277
  ***
278
278
 
@@ -288,7 +288,7 @@ Opens the component URL in the current window
288
288
 
289
289
  #### Defined in
290
290
 
291
- [components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L80)
291
+ [components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L80)
292
292
 
293
293
  ***
294
294
 
@@ -304,7 +304,7 @@ Opens the component in a modal dialog
304
304
 
305
305
  #### Defined in
306
306
 
307
- [components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L202)
307
+ [components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L202)
308
308
 
309
309
  ***
310
310
 
@@ -327,7 +327,7 @@ A promise that resolves with the transaction response
327
327
 
328
328
  #### Defined in
329
329
 
330
- [components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L255)
330
+ [components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L255)
331
331
 
332
332
  ***
333
333
 
@@ -341,7 +341,7 @@ A promise that resolves with the transaction response
341
341
 
342
342
  #### Defined in
343
343
 
344
- [components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L126)
344
+ [components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L126)
345
345
 
346
346
  ***
347
347
 
@@ -365,7 +365,7 @@ The message to send
365
365
 
366
366
  #### Defined in
367
367
 
368
- [components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L134)
368
+ [components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L134)
369
369
 
370
370
  ***
371
371
 
@@ -393,4 +393,4 @@ The new transaction value
393
393
 
394
394
  #### Defined in
395
395
 
396
- [components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/06342c6adf6f9cad152dcf6ecd0c80e7eb65778c/src/components/EmbeddedComponent.ts#L162)
396
+ [components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/components/EmbeddedComponent.ts#L162)