Merge pull request #675 from nevermined-io/fix/documentation

fix: documentation
nevermined-io · Jun 12, 2024 · 3306fbd · 3306fbd
2 parents 49285bf + 2742beb
commit 3306fbd
Show file tree

Hide file tree

Showing 258 changed files with 27,449 additions and 25,164 deletions.
diff --git a/docs/api-reference/classes/AaveBorrowCondition.md b/docs/api-reference/classes/AaveBorrowCondition.md
diff --git a/docs/api-reference/classes/AaveCollateralDepositCondition.md b/docs/api-reference/classes/AaveCollateralDepositCondition.md
diff --git a/docs/api-reference/classes/AaveCollateralWithdrawCondition.md b/docs/api-reference/classes/AaveCollateralWithdrawCondition.md
diff --git a/docs/api-reference/classes/AaveCredit.md b/docs/api-reference/classes/AaveCredit.md
diff --git a/docs/api-reference/classes/AaveCreditTemplate.md b/docs/api-reference/classes/AaveCreditTemplate.md
diff --git a/docs/api-reference/classes/AaveRepayCondition.md b/docs/api-reference/classes/AaveRepayCondition.md
diff --git a/docs/api-reference/classes/AccessCondition.md b/docs/api-reference/classes/AccessCondition.md
diff --git a/docs/api-reference/classes/AccessService.md b/docs/api-reference/classes/AccessService.md
diff --git a/docs/api-reference/classes/AccessTemplate.md b/docs/api-reference/classes/AccessTemplate.md
diff --git a/docs/api-reference/classes/Account.md b/docs/api-reference/classes/Account.md
diff --git a/docs/api-reference/classes/AccountsApi.md b/docs/api-reference/classes/AccountsApi.md
diff --git a/docs/api-reference/classes/AgreementStoreManager.md b/docs/api-reference/classes/AgreementStoreManager.md
diff --git a/docs/api-reference/classes/AgreementTemplate.md b/docs/api-reference/classes/AgreementTemplate.md
diff --git a/docs/api-reference/classes/AgreementsApi.md b/docs/api-reference/classes/AgreementsApi.md
diff --git a/docs/api-reference/classes/ApiError.md b/docs/api-reference/classes/ApiError.md
@@ -16,6 +16,7 @@
 
 ### Properties
 
+- [cause](ApiError.md#cause)
 - [message](ApiError.md#message)
 - [name](ApiError.md#name)
 - [stack](ApiError.md#stack)
@@ -30,24 +31,42 @@
 
 ### constructor
 
-• **new ApiError**(`message`)
+• **new ApiError**(`message`): [`ApiError`](ApiError.md)
 
 #### Parameters
 
 | Name      | Type     |
 | :-------- | :------- |
 | `message` | `string` |
 
+#### Returns
+
+[`ApiError`](ApiError.md)
+
 #### Overrides
 
 Error.constructor
 
 #### Defined in
 
-[src/errors/ApiError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/ApiError.ts#L2)
+[src/errors/NeverminedErrors.ts:32](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/errors/NeverminedErrors.ts#L32)
 
 ## Properties
 
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:24
+
+---
+
 ### message
 
 • **message**: `string`
@@ -58,7 +77,7 @@ Error.message
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1068
+node_modules/typescript/lib/lib.es5.d.ts:1077
 
 ---
 
@@ -72,7 +91,7 @@ Error.name
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1067
+node_modules/typescript/lib/lib.es5.d.ts:1076
 
 ---
 
@@ -86,20 +105,24 @@ Error.stack
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1069
+node_modules/typescript/lib/lib.es5.d.ts:1078
 
 ---
 
 ### prepareStackTrace
 
 ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
 
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
 #### Type declaration
 
 ▸ (`err`, `stackTraces`): `any`
 
-Optional override for formatting stack traces
-
 ##### Parameters
 
 | Name          | Type         |
@@ -111,17 +134,13 @@ Optional override for formatting stack traces
 
 `any`
 
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
 #### Inherited from
 
 Error.prepareStackTrace
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:11
+node_modules/@types/node/globals.d.ts:28
 
 ---
 
@@ -135,13 +154,13 @@ Error.stackTraceLimit
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:13
+node_modules/@types/node/globals.d.ts:30
 
 ## Methods
 
 ### captureStackTrace
 
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
 
 Create .stack property on a target object
 
@@ -162,4 +181,4 @@ Error.captureStackTrace
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:4
+node_modules/@types/node/globals.d.ts:21
diff --git a/docs/api-reference/classes/AssetAttributes.md b/docs/api-reference/classes/AssetAttributes.md
@@ -24,7 +24,6 @@
 - [predefinedAssetServices](AssetAttributes.md#predefinedassetservices)
 - [providers](AssetAttributes.md#providers)
 - [services](AssetAttributes.md#services)
-- [DEFAULT_ENCRYPTION_METHOD](AssetAttributes.md#default_encryption_method)
 - [defaultValues](AssetAttributes.md#defaultvalues)
 
 ### Methods
@@ -35,7 +34,11 @@
 
 ### constructor
 
-• **new AssetAttributes**()
+• **new AssetAttributes**(): [`AssetAttributes`](AssetAttributes.md)
+
+#### Returns
+
+[`AssetAttributes`](AssetAttributes.md)
 
 ## Properties
 
@@ -48,7 +51,7 @@ That asset association typically helps to search and filter between assets part
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L47)
+[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L48)
 
 ---
 
@@ -65,7 +68,7 @@ This method allows to specify the encryption method to be used.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L20)
+[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L21)
 
 ---
 
@@ -82,7 +85,7 @@ This would allow to create an agreement that can not fulfilled until certain per
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L67)
+[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L68)
 
 ---
 
@@ -99,7 +102,7 @@ This would allow to create an agreement that is not fulfilled after a certain pe
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L57)
+[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L58)
 
 ---
 
@@ -115,7 +118,7 @@ Metadata describing the asset
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L13)
+[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L14)
 
 ---
 
@@ -131,7 +134,7 @@ List of additional asset services to be included as part of an asset
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L32)
+[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L33)
 
 ---
 
@@ -147,7 +150,7 @@ Typically just the address of one Nevermined Node trusted by the user.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L41)
+[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L42)
 
 ---
 
@@ -163,17 +166,7 @@ List of services and their attributes offered by an asset.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L26)
-
----
-
-### DEFAULT_ENCRYPTION_METHOD
-
-▪ `Static` **DEFAULT_ENCRYPTION_METHOD**: [`EncryptionMethod`](../code-reference.md#encryptionmethod)
-
-#### Defined in
-
-[src/models/AssetAttributes.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L7)
+[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L27)
 
 ---
 
@@ -183,25 +176,25 @@ List of services and their attributes offered by an asset.
 
 #### Type declaration
 
-| Name                      | Type                                                                                                            |
-| :------------------------ | :-------------------------------------------------------------------------------------------------------------- |
-| `appId`                   | `string`                                                                                                        |
-| `encryptionMethod`        | [`EncryptionMethod`](../code-reference.md#encryptionmethod)                                                     |
-| `fulfillAccessTimelock`   | `number`                                                                                                        |
-| `fulfillAccessTimeout`    | `number`                                                                                                        |
-| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[]                                                             |
-| `providers`               | `any`[]                                                                                                         |
-| `services`                | { `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] |
+| Name                      | Type                                                                                                             |
+| :------------------------ | :--------------------------------------------------------------------------------------------------------------- |
+| `appId`                   | `string`                                                                                                         |
+| `encryptionMethod`        | [`EncryptionMethod`](../code-reference.md#encryptionmethod)                                                      |
+| `fulfillAccessTimelock`   | `number`                                                                                                         |
+| `fulfillAccessTimeout`    | `number`                                                                                                         |
+| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[]                                                              |
+| `providers`               | `never`[]                                                                                                        |
+| `services`                | \{ `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] |
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L69)
+[src/models/AssetAttributes.ts:70](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L70)
 
 ## Methods
 
 ### getInstance
 
-▸ `Static` **getInstance**(`assetAttributes`): `Required`<[`AssetAttributes`](AssetAttributes.md)\>
+▸ **getInstance**(`assetAttributes`): `Required`\<[`AssetAttributes`](AssetAttributes.md)\>
 
 #### Parameters
 
@@ -211,8 +204,8 @@ List of services and their attributes offered by an asset.
 
 #### Returns
 
-`Required`<[`AssetAttributes`](AssetAttributes.md)\>
+`Required`\<[`AssetAttributes`](AssetAttributes.md)\>
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:84](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L84)
+[src/models/AssetAttributes.ts:85](https://github.com/nevermined-io/sdk-js/blob/49285bf856ebfc8d44ccb08cdf57963ec73b06d6/src/models/AssetAttributes.ts#L85)