Class SchemaApi

Hierarchy

BaseAPI
- SchemaApi

Index

Constructors

Properties

Methods

request schemasCreatedGet schemasCreatedGetRaw schemasPost schemasPostRaw schemasSchemaIdGet schemasSchemaIdGetRaw schemasSchemaIdWriteRecordPost schemasSchemaIdWriteRecordPostRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

`Protected` request

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

schemasCreatedGet

schemasCreatedGet(requestParameters): Promise<SchemasCreatedResult>
Search for matching schema that agent originated
Parameters
- requestParameters: SchemasCreatedGetRequest
Returns Promise<SchemasCreatedResult>
- Defined in client/apis/SchemaApi.ts:95

schemasCreatedGetRaw

schemasCreatedGetRaw(requestParameters): Promise<ApiResponse<SchemasCreatedResult>>
Search for matching schema that agent originated
Parameters
- requestParameters: SchemasCreatedGetRequest
Returns Promise<ApiResponse<SchemasCreatedResult>>
- Defined in client/apis/SchemaApi.ts:57

schemasPost

schemasPost(requestParameters): Promise<TxnOrSchemaSendResult>
Sends a schema to the ledger
Parameters
- requestParameters: SchemasPostRequest
Returns Promise<TxnOrSchemaSendResult>
- Defined in client/apis/SchemaApi.ts:139

schemasPostRaw

schemasPostRaw(requestParameters): Promise<ApiResponse<TxnOrSchemaSendResult>>
Sends a schema to the ledger
Parameters
- requestParameters: SchemasPostRequest
Returns Promise<ApiResponse<TxnOrSchemaSendResult>>
- Defined in client/apis/SchemaApi.ts:105

schemasSchemaIdGet

schemasSchemaIdGet(requestParameters): Promise<SchemaGetResult>
Gets a schema from the ledger
Parameters
- requestParameters: SchemasSchemaIdGetRequest
Returns Promise<SchemaGetResult>
- Defined in client/apis/SchemaApi.ts:184

schemasSchemaIdGetRaw

schemasSchemaIdGetRaw(requestParameters): Promise<ApiResponse<SchemaGetResult>>
Gets a schema from the ledger
Parameters
- requestParameters: SchemasSchemaIdGetRequest
Returns Promise<ApiResponse<SchemaGetResult>>
- Defined in client/apis/SchemaApi.ts:149

schemasSchemaIdWriteRecordPost

schemasSchemaIdWriteRecordPost(requestParameters): Promise<SchemaGetResult>
Writes a schema non-secret record to the wallet
Parameters
- requestParameters: SchemasSchemaIdWriteRecordPostRequest
Returns Promise<SchemaGetResult>
- Defined in client/apis/SchemaApi.ts:229

schemasSchemaIdWriteRecordPostRaw

schemasSchemaIdWriteRecordPostRaw(requestParameters): Promise<ApiResponse<SchemaGetResult>>
Writes a schema non-secret record to the wallet
Parameters
- requestParameters: SchemasSchemaIdWriteRecordPostRequest
Returns Promise<ApiResponse<SchemaGetResult>>
- Defined in client/apis/SchemaApi.ts:194

withMiddleware

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

withPostMiddleware

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

withPreMiddleware

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

Generated using TypeDoc