@notabene/javascript-sdk 2.0.1 → 2.0.3

package/docs/types/interfaces/ConnectionRecord.md

@@ -0,0 +1,111 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ConnectionRecord
+
+# Interface: ConnectionRecord
+
+Interface for recording that user connected their wallet.
+
+## Remarks
+
+- Records which wallet provider was used to connect
+
+The signature proves ownership by demonstrating control of the private keys
+associated with the claimed address.
+
+## See
+
+ - [ProofTypes](../enumerations/ProofTypes.md) For supported signature types
+ - [OwnershipProof](OwnershipProof.md) For base proof properties
+
+## Extends
+
+- [`OwnershipProof`](OwnershipProof.md)
+
+## Properties
+
+### address
+
+> **address**: \`$\{string\}:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`address`](OwnershipProof.md#address)
+
+#### Defined in
+
+[types.ts:1019](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1019)
+
+***
+
+### attestation
+
+> **attestation**: `string`
+
+#### Defined in
+
+[types.ts:1081](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1081)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`did`](OwnershipProof.md#did)
+
+#### Defined in
+
+[types.ts:1018](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1018)
+
+***
+
+### proof
+
+> **proof**: `string`
+
+#### Defined in
+
+[types.ts:1080](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1080)
+
+***
+
+### status
+
+> **status**: [`ProofStatus`](../enumerations/ProofStatus.md)
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`status`](OwnershipProof.md#status)
+
+#### Defined in
+
+[types.ts:1017](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1017)
+
+***
+
+### type
+
+> **type**: [`Connect`](../enumerations/ProofTypes.md#connect)
+
+#### Overrides
+
+[`OwnershipProof`](OwnershipProof.md).[`type`](OwnershipProof.md#type)
+
+#### Defined in
+
+[types.ts:1079](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1079)
+
+***
+
+### wallet\_provider
+
+> **wallet\_provider**: `string`
+
+#### Defined in
+
+[types.ts:1082](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1082)

package/docs/types/interfaces/ConnectionRequest.md

@@ -0,0 +1,51 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ConnectionRequest
+
+# Interface: ConnectionRequest
+
+An object representing a connection request
+
+## Extends
+
+- [`ComponentRequest`](ComponentRequest.md)
+
+## Properties
+
+### asset
+
+> **asset**: `string`
+
+#### Defined in
+
+[types.ts:566](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L566)
+
+***
+
+### customer?
+
+> `optional` **customer**: [`Counterparty`](Counterparty.md)
+
+#### Inherited from
+
+[`ComponentRequest`](ComponentRequest.md).[`customer`](ComponentRequest.md#customer)
+
+#### Defined in
+
+[types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L495)
+
+***
+
+### requestId?
+
+> `optional` **requestId**: `string`
+
+#### Inherited from
+
+[`ComponentRequest`](ComponentRequest.md).[`requestId`](ComponentRequest.md#requestid)
+
+#### Defined in
+
+[types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L494)

package/docs/types/interfaces/Counterparty.md

@@ -0,0 +1,135 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Counterparty
+
+# Interface: Counterparty
+
+Interface representing a party involved in a transaction other than the initiator
+
+## Remarks
+
+fines the core properties that identify and describe a counterparty:
+- name: The display or legal name of the counterparty
+- accountNumber: An account identifier/reference number
+- did: Decentralized identifier for the counterparty
+- type: Classification as natural person, legal entity, or self
+- verified: Whether the counterparty's identity has been verified
+- geographicAddress: Physical/mailing address information
+- nationalIdentification: Government-issued ID details
+- website: Official web presence
+- phone: Contact phone number
+- email: Contact email address
+
+This interface serves as the base for more specific counterparty types:
+
+## See
+
+ - [NaturalPerson](NaturalPerson.md) For individual person properties
+ - [LegalPerson](LegalPerson.md) For organization/entity properties
+
+## Extended by
+
+- [`NaturalPerson`](NaturalPerson.md)
+- [`LegalPerson`](LegalPerson.md)
+
+## Properties
+
+### accountNumber?
+
+> `optional` **accountNumber**: `string`
+
+#### Defined in
+
+[types.ts:341](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L341)
+
+***
+
+### did?
+
+> `optional` **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Defined in
+
+[types.ts:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L342)
+
+***
+
+### email?
+
+> `optional` **email**: `string`
+
+#### Defined in
+
+[types.ts:349](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L349)
+
+***
+
+### geographicAddress?
+
+> `optional` **geographicAddress**: [`Address`](../../ivms/types/type-aliases/Address.md)
+
+#### Defined in
+
+[types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L345)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+#### Defined in
+
+[types.ts:340](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L340)
+
+***
+
+### nationalIdentification?
+
+> `optional` **nationalIdentification**: [`NationalIdentification`](../../ivms/types/type-aliases/NationalIdentification.md)
+
+#### Defined in
+
+[types.ts:346](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L346)
+
+***
+
+### phone?
+
+> `optional` **phone**: `string`
+
+#### Defined in
+
+[types.ts:348](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L348)
+
+***
+
+### type?
+
+> `optional` **type**: [`PersonType`](../enumerations/PersonType.md)
+
+#### Defined in
+
+[types.ts:343](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L343)
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+#### Defined in
+
+[types.ts:344](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L344)
+
+***
+
+### website?
+
+> `optional` **website**: `string`
+
+#### Defined in
+
+[types.ts:347](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L347)

package/docs/types/interfaces/DeclarationProof.md

@@ -0,0 +1,89 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / DeclarationProof
+
+# Interface: DeclarationProof
+
+Ownership Proof using Self Declaration
+
+## Extends
+
+- [`OwnershipProof`](OwnershipProof.md)
+
+## Properties
+
+### address
+
+> **address**: \`$\{string\}:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`address`](OwnershipProof.md#address)
+
+#### Defined in
+
+[types.ts:1019](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1019)
+
+***
+
+### attestation
+
+> **attestation**: `string`
+
+#### Defined in
+
+[types.ts:1061](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1061)
+
+***
+
+### confirmed
+
+> **confirmed**: `boolean`
+
+#### Defined in
+
+[types.ts:1062](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1062)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`did`](OwnershipProof.md#did)
+
+#### Defined in
+
+[types.ts:1018](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1018)
+
+***
+
+### status
+
+> **status**: [`ProofStatus`](../enumerations/ProofStatus.md)
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`status`](OwnershipProof.md#status)
+
+#### Defined in
+
+[types.ts:1017](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1017)
+
+***
+
+### type
+
+> **type**: [`SelfDeclaration`](../enumerations/ProofTypes.md#selfdeclaration)
+
+#### Overrides
+
+[`OwnershipProof`](OwnershipProof.md).[`type`](OwnershipProof.md#type)
+
+#### Defined in
+
+[types.ts:1060](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1060)

package/docs/types/interfaces/Deposit.md

@@ -0,0 +1,147 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Deposit
+
+# Interface: Deposit
+
+An object representing a deposit transaction
+
+## Extends
+
+- `OriginatorFields`.[`Transaction`](Transaction.md)
+
+## Properties
+
+### agent
+
+> **agent**: [`Agent`](Agent.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`agent`](Transaction.md#agent)
+
+#### Defined in
+
+[types.ts:522](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L522)
+
+***
+
+### amountDecimal
+
+> **amountDecimal**: `number`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`amountDecimal`](Transaction.md#amountdecimal)
+
+#### Defined in
+
+[types.ts:525](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L525)
+
+***
+
+### asset
+
+> **asset**: `string`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`asset`](Transaction.md#asset)
+
+#### Defined in
+
+[types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L524)
+
+***
+
+### assetPrice?
+
+> `optional` **assetPrice**: `object`
+
+#### currency
+
+> **currency**: `string`
+
+#### price
+
+> **price**: `number`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`assetPrice`](Transaction.md#assetprice)
+
+#### Defined in
+
+[types.ts:527](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L527)
+
+***
+
+### counterparty
+
+> **counterparty**: [`Counterparty`](Counterparty.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`counterparty`](Transaction.md#counterparty)
+
+#### Defined in
+
+[types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L523)
+
+***
+
+### customer?
+
+> `optional` **customer**: [`Counterparty`](Counterparty.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`customer`](Transaction.md#customer)
+
+#### Defined in
+
+[types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L495)
+
+***
+
+### proof?
+
+> `optional` **proof**: [`OwnershipProof`](OwnershipProof.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`proof`](Transaction.md#proof)
+
+#### Defined in
+
+[types.ts:526](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L526)
+
+***
+
+### requestId?
+
+> `optional` **requestId**: `string`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`requestId`](Transaction.md#requestid)
+
+#### Defined in
+
+[types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L494)
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+#### Inherited from
+
+`OriginatorFields.source`
+
+#### Defined in
+
+[types.ts:452](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L452)

package/docs/types/interfaces/DepositRequest.md

@@ -0,0 +1,111 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / DepositRequest
+
+# Interface: DepositRequest
+
+An object representing a request for a deposit
+
+## Extends
+
+- `DepositRequestFields`.[`ComponentRequest`](ComponentRequest.md)
+
+## Properties
+
+### amountDecimal?
+
+> `optional` **amountDecimal**: `number`
+
+#### Inherited from
+
+`DepositRequestFields.amountDecimal`
+
+#### Defined in
+
+[types.ts:470](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L470)
+
+***
+
+### asset
+
+> **asset**: `string`
+
+#### Inherited from
+
+`DepositRequestFields.asset`
+
+#### Defined in
+
+[types.ts:469](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L469)
+
+***
+
+### cryptoCredential?
+
+> `optional` **cryptoCredential**: \`$\{string\}.$\{string\}.mastercard\`
+
+#### Inherited from
+
+`DepositRequestFields.cryptoCredential`
+
+#### Defined in
+
+[types.ts:472](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L472)
+
+***
+
+### customer?
+
+> `optional` **customer**: [`Counterparty`](Counterparty.md)
+
+#### Inherited from
+
+[`ComponentRequest`](ComponentRequest.md).[`customer`](ComponentRequest.md#customer)
+
+#### Defined in
+
+[types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L495)
+
+***
+
+### destination
+
+> **destination**: `string`
+
+#### Inherited from
+
+`DepositRequestFields.destination`
+
+#### Defined in
+
+[types.ts:468](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L468)
+
+***
+
+### requestId?
+
+> `optional` **requestId**: `string`
+
+#### Inherited from
+
+[`ComponentRequest`](ComponentRequest.md).[`requestId`](ComponentRequest.md#requestid)
+
+#### Defined in
+
+[types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L494)
+
+***
+
+### travelAddress?
+
+> `optional` **travelAddress**: \`ta$\{string\}\`
+
+#### Inherited from
+
+`DepositRequestFields.travelAddress`
+
+#### Defined in
+
+[types.ts:471](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L471)

package/docs/types/interfaces/DepositRequestOptions.md

@@ -0,0 +1,19 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / DepositRequestOptions
+
+# Interface: DepositRequestOptions
+
+An object representing options for a Deposit Request
+
+## Properties
+
+### showQrCode?
+
+> `optional` **showQrCode**: `boolean`
+
+#### Defined in
+
+[types.ts:558](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L558)