Merge pull request #600 from nevermined-io/fix/documentation-build

fix: docs build

docs/api-reference/classes/ApiError.md

@@ -0,0 +1,165 @@
+[@nevermined-io/sdk](../code-reference.md) / ApiError
+
+# Class: ApiError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`ApiError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ApiError.md#constructor)
+
+### Properties
+
+- [message](ApiError.md#message)
+- [name](ApiError.md#name)
+- [stack](ApiError.md#stack)
+- [prepareStackTrace](ApiError.md#preparestacktrace)
+- [stackTraceLimit](ApiError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](ApiError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new ApiError**(`message`)
+
+#### Parameters
+
+| Name      | Type     |
+| :-------- | :------- |
+| `message` | `string` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[src/errors/ApiError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/ApiError.ts#L2)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1068
+
+---
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1067
+
+---
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1069
+
+---
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+##### Parameters
+
+| Name          | Type         |
+| :------------ | :----------- |
+| `err`         | `Error`      |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`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
+
+---
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name              | Type       |
+| :---------------- | :--------- |
+| `targetObject`    | `object`   |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

docs/api-reference/classes/AssetAttributes.md

@@ -0,0 +1,218 @@
+[@nevermined-io/sdk](../code-reference.md) / AssetAttributes
+
+# Class: AssetAttributes
+
+## Hierarchy
+
+- **`AssetAttributes`**
+
+  ↳ [`NFTAttributes`](NFTAttributes.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](AssetAttributes.md#constructor)
+
+### Properties
+
+- [appId](AssetAttributes.md#appid)
+- [encryptionMethod](AssetAttributes.md#encryptionmethod)
+- [fulfillAccessTimelock](AssetAttributes.md#fulfillaccesstimelock)
+- [fulfillAccessTimeout](AssetAttributes.md#fulfillaccesstimeout)
+- [metadata](AssetAttributes.md#metadata)
+- [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
+
+- [getInstance](AssetAttributes.md#getinstance)
+
+## Constructors
+
+### constructor
+
+• **new AssetAttributes**()
+
+## Properties
+
+### appId
+
+• `Optional` **appId**: `string`
+
+Unique identifier of the application/domain/vertical where the asset belong to.
+That asset association typically helps to search and filter between assets part of a domain via Marketplace API
+
+#### Defined in
+
+[src/models/AssetAttributes.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L47)
+
+---
+
+### encryptionMethod
+
+• `Optional` **encryptionMethod**: [`EncryptionMethod`](../code-reference.md#encryptionmethod)
+
+When an asset is published in a Nevermined network, some internal Metadata attributes are encrypted so they can't be accessed.
+This method allows to specify the encryption method to be used.
+
+**`See`**
+
+[EncryptionMethod](../code-reference.md#encryptionmethod)
+
+#### Defined in
+
+[src/models/AssetAttributes.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L20)
+
+---
+
+### fulfillAccessTimelock
+
+• `Optional` **fulfillAccessTimelock**: `number`
+
+An asset can offer different services. Each service can have different conditions that need to be fulfilled
+to provide that service. These conditions can expire if they are not fulfilled in a certain period of time.
+This attribute allows to specify a period of time the condition can not be fullfilled
+Setting up a timelock of 0 means that the condition can be fulfilled at any time.
+Setting a timelock greater than 0 means that the condition can not be fulfilled until that number of blocks after the agreement is created are mined.
+This would allow to create an agreement that can not fulfilled until certain period of time.
+
+#### Defined in
+
+[src/models/AssetAttributes.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L67)
+
+---
+
+### fulfillAccessTimeout
+
+• `Optional` **fulfillAccessTimeout**: `number`
+
+An asset can offer different services. Each service can have different conditions that need to be fulfilled
+to provide that service. These conditions can expire if they are not fulfilled in a certain period of time.
+This attribute allows to specify the timeouts for the access condition associated to the service.
+Setting up a timeout of 0 means that the condition will never expire.
+Setting a timeout greater than 0 means that the condition will expire after that number of blocks after the agreement is created.
+This would allow to create an agreement that is not fulfilled after a certain period of time, the user can claim back funds locked if the condition is any.
+
+#### Defined in
+
+[src/models/AssetAttributes.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L57)
+
+---
+
+### metadata
+
+• **metadata**: [`MetaData`](../interfaces/MetaData.md)
+
+Metadata describing the asset
+
+**`See`**
+
+[MetaData](../interfaces/MetaData.md)
+
+#### Defined in
+
+[src/models/AssetAttributes.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L13)
+
+---
+
+### predefinedAssetServices
+
+• `Optional` **predefinedAssetServices**: [`ServiceCommon`](../interfaces/ServiceCommon.md)[]
+
+List of additional asset services to be included as part of an asset
+
+**`See`**
+
+[Service](../code-reference.md#service)
+
+#### Defined in
+
+[src/models/AssetAttributes.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L32)
+
+---
+
+### providers
+
+• `Optional` **providers**: `string`[]
+
+A provider of an asset identify the public address of an account with some privileges over that asset.
+Typically these permissions are granted to Nevermined Nodes to allow them to give access to some services without
+the direct interaction of the final user.
+Here a user publishing an asset can define a list of all the addresses with these permissions.
+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)
+
+---
+
+### services
+
+• `Optional` **services**: [`ServiceAttributes`](../interfaces/ServiceAttributes.md)[]
+
+List of services and their attributes offered by an asset.
+
+**`See`**
+
+[ServiceAttributes](../interfaces/ServiceAttributes.md)
+
+#### 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)
+
+---
+
+### 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`               | `any`[]                                                                                                         |
+| `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)
+
+## Methods
+
+### getInstance
+
+▸ `Static` **getInstance**(`assetAttributes`): `Required`<[`AssetAttributes`](AssetAttributes.md)\>
+
+#### Parameters
+
+| Name              | Type                                    |
+| :---------------- | :-------------------------------------- |
+| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) |
+
+#### Returns
+
+`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)