fix: docs (#185)

nevermined-io · Jun 13, 2024 · 88f11a2 · 88f11a2
1 parent e36f84c
commit 88f11a2
Show file tree

Hide file tree

Showing 352 changed files with 21,973 additions and 99,415 deletions.
diff --git a/docs/nevermined-sdk/api-reference/classes/AccessCondition.md b/docs/nevermined-sdk/api-reference/classes/AccessCondition.md
diff --git a/docs/nevermined-sdk/api-reference/classes/AccessService.md b/docs/nevermined-sdk/api-reference/classes/AccessService.md
diff --git a/docs/nevermined-sdk/api-reference/classes/AccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/AccessTemplate.md
diff --git a/docs/nevermined-sdk/api-reference/classes/Account.md b/docs/nevermined-sdk/api-reference/classes/Account.md
diff --git a/docs/nevermined-sdk/api-reference/classes/Accounts.md b/docs/nevermined-sdk/api-reference/classes/Accounts.md
diff --git a/docs/nevermined-sdk/api-reference/classes/AccountsApi.md b/docs/nevermined-sdk/api-reference/classes/AccountsApi.md
diff --git a/docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md b/docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md
diff --git a/docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md b/docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md
diff --git a/docs/nevermined-sdk/api-reference/classes/AgreementsApi.md b/docs/nevermined-sdk/api-reference/classes/AgreementsApi.md
diff --git a/docs/nevermined-sdk/api-reference/classes/ApiError.md b/docs/nevermined-sdk/api-reference/classes/ApiError.md
@@ -35,8 +35,8 @@
 
 #### Parameters
 
-| Name      | Type     |
-| :-------- | :------- |
+| Name | Type |
+| :------ | :------ |
 | `message` | `string` |
 
 #### Returns
@@ -49,7 +49,7 @@ Error.constructor
 
 #### Defined in
 
-[src/errors/NeverminedErrors.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L32)
+[src/errors/NeverminedErrors.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L32)
 
 ## Properties
 
@@ -65,7 +65,7 @@ Error.cause
 
 node_modules/typescript/lib/lib.es2022.error.d.ts:24
 
----
+___
 
 ### message
 
@@ -79,7 +79,7 @@ Error.message
 
 node_modules/typescript/lib/lib.es5.d.ts:1077
 
----
+___
 
 ### name
 
@@ -93,7 +93,7 @@ Error.name
 
 node_modules/typescript/lib/lib.es5.d.ts:1076
 
----
+___
 
 ### stack
 
@@ -107,7 +107,7 @@ Error.stack
 
 node_modules/typescript/lib/lib.es5.d.ts:1078
 
----
+___
 
 ### prepareStackTrace
 
@@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 ##### Parameters
 
-| Name          | Type         |
-| :------------ | :----------- |
-| `err`         | `Error`      |
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
 | `stackTraces` | `CallSite`[] |
 
 ##### Returns
@@ -142,7 +142,7 @@ Error.prepareStackTrace
 
 node_modules/@types/node/globals.d.ts:28
 
----
+___
 
 ### stackTraceLimit
 
@@ -166,9 +166,9 @@ Create .stack property on a target object
 
 #### Parameters
 
-| Name              | Type       |
-| :---------------- | :--------- |
-| `targetObject`    | `object`   |
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
 | `constructorOpt?` | `Function` |
 
 #### Returns

diff --git a/docs/nevermined-sdk/api-reference/classes/AssetAttributes.md b/docs/nevermined-sdk/api-reference/classes/AssetAttributes.md
@@ -51,9 +51,9 @@ That asset association typically helps to search and filter between assets part
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L48)
+[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L48)
 
----
+___
 
 ### encryptionMethod
 
@@ -68,9 +68,9 @@ This method allows to specify the encryption method to be used.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L21)
+[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L21)
 
----
+___
 
 ### fulfillAccessTimelock
 
@@ -85,9 +85,9 @@ This would allow to create an agreement that can not fulfilled until certain per
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L68)
+[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L68)
 
----
+___
 
 ### fulfillAccessTimeout
 
@@ -102,9 +102,9 @@ This would allow to create an agreement that is not fulfilled after a certain pe
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L58)
+[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L58)
 
----
+___
 
 ### metadata
 
@@ -118,9 +118,9 @@ Metadata describing the asset
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L14)
+[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L14)
 
----
+___
 
 ### predefinedAssetServices
 
@@ -134,9 +134,9 @@ List of additional asset services to be included as part of an asset
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L33)
+[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L33)
 
----
+___
 
 ### providers
 
@@ -150,9 +150,9 @@ Typically just the address of one Nevermined Node trusted by the user.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L42)
+[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L42)
 
----
+___
 
 ### services
 
@@ -166,29 +166,29 @@ List of services and their attributes offered by an asset.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L27)
+[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L27)
 
----
+___
 
 ### defaultValues
 
 ▪ `Static` **defaultValues**: `Object`
 
 #### Type declaration
 
-| 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) }[] |
+| 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:70](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L70)
+[src/models/AssetAttributes.ts:70](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L70)
 
 ## Methods
 
@@ -198,8 +198,8 @@ List of services and their attributes offered by an asset.
 
 #### Parameters
 
-| Name              | Type                                    |
-| :---------------- | :-------------------------------------- |
+| Name | Type |
+| :------ | :------ |
 | `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) |
 
 #### Returns
@@ -208,4 +208,4 @@ List of services and their attributes offered by an asset.
 
 #### Defined in
 
-[src/models/AssetAttributes.ts:85](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L85)
+[src/models/AssetAttributes.ts:85](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L85)
diff --git a/docs/nevermined-sdk/api-reference/classes/AssetError.md b/docs/nevermined-sdk/api-reference/classes/AssetError.md
@@ -35,8 +35,8 @@
 
 #### Parameters
 
-| Name      | Type     |
-| :-------- | :------- |
+| Name | Type |
+| :------ | :------ |
 | `message` | `string` |
 
 #### Returns
@@ -49,7 +49,7 @@ Error.constructor
 
 #### Defined in
 
-[src/errors/NeverminedErrors.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L56)
+[src/errors/NeverminedErrors.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L56)
 
 ## Properties
 
@@ -65,7 +65,7 @@ Error.cause
 
 node_modules/typescript/lib/lib.es2022.error.d.ts:24
 
----
+___
 
 ### message
 
@@ -79,7 +79,7 @@ Error.message
 
 node_modules/typescript/lib/lib.es5.d.ts:1077
 
----
+___
 
 ### name
 
@@ -93,7 +93,7 @@ Error.name
 
 node_modules/typescript/lib/lib.es5.d.ts:1076
 
----
+___
 
 ### stack
 
@@ -107,7 +107,7 @@ Error.stack
 
 node_modules/typescript/lib/lib.es5.d.ts:1078
 
----
+___
 
 ### prepareStackTrace
 
@@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 ##### Parameters
 
-| Name          | Type         |
-| :------------ | :----------- |
-| `err`         | `Error`      |
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
 | `stackTraces` | `CallSite`[] |
 
 ##### Returns
@@ -142,7 +142,7 @@ Error.prepareStackTrace
 
 node_modules/@types/node/globals.d.ts:28
 
----
+___
 
 ### stackTraceLimit
 
@@ -166,9 +166,9 @@ Create .stack property on a target object
 
 #### Parameters
 
-| Name              | Type       |
-| :---------------- | :--------- |
-| `targetObject`    | `object`   |
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
 | `constructorOpt?` | `Function` |
 
 #### Returns