@notabene/javascript-sdk 2.0.0 → 2.0.2

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

@@ -0,0 +1,30 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / LegalPersonNameID
+
+# Type Alias: LegalPersonNameID
+
+> **LegalPersonNameID**: `object`
+
+Legal Person Name ID
+Represents a name identifier for a legal person
+
+## Type declaration
+
+### legalPersonName
+
+> **legalPersonName**: `string`
+
+Name by which the legal person is known
+
+### legalPersonNameIdentifierType
+
+> **legalPersonNameIdentifierType**: [`LegalPersonNameTypeCode`](LegalPersonNameTypeCode.md)
+
+The nature of the name specified
+
+## Defined in
+
+[ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L233)

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

@@ -0,0 +1,16 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / LegalPersonNameTypeCode
+
+# Type Alias: LegalPersonNameTypeCode
+
+> **LegalPersonNameTypeCode**: `"LEGL"` \| `"SHRT"` \| `"TRAD"`
+
+Legal Person Name Type Code
+Specifies the type of name for a legal person
+
+## Defined in
+
+[ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L34)

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

@@ -0,0 +1,30 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / LocalLegalPersonNameID
+
+# Type Alias: LocalLegalPersonNameID
+
+> **LocalLegalPersonNameID**: `object`
+
+Local Legal Person Name ID
+Represents a local name identifier for a legal person
+
+## Type declaration
+
+### legalPersonName?
+
+> `optional` **legalPersonName**: `string`
+
+Name of the legal person, maximum 100 characters in local format
+
+### legalPersonNameIdentifierType?
+
+> `optional` **legalPersonNameIdentifierType**: [`LegalPersonNameTypeCode`](LegalPersonNameTypeCode.md)
+
+Type of legal person name identifier
+
+## Defined in
+
+[ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L221)

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

@@ -0,0 +1,36 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / LocalNaturalPersonNameID
+
+# Type Alias: LocalNaturalPersonNameID
+
+> **LocalNaturalPersonNameID**: `object`
+
+Local Natural Person Name ID
+Represents a local name identifier for a natural person
+
+## Type declaration
+
+### nameIdentifierType?
+
+> `optional` **nameIdentifierType**: [`NaturalPersonNameTypeCode`](NaturalPersonNameTypeCode.md)
+
+Type of name identifier
+
+### primaryIdentifier?
+
+> `optional` **primaryIdentifier**: `string`
+
+Primary identifier, maximum 100 characters in local format
+
+### secondaryIdentifier?
+
+> `optional` **secondaryIdentifier**: `string`
+
+Secondary identifier, maximum 100 characters in local format
+
+## Defined in
+
+[ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L159)

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

@@ -0,0 +1,42 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / NationalIdentification
+
+# Type Alias: NationalIdentification
+
+> **NationalIdentification**: `object`
+
+National Identification
+Represents a national identifier for a person or entity
+
+## Type declaration
+
+### countryOfIssue?
+
+> `optional` **countryOfIssue**: [`ISOCountryCode`](ISOCountryCode.md)
+
+Country that issued the national identifier
+
+### nationalIdentifier?
+
+> `optional` **nationalIdentifier**: `string`
+
+National identifier (max 35 characters)
+
+### nationalIdentifierType?
+
+> `optional` **nationalIdentifierType**: [`NationalIdentifierTypeCode`](NationalIdentifierTypeCode.md)
+
+Type of national identifier
+
+### registrationAuthority?
+
+> `optional` **registrationAuthority**: `string`
+
+Registration authority (format: RA followed by 6 digits)
+
+## Defined in
+
+[ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L91)

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

@@ -0,0 +1,16 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / NationalIdentifierTypeCode
+
+# Type Alias: NationalIdentifierTypeCode
+
+> **NationalIdentifierTypeCode**: `"ARNU"` \| `"CCPT"` \| `"RAID"` \| `"DRLC"` \| `"FIIN"` \| `"TXID"` \| `"SOCS"` \| `"IDCD"` \| `"LEIX"` \| `"MISC"`
+
+National Identifier Type Code
+Specifies the type of national identifier
+
+## Defined in
+
+[ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L54)

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

@@ -0,0 +1,54 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / NaturalPerson
+
+# Type Alias: NaturalPerson
+
+> **NaturalPerson**: `object`
+
+Natural Person
+Represents a natural person with all associated information
+
+## Type declaration
+
+### countryOfResidence?
+
+> `optional` **countryOfResidence**: [`ISOCountryCode`](ISOCountryCode.md)
+
+Country in which a person resides (the place of a person's home)
+
+### customerIdentification?
+
+> `optional` **customerIdentification**: `string`
+
+A distinct identifier that uniquely identifies the person to the institution in context
+
+### dateAndPlaceOfBirth?
+
+> `optional` **dateAndPlaceOfBirth**: [`DateAndPlaceOfBirth`](DateAndPlaceOfBirth.md)
+
+Date and place of birth of a person
+
+### geographicAddress?
+
+> `optional` **geographicAddress**: [`Address`](Address.md)[]
+
+The particulars of a location at which a person may be communicated with
+
+### name
+
+> **name**: [`NaturalPersonName`](NaturalPersonName.md)
+
+The distinct words used as identification for an individual
+
+### nationalIdentification?
+
+> `optional` **nationalIdentification**: [`NationalIdentification`](NationalIdentification.md)
+
+A distinct identifier used by governments to uniquely identify a natural person
+
+## Defined in
+
+[ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L201)

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

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

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

@@ -0,0 +1,36 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / NaturalPersonNameID
+
+# Type Alias: NaturalPersonNameID
+
+> **NaturalPersonNameID**: `object`
+
+Natural Person Name ID
+Represents a name identifier for a natural person
+
+## Type declaration
+
+### nameIdentifierType?
+
+> `optional` **nameIdentifierType**: [`NaturalPersonNameTypeCode`](NaturalPersonNameTypeCode.md)
+
+Type of name identifier
+
+### primaryIdentifier?
+
+> `optional` **primaryIdentifier**: `string`
+
+Primary identifier, maximum 100 characters
+
+### secondaryIdentifier?
+
+> `optional` **secondaryIdentifier**: `string`
+
+Secondary identifier, maximum 100 characters
+
+## Defined in
+
+[ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L173)

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

@@ -0,0 +1,16 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / NaturalPersonNameTypeCode
+
+# Type Alias: NaturalPersonNameTypeCode
+
+> **NaturalPersonNameTypeCode**: `"ALIA"` \| `"BIRT"` \| `"MAID"` \| `"LEGL"` \| `"MISC"`
+
+Natural Person Name Type Code
+Specifies the type of name for a natural person
+
+## Defined in
+
+[ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L22)

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

@@ -0,0 +1,24 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / OriginatingVASP
+
+# Type Alias: OriginatingVASP
+
+> **OriginatingVASP**: `object`
+
+Originating VASP
+Represents the VASP which initiates the VA transfer
+
+## Type declaration
+
+### originatingVASP?
+
+> `optional` **originatingVASP**: [`Person`](Person.md)
+
+The originating VASP information
+
+## Defined in
+
+[ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L325)

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

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

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

@@ -0,0 +1,30 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / Person
+
+# Type Alias: Person
+
+> **Person**: `object`
+
+Person
+Represents either a natural person or a legal person
+
+## Type declaration
+
+### legalPerson?
+
+> `optional` **legalPerson**: [`LegalPerson`](LegalPerson.md)
+
+Legal person information
+
+### naturalPerson?
+
+> `optional` **naturalPerson**: [`NaturalPerson`](NaturalPerson.md)
+
+Natural person information
+
+## Defined in
+
+[ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L277)

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

@@ -0,0 +1,24 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / TransferPath
+
+# Type Alias: TransferPath
+
+> **TransferPath**: `object`
+
+Transfer Path
+Represents the path of intermediary VASPs in a transfer
+
+## Type declaration
+
+### transferPath?
+
+> `optional` **transferPath**: [`IntermediaryVASP`](IntermediaryVASP.md)[]
+
+Array of intermediary VASPs involved in the transfer
+
+## Defined in
+
+[ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L345)

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

@@ -0,0 +1,16 @@
+[**@notabene/javascript-sdk**](../../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../../modules.md) / [ivms/types](../README.md) / TransliterationMethodCode
+
+# Type Alias: TransliterationMethodCode
+
+> **TransliterationMethodCode**: `"arab"` \| `"aran"` \| `"armn"` \| `"cyrl"` \| `"deva"` \| `"geor"` \| `"grek"` \| `"hani"` \| `"hebr"` \| `"kana"` \| `"kore"` \| `"thai"` \| `"othr"`
+
+Transliteration Method Code
+Specifies the method used to transliterate text
+
+## Defined in
+
+[ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/ivms/types.ts#L71)

package/docs/modules.md

@@ -0,0 +1,11 @@
+[**@notabene/javascript-sdk**](README.md) • **Docs**
+
+***
+
+# @notabene/javascript-sdk
+
+## Modules
+
+- [ivms/types](ivms/types/README.md)
+- [notabene](notabene/README.md)
+- [types](types/README.md)