@notabene/javascript-sdk 2.0.0 → 2.0.2

package/docs/_media/TransactionOptions.md

@@ -0,0 +1,93 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / TransactionOptions
+
+# Interface: TransactionOptions
+
+Configuration options for Transaction components
+
+## Properties
+
+### allowedAgentTypes?
+
+> `optional` **allowedAgentTypes**: [`AgentType`](../enumerations/AgentType.md)[]
+
+#### Defined in
+
+[types.ts:754](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L754)
+
+***
+
+### allowedCounterpartyTypes?
+
+> `optional` **allowedCounterpartyTypes**: [`PersonType`](../enumerations/PersonType.md)[]
+
+#### Defined in
+
+[types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L755)
+
+***
+
+### fields?
+
+> `optional` **fields**: [`FieldTypes`](../type-aliases/FieldTypes.md)
+
+#### Defined in
+
+[types.ts:756](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L756)
+
+***
+
+### hide?
+
+> `optional` **hide**: [`ValidationSections`](../enumerations/ValidationSections.md)[]
+
+#### Defined in
+
+[types.ts:758](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L758)
+
+***
+
+### proofs?
+
+> `optional` **proofs**: `object`
+
+#### deminimis?
+
+> `optional` **deminimis**: [`ThresholdOptions`](ThresholdOptions.md)
+
+#### fallbacks?
+
+> `optional` **fallbacks**: [`ProofTypes`](../enumerations/ProofTypes.md)[]
+
+#### microTransfer?
+
+> `optional` **microTransfer**: `object`
+
+#### microTransfer.amountSubunits
+
+> **amountSubunits**: `string`
+
+#### microTransfer.destination
+
+> **destination**: `string`
+
+#### microTransfer.timeout?
+
+> `optional` **timeout**: `number`
+
+#### Defined in
+
+[types.ts:745](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L745)
+
+***
+
+### vasps?
+
+> `optional` **vasps**: [`VASPOptions`](../type-aliases/VASPOptions.md)
+
+#### Defined in
+
+[types.ts:757](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L757)

package/docs/_media/locales.ts

@@ -0,0 +1,48 @@
+export const languages = {
+  ar: 'العربية (Arabic)',
+  bg: 'български (Bulgarian)',
+  ca: 'Català (Catalan)',
+  cs: 'Čeština (Czech)',
+  da: 'Dansk (Danish)',
+  de: 'Deutsch (German)',
+  el: 'Ελληνικά (Greek)',
+  en: 'English (English)',
+  es: 'Español (Spanish)',
+  et: 'Eesti (Estonian)',
+  fa: 'فارسی (Persian)',
+  fi: 'Suomi (Finnish)',
+  fr: 'Français (French)',
+  he: 'עברית (Hebrew)',
+  hr: 'Hrvatski (Croatian)',
+  hu: 'Magyar (Hungarian)',
+  hy: 'Հայերեն (Armenian)',
+  id: 'Bahasa Indonesia (Indonesian)',
+  is: 'Íslenska (Icelandic)',
+  it: 'Italiano (Italian)',
+  ja: '日本語 (Japanese)',
+  ka: 'ქართული (Georgian)',
+  ko: '한국어 (Korean)',
+  lt: 'Lietuvių (Lithuanian)',
+  lv: 'Latviešu (Latvian)',
+  mn: 'Монгол (Mongolian)',
+  ms: 'Bahasa Melayu (Malay)',
+  mt: 'Malti (Maltese)',
+  nl: 'Nederlands (Dutch)',
+  no: 'Norsk (Norwegian)',
+  pl: 'Polski (Polish)',
+  pt: 'Português (Portuguese)',
+  ro: 'Română (Romanian)',
+  ru: 'Русский (Russian)',
+  sk: 'Slovenčina (Slovak)',
+  sl: 'Slovenščina (Slovenian)',
+  sr: 'Српски (Serbian)',
+  sv: 'Svenska (Swedish)',
+  sw: 'Kiswahili (Swahili)',
+  th: 'ไทย (Thai)',
+  tl: 'Tagalog (Tagalog)',
+  tr: 'Türkçe (Turkish)',
+  uk: 'Українська (Ukrainian)',
+  vi: 'Tiếng Việt (Vietnamese)',
+  'zh-CN': '中文 (Chinese)',
+  'zh-TW': '中文 (Chinese)',
+};

package/docs/ivms/types/README.md

@@ -0,0 +1,46 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / ivms/types
+
+# ivms/types
+
+## Index
+
+### Enumerations
+
+- [PayloadVersionCode](enumerations/PayloadVersionCode.md)
+
+### Interfaces
+
+- [PayloadMetadata](interfaces/PayloadMetadata.md)
+
+### Type Aliases
+
+- [Address](type-aliases/Address.md)
+- [AddressTypeCode](type-aliases/AddressTypeCode.md)
+- [Beneficiary](type-aliases/Beneficiary.md)
+- [BeneficiaryVASP](type-aliases/BeneficiaryVASP.md)
+- [DateAndPlaceOfBirth](type-aliases/DateAndPlaceOfBirth.md)
+- [IntermediaryVASP](type-aliases/IntermediaryVASP.md)
+- [ISOCountryCode](type-aliases/ISOCountryCode.md)
+- [ISODate](type-aliases/ISODate.md)
+- [IVMS101](type-aliases/IVMS101.md)
+- [LegalPerson](type-aliases/LegalPerson.md)
+- [LegalPersonName](type-aliases/LegalPersonName.md)
+- [LegalPersonNameID](type-aliases/LegalPersonNameID.md)
+- [LegalPersonNameTypeCode](type-aliases/LegalPersonNameTypeCode.md)
+- [LocalLegalPersonNameID](type-aliases/LocalLegalPersonNameID.md)
+- [LocalNaturalPersonNameID](type-aliases/LocalNaturalPersonNameID.md)
+- [NationalIdentification](type-aliases/NationalIdentification.md)
+- [NationalIdentifierTypeCode](type-aliases/NationalIdentifierTypeCode.md)
+- [NaturalPerson](type-aliases/NaturalPerson.md)
+- [NaturalPersonName](type-aliases/NaturalPersonName.md)
+- [NaturalPersonNameID](type-aliases/NaturalPersonNameID.md)
+- [NaturalPersonNameTypeCode](type-aliases/NaturalPersonNameTypeCode.md)
+- [OriginatingVASP](type-aliases/OriginatingVASP.md)
+- [Originator](type-aliases/Originator.md)
+- [Person](type-aliases/Person.md)
+- [TransferPath](type-aliases/TransferPath.md)
+- [TransliterationMethodCode](type-aliases/TransliterationMethodCode.md)

package/docs/ivms/types/enumerations/PayloadVersionCode.md

@@ -0,0 +1,33 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / PayloadVersionCode
+
+# Enumeration: PayloadVersionCode
+
+The version of IVMS 101 to which the payload complies.
+
+## Enumeration Members
+
+### V101
+
+> **V101**: `"101"`
+
+Published May 2020
+
+#### Defined in
+
+[ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L365)
+
+***
+
+### V101\_2023
+
+> **V101\_2023**: `"101.2023"`
+
+Published August 2023
+
+#### Defined in
+
+[ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L367)

package/docs/ivms/types/interfaces/PayloadMetadata.md

@@ -0,0 +1,34 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / PayloadMetadata
+
+# Interface: PayloadMetadata
+
+6.7
+Data describing the contents of the payload.
+
+## Properties
+
+### payloadVersion
+
+> **payloadVersion**: [`PayloadVersionCode`](../enumerations/PayloadVersionCode.md)
+
+The version of IVMS 101 to which the payload complies.
+
+#### Defined in
+
+[ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L358)
+
+***
+
+### transliterationMethod?
+
+> `optional` **transliterationMethod**: [`TransliterationMethodCode`](../type-aliases/TransliterationMethodCode.md)[]
+
+The method used to map from a national system of writing to Latin script.
+
+#### Defined in
+
+[ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L356)

package/docs/ivms/types/type-aliases/Address.md

@@ -0,0 +1,114 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / Address
+
+# Type Alias: Address
+
+> **Address**: `object`
+
+Address
+Represents a physical address
+
+## Type declaration
+
+### addressLine?
+
+> `optional` **addressLine**: `string`[]
+
+Information that locates and identifies a specific address, presented in free format text.
+
+### addressType
+
+> **addressType**: [`AddressTypeCode`](AddressTypeCode.md)
+
+Identifies the nature of the address.
+
+### buildingName?
+
+> `optional` **buildingName**: `string`
+
+Name of the building or house.
+
+### buildingNumber?
+
+> `optional` **buildingNumber**: `string`
+
+Number that identifies the position of a building on a street.
+
+### country
+
+> **country**: [`ISOCountryCode`](ISOCountryCode.md)
+
+Nation with its own government.
+
+### countrySubDivision?
+
+> `optional` **countrySubDivision**: `string`
+
+Identifies a subdivision of a country such as state, region, province.
+
+### department?
+
+> `optional` **department**: `string`
+
+Identification of a division of a large organisation or building.
+
+### districtName?
+
+> `optional` **districtName**: `string`
+
+Identifies a subdivision within a country subdivision.
+
+### floor?
+
+> `optional` **floor**: `string`
+
+Floor or storey within a building.
+
+### postBox?
+
+> `optional` **postBox**: `string`
+
+Numbered box in a post office.
+
+### postcode?
+
+> `optional` **postcode**: `string`
+
+Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
+
+### room?
+
+> `optional` **room**: `string`
+
+Building room number.
+
+### streetName?
+
+> `optional` **streetName**: `string`
+
+Name of a street or thoroughfare.
+
+### subDepartment?
+
+> `optional` **subDepartment**: `string`
+
+Identification of a sub-division of a large organisation or building.
+
+### townLocationName?
+
+> `optional` **townLocationName**: `string`
+
+Specific location name within the town.
+
+### townName
+
+> **townName**: `string`
+
+Name of a built-up area, with defined boundaries, and a local government.
+
+## Defined in
+
+[ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L119)

package/docs/ivms/types/type-aliases/AddressTypeCode.md

@@ -0,0 +1,16 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / AddressTypeCode
+
+# Type Alias: AddressTypeCode
+
+> **AddressTypeCode**: `"HOME"` \| `"BIZZ"` \| `"GEOG"`
+
+Address Type Code
+Specifies the type of address
+
+## Defined in
+
+[ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L44)

package/docs/ivms/types/type-aliases/Beneficiary.md

@@ -0,0 +1,30 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / Beneficiary
+
+# Type Alias: Beneficiary
+
+> **Beneficiary**: `object`
+
+Beneficiary
+Represents the receiver of the requested VA transfer
+
+## Type declaration
+
+### accountNumber?
+
+> `optional` **accountNumber**: `string`[]
+
+Array of account numbers, maximum 100 characters each
+
+### beneficiaryPersons?
+
+> `optional` **beneficiaryPersons**: [`Person`](Person.md)[]
+
+Array of persons associated with the beneficiary
+
+## Defined in
+
+[ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L313)

package/docs/ivms/types/type-aliases/BeneficiaryVASP.md

@@ -0,0 +1,24 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / BeneficiaryVASP
+
+# Type Alias: BeneficiaryVASP
+
+> **BeneficiaryVASP**: `object`
+
+Beneficiary VASP
+Represents the VASP which receives the VA transfer
+
+## Type declaration
+
+### beneficiaryVASP?
+
+> `optional` **beneficiaryVASP**: [`Person`](Person.md)
+
+The beneficiary VASP information
+
+## Defined in
+
+[ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L335)

package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md

@@ -0,0 +1,30 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / DateAndPlaceOfBirth
+
+# Type Alias: DateAndPlaceOfBirth
+
+> **DateAndPlaceOfBirth**: `object`
+
+Date and Place of Birth
+Represents the date and place of birth for a natural person
+
+## Type declaration
+
+### dateOfBirth?
+
+> `optional` **dateOfBirth**: [`ISODate`](ISODate.md)
+
+Date of birth in ISO 8601 format (YYYY-MM-DD)
+
+### placeOfBirth?
+
+> `optional` **placeOfBirth**: `string`
+
+Place of birth (max 70 characters)
+
+## Defined in
+
+[ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L107)

package/docs/ivms/types/type-aliases/ISOCountryCode.md

@@ -0,0 +1,22 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / ISOCountryCode
+
+# Type Alias: ISOCountryCode
+
+> **ISOCountryCode**: `string`
+
+ISO-3166 Alpha-2 country code
+
+## Example
+
+```ts
+"US" for United States, "GB" for United Kingdom
+@public
+```
+
+## Defined in
+
+[ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L6)

package/docs/ivms/types/type-aliases/ISODate.md

@@ -0,0 +1,23 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / ISODate
+
+# Type Alias: ISODate
+
+> **ISODate**: \`$\{number\}-$\{number\}-$\{number\}\`
+
+A point in time, represented as a day within the calendar year. Compliant with ISO 8601.
+Format: YYYY-MM-DD
+
+## Example
+
+```ts
+"2023-05-15" for May 15, 2023
+@public
+```
+
+## Defined in
+
+[ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L14)

package/docs/ivms/types/type-aliases/IVMS101.md

@@ -0,0 +1,41 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / IVMS101
+
+# Type Alias: IVMS101
+
+> **IVMS101**: `object`
+
+IVMS101 definition
+
+## Type declaration
+
+### beneficiary?
+
+> `optional` **beneficiary**: [`Beneficiary`](Beneficiary.md)
+
+### beneficiaryVASP?
+
+> `optional` **beneficiaryVASP**: [`BeneficiaryVASP`](BeneficiaryVASP.md)
+
+### originatingVASP?
+
+> `optional` **originatingVASP**: [`OriginatingVASP`](OriginatingVASP.md)
+
+### originator?
+
+> `optional` **originator**: [`Originator`](Originator.md)
+
+### payloadMetadata?
+
+> `optional` **payloadMetadata**: [`PayloadMetadata`](../interfaces/PayloadMetadata.md)
+
+### transferPath?
+
+> `optional` **transferPath**: [`TransferPath`](TransferPath.md)
+
+## Defined in
+
+[ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L375)

package/docs/ivms/types/type-aliases/IntermediaryVASP.md

@@ -0,0 +1,30 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / IntermediaryVASP
+
+# Type Alias: IntermediaryVASP
+
+> **IntermediaryVASP**: `object`
+
+Intermediary VASP
+Represents an intermediary Virtual Asset Service Provider
+
+## Type declaration
+
+### intermediaryVASP?
+
+> `optional` **intermediaryVASP**: [`Person`](Person.md)
+
+The intermediary VASP information
+
+### sequence?
+
+> `optional` **sequence**: `number`
+
+The sequence number of this VASP in the transfer path
+
+## Defined in
+
+[ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L289)

package/docs/ivms/types/type-aliases/LegalPerson.md

@@ -0,0 +1,48 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / LegalPerson
+
+# Type Alias: LegalPerson
+
+> **LegalPerson**: `object`
+
+Legal Person
+Represents a legal person with all associated information
+
+## Type declaration
+
+### countryOfRegistration?
+
+> `optional` **countryOfRegistration**: [`ISOCountryCode`](ISOCountryCode.md)
+
+The country in which the legal person is registered
+
+### customerNumber?
+
+> `optional` **customerNumber**: `string`
+
+A distinct identifier that uniquely identifies the person to the institution in context
+
+### geographicAddress?
+
+> `optional` **geographicAddress**: [`Address`](Address.md)[]
+
+The address of the legal person
+
+### name
+
+> **name**: [`LegalPersonName`](LegalPersonName.md)
+
+The name of the legal person
+
+### nationalIdentification?
+
+> `optional` **nationalIdentification**: [`NationalIdentification`](NationalIdentification.md)
+
+A distinct identifier used by governments to uniquely identify a legal person
+
+## Defined in
+
+[ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L259)

package/docs/ivms/types/type-aliases/LegalPersonName.md

@@ -0,0 +1,36 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / LegalPersonName
+
+# Type Alias: LegalPersonName
+
+> **LegalPersonName**: `object`
+
+Legal Person Name
+Represents the full name structure for a legal person
+
+## Type declaration
+
+### localNameIdentifier?
+
+> `optional` **localNameIdentifier**: [`LocalLegalPersonNameID`](LocalLegalPersonNameID.md)[]
+
+Array of local name identifiers
+
+### nameIdentifier
+
+> **nameIdentifier**: [`LegalPersonNameID`](LegalPersonNameID.md)[]
+
+Array of name identifiers
+
+### phoneticNameIdentifier?
+
+> `optional` **phoneticNameIdentifier**: [`LocalLegalPersonNameID`](LocalLegalPersonNameID.md)[]
+
+Array of phonetic name identifiers
+
+## Defined in
+
+[ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L245)