Class SchemaApi

Hierarchy

BaseAPI
- SchemaApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new SchemaApi(configuration?: Configuration): SchemaApi

Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24
Parameters
- configuration: Configuration = ...
Returns SchemaApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from BaseAPI.request
- Defined in client/runtime.ts:50
Parameters
- context: RequestOpts
Returns Promise<Response>

schemasCreatedGet

schemasCreatedGet(requestParameters: SchemasCreatedGetRequest): Promise<SchemasCreatedResult>

- Defined in client/apis/SchemaApi.ts:95
Search for matching schema that agent originated

Parameters
- requestParameters: SchemasCreatedGetRequest
Returns Promise<SchemasCreatedResult>

schemasCreatedGetRaw

schemasCreatedGetRaw(requestParameters: SchemasCreatedGetRequest): Promise<ApiResponse<SchemasCreatedResult>>

- Defined in client/apis/SchemaApi.ts:57
Search for matching schema that agent originated

Parameters
- requestParameters: SchemasCreatedGetRequest
Returns Promise<ApiResponse<SchemasCreatedResult>>

schemasPost

schemasPost(requestParameters: SchemasPostRequest): Promise<TxnOrSchemaSendResult>

- Defined in client/apis/SchemaApi.ts:139
Sends a schema to the ledger

Parameters
- requestParameters: SchemasPostRequest
Returns Promise<TxnOrSchemaSendResult>

schemasPostRaw

schemasPostRaw(requestParameters: SchemasPostRequest): Promise<ApiResponse<TxnOrSchemaSendResult>>

- Defined in client/apis/SchemaApi.ts:105
Sends a schema to the ledger

Parameters
- requestParameters: SchemasPostRequest
Returns Promise<ApiResponse<TxnOrSchemaSendResult>>

schemasSchemaIdGet

schemasSchemaIdGet(requestParameters: SchemasSchemaIdGetRequest): Promise<SchemaGetResult>

- Defined in client/apis/SchemaApi.ts:184
Gets a schema from the ledger

Parameters
- requestParameters: SchemasSchemaIdGetRequest
Returns Promise<SchemaGetResult>

schemasSchemaIdGetRaw

schemasSchemaIdGetRaw(requestParameters: SchemasSchemaIdGetRequest): Promise<ApiResponse<SchemaGetResult>>

- Defined in client/apis/SchemaApi.ts:149
Gets a schema from the ledger

Parameters
- requestParameters: SchemasSchemaIdGetRequest
Returns Promise<ApiResponse<SchemaGetResult>>

schemasSchemaIdWriteRecordPost

schemasSchemaIdWriteRecordPost(requestParameters: SchemasSchemaIdWriteRecordPostRequest): Promise<SchemaGetResult>

- Defined in client/apis/SchemaApi.ts:229
Writes a schema non-secret record to the wallet

Parameters
- requestParameters: SchemasSchemaIdWriteRecordPostRequest
Returns Promise<SchemaGetResult>

schemasSchemaIdWriteRecordPostRaw

schemasSchemaIdWriteRecordPostRaw(requestParameters: SchemasSchemaIdWriteRecordPostRequest): Promise<ApiResponse<SchemaGetResult>>

- Defined in client/apis/SchemaApi.ts:194
Writes a schema non-secret record to the wallet

Parameters
- requestParameters: SchemasSchemaIdWriteRecordPostRequest
Returns Promise<ApiResponse<SchemaGetResult>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T

Generated using TypeDoc