Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: docs #185

Merged
merged 2 commits into from
Jun 13, 2024
Merged

fix: docs #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6cef56
fix: docs
eruizgar91 Jun 13, 2024
c7c1f88
fix: docs
eruizgar91 Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
586 changes: 293 additions & 293 deletions docs/nevermined-sdk/api-reference/classes/AccessCondition.md
View file
Open in desktop

Large diffs are not rendered by default.

322 changes: 161 additions & 161 deletions docs/nevermined-sdk/api-reference/classes/AccessService.md
View file
Open in desktop

Large diffs are not rendered by default.

782 changes: 391 additions & 391 deletions docs/nevermined-sdk/api-reference/classes/AccessTemplate.md
View file
Open in desktop

Large diffs are not rendered by default.

700 changes: 0 additions & 700 deletions docs/nevermined-sdk/api-reference/classes/Account.md
View file
Open in desktop

This file was deleted.

489 changes: 0 additions & 489 deletions docs/nevermined-sdk/api-reference/classes/Accounts.md
View file
Open in desktop

This file was deleted.

370 changes: 185 additions & 185 deletions docs/nevermined-sdk/api-reference/classes/AccountsApi.md
View file
Open in desktop

Large diffs are not rendered by default.

454 changes: 227 additions & 227 deletions docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md
View file
Open in desktop

Large diffs are not rendered by default.

670 changes: 335 additions & 335 deletions docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md
View file
Open in desktop

Large diffs are not rendered by default.

344 changes: 172 additions & 172 deletions docs/nevermined-sdk/api-reference/classes/AgreementsApi.md
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/nevermined-sdk/api-reference/classes/ApiError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@

#### Parameters

| Name | Type |
| :-------- | :------- |
| Name | Type |
| :------ | :------ |
| `message` | `string` |

#### Returns
Expand All @@ -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

Expand All @@ -65,7 +65,7 @@ Error.cause

node_modules/typescript/lib/lib.es2022.error.d.ts:24

---
___

### message

Expand All @@ -79,7 +79,7 @@ Error.message

node_modules/typescript/lib/lib.es5.d.ts:1077

---
___

### name

Expand All @@ -93,7 +93,7 @@ Error.name

node_modules/typescript/lib/lib.es5.d.ts:1076

---
___

### stack

Expand All @@ -107,7 +107,7 @@ Error.stack

node_modules/typescript/lib/lib.es5.d.ts:1078

---
___

### prepareStackTrace

Expand All @@ -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
Expand All @@ -142,7 +142,7 @@ Error.prepareStackTrace

node_modules/@types/node/globals.d.ts:28

---
___

### stackTraceLimit

Expand All @@ -166,9 +166,9 @@ Create .stack property on a target object

#### Parameters

| Name | Type |
| :---------------- | :--------- |
| `targetObject` | `object` |
| Name | Type |
| :------ | :------ |
| `targetObject` | `object` |
| `constructorOpt?` | `Function` |

#### Returns
Expand Down
58 changes: 29 additions & 29 deletions docs/nevermined-sdk/api-reference/classes/AssetAttributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -198,8 +198,8 @@ List of services and their attributes offered by an asset.

#### Parameters

| Name | Type |
| :---------------- | :-------------------------------------- |
| Name | Type |
| :------ | :------ |
| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) |

#### Returns
Expand All @@ -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)
28 changes: 14 additions & 14 deletions docs/nevermined-sdk/api-reference/classes/AssetError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@

#### Parameters

| Name | Type |
| :-------- | :------- |
| Name | Type |
| :------ | :------ |
| `message` | `string` |

#### Returns
Expand All @@ -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

Expand All @@ -65,7 +65,7 @@ Error.cause

node_modules/typescript/lib/lib.es2022.error.d.ts:24

---
___

### message

Expand All @@ -79,7 +79,7 @@ Error.message

node_modules/typescript/lib/lib.es5.d.ts:1077

---
___

### name

Expand All @@ -93,7 +93,7 @@ Error.name

node_modules/typescript/lib/lib.es5.d.ts:1076

---
___

### stack

Expand All @@ -107,7 +107,7 @@ Error.stack

node_modules/typescript/lib/lib.es5.d.ts:1078

---
___

### prepareStackTrace

Expand All @@ -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
Expand All @@ -142,7 +142,7 @@ Error.prepareStackTrace

node_modules/@types/node/globals.d.ts:28

---
___

### stackTraceLimit

Expand All @@ -166,9 +166,9 @@ Create .stack property on a target object

#### Parameters

| Name | Type |
| :---------------- | :--------- |
| `targetObject` | `object` |
| Name | Type |
| :------ | :------ |
| `targetObject` | `object` |
| `constructorOpt?` | `Function` |

#### Returns
Expand Down
Loading
Loading