Class MediationApi

Hierarchy

BaseAPI
- MediationApi

Index

Constructors

Properties

Methods

mediationDefaultMediatorDelete mediationDefaultMediatorDeleteRaw mediationDefaultMediatorGet mediationDefaultMediatorGetRaw mediationKeylistsGet mediationKeylistsGetRaw mediationKeylistsMediationIdSendKeylistQueryPost mediationKeylistsMediationIdSendKeylistQueryPostRaw mediationKeylistsMediationIdSendKeylistUpdatePost mediationKeylistsMediationIdSendKeylistUpdatePostRaw mediationMediationIdDefaultMediatorPut mediationMediationIdDefaultMediatorPutRaw mediationRequestConnIdPost mediationRequestConnIdPostRaw mediationRequestsGet mediationRequestsGetRaw mediationRequestsMediationIdDelete mediationRequestsMediationIdDeleteRaw mediationRequestsMediationIdDenyPost mediationRequestsMediationIdDenyPostRaw mediationRequestsMediationIdGet mediationRequestsMediationIdGetRaw mediationRequestsMediationIdGrantPost mediationRequestsMediationIdGrantPostRaw mediationUpdateKeylistConnIdPost mediationUpdateKeylistConnIdPostRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

mediationDefaultMediatorDelete

mediationDefaultMediatorDelete(): Promise<MediationRecord>
Clear default mediator

Returns Promise<MediationRecord>
- Defined in client/apis/MediationApi.ts:129

mediationDefaultMediatorDeleteRaw

mediationDefaultMediatorDeleteRaw(): Promise<ApiResponse<MediationRecord>>
Clear default mediator

Returns Promise<ApiResponse<MediationRecord>>
- Defined in client/apis/MediationApi.ts:107

mediationDefaultMediatorGet

mediationDefaultMediatorGet(): Promise<MediationRecord>
Get default mediator

Returns Promise<MediationRecord>
- Defined in client/apis/MediationApi.ts:159

mediationDefaultMediatorGetRaw

mediationDefaultMediatorGetRaw(): Promise<ApiResponse<MediationRecord>>
Get default mediator

Returns Promise<ApiResponse<MediationRecord>>
- Defined in client/apis/MediationApi.ts:137

mediationKeylistsGet

mediationKeylistsGet(requestParameters): Promise<Keylist>
Retrieve keylists by connection or role
Parameters
- requestParameters: MediationKeylistsGetRequest
Returns Promise<Keylist>
- Defined in client/apis/MediationApi.ts:197

mediationKeylistsGetRaw

mediationKeylistsGetRaw(requestParameters): Promise<ApiResponse<Keylist>>
Retrieve keylists by connection or role
Parameters
- requestParameters: MediationKeylistsGetRequest
Returns Promise<ApiResponse<Keylist>>
- Defined in client/apis/MediationApi.ts:167

mediationKeylistsMediationIdSendKeylistQueryPost

mediationKeylistsMediationIdSendKeylistQueryPost(requestParameters): Promise<KeylistQuery>
Send keylist query to mediator
Parameters
- requestParameters: MediationKeylistsMediationIdSendKeylistQueryPostRequest
Returns Promise<KeylistQuery>
- Defined in client/apis/MediationApi.ts:253

mediationKeylistsMediationIdSendKeylistQueryPostRaw

mediationKeylistsMediationIdSendKeylistQueryPostRaw(requestParameters): Promise<ApiResponse<KeylistQuery>>
Send keylist query to mediator
Parameters
- requestParameters: MediationKeylistsMediationIdSendKeylistQueryPostRequest
Returns Promise<ApiResponse<KeylistQuery>>
- Defined in client/apis/MediationApi.ts:207

mediationKeylistsMediationIdSendKeylistUpdatePost

mediationKeylistsMediationIdSendKeylistUpdatePost(requestParameters): Promise<KeylistUpdate>
Send keylist update to mediator
Parameters
- requestParameters: MediationKeylistsMediationIdSendKeylistUpdatePostRequest
Returns Promise<KeylistUpdate>
- Defined in client/apis/MediationApi.ts:304

mediationKeylistsMediationIdSendKeylistUpdatePostRaw

mediationKeylistsMediationIdSendKeylistUpdatePostRaw(requestParameters): Promise<ApiResponse<KeylistUpdate>>
Send keylist update to mediator
Parameters
- requestParameters: MediationKeylistsMediationIdSendKeylistUpdatePostRequest
Returns Promise<ApiResponse<KeylistUpdate>>
- Defined in client/apis/MediationApi.ts:266

mediationMediationIdDefaultMediatorPut

mediationMediationIdDefaultMediatorPut(requestParameters): Promise<MediationRecord>
Set default mediator
Parameters
- requestParameters: MediationMediationIdDefaultMediatorPutRequest
Returns Promise<MediationRecord>
- Defined in client/apis/MediationApi.ts:352

mediationMediationIdDefaultMediatorPutRaw

mediationMediationIdDefaultMediatorPutRaw(requestParameters): Promise<ApiResponse<MediationRecord>>
Set default mediator
Parameters
- requestParameters: MediationMediationIdDefaultMediatorPutRequest
Returns Promise<ApiResponse<MediationRecord>>
- Defined in client/apis/MediationApi.ts:317

mediationRequestConnIdPost

mediationRequestConnIdPost(requestParameters): Promise<MediationRecord>
Request mediation from connection
Parameters
- requestParameters: MediationRequestConnIdPostRequest
Returns Promise<MediationRecord>
- Defined in client/apis/MediationApi.ts:402

mediationRequestConnIdPostRaw

mediationRequestConnIdPostRaw(requestParameters): Promise<ApiResponse<MediationRecord>>
Request mediation from connection
Parameters
- requestParameters: MediationRequestConnIdPostRequest
Returns Promise<ApiResponse<MediationRecord>>
- Defined in client/apis/MediationApi.ts:364

mediationRequestsGet

mediationRequestsGet(requestParameters): Promise<MediationList>
Query mediation requests, returns list of all mediation records
Parameters
- requestParameters: MediationRequestsGetRequest
Returns Promise<MediationList>
- Defined in client/apis/MediationApi.ts:444

mediationRequestsGetRaw

mediationRequestsGetRaw(requestParameters): Promise<ApiResponse<MediationList>>
Query mediation requests, returns list of all mediation records
Parameters
- requestParameters: MediationRequestsGetRequest
Returns Promise<ApiResponse<MediationList>>
- Defined in client/apis/MediationApi.ts:414

mediationRequestsMediationIdDelete

mediationRequestsMediationIdDelete(requestParameters): Promise<MediationRecord>
Delete mediation request by ID
Parameters
- requestParameters: MediationRequestsMediationIdDeleteRequest
Returns Promise<MediationRecord>
- Defined in client/apis/MediationApi.ts:489

mediationRequestsMediationIdDeleteRaw

mediationRequestsMediationIdDeleteRaw(requestParameters): Promise<ApiResponse<MediationRecord>>
Delete mediation request by ID
Parameters
- requestParameters: MediationRequestsMediationIdDeleteRequest
Returns Promise<ApiResponse<MediationRecord>>
- Defined in client/apis/MediationApi.ts:454

mediationRequestsMediationIdDenyPost

mediationRequestsMediationIdDenyPost(requestParameters): Promise<MediationDeny>
Deny a stored mediation request
Parameters
- requestParameters: MediationRequestsMediationIdDenyPostRequest
Returns Promise<MediationDeny>
- Defined in client/apis/MediationApi.ts:539

mediationRequestsMediationIdDenyPostRaw

mediationRequestsMediationIdDenyPostRaw(requestParameters): Promise<ApiResponse<MediationDeny>>
Deny a stored mediation request
Parameters
- requestParameters: MediationRequestsMediationIdDenyPostRequest
Returns Promise<ApiResponse<MediationDeny>>
- Defined in client/apis/MediationApi.ts:501

mediationRequestsMediationIdGet

mediationRequestsMediationIdGet(requestParameters): Promise<MediationRecord>
Retrieve mediation request record
Parameters
- requestParameters: MediationRequestsMediationIdGetRequest
Returns Promise<MediationRecord>
- Defined in client/apis/MediationApi.ts:586

mediationRequestsMediationIdGetRaw

mediationRequestsMediationIdGetRaw(requestParameters): Promise<ApiResponse<MediationRecord>>
Retrieve mediation request record
Parameters
- requestParameters: MediationRequestsMediationIdGetRequest
Returns Promise<ApiResponse<MediationRecord>>
- Defined in client/apis/MediationApi.ts:551

mediationRequestsMediationIdGrantPost

mediationRequestsMediationIdGrantPost(requestParameters): Promise<MediationGrant>
Grant received mediation
Parameters
- requestParameters: MediationRequestsMediationIdGrantPostRequest
Returns Promise<MediationGrant>
- Defined in client/apis/MediationApi.ts:633

mediationRequestsMediationIdGrantPostRaw

mediationRequestsMediationIdGrantPostRaw(requestParameters): Promise<ApiResponse<MediationGrant>>
Grant received mediation
Parameters
- requestParameters: MediationRequestsMediationIdGrantPostRequest
Returns Promise<ApiResponse<MediationGrant>>
- Defined in client/apis/MediationApi.ts:598

mediationUpdateKeylistConnIdPost

mediationUpdateKeylistConnIdPost(requestParameters): Promise<KeylistUpdate>
Update keylist for a connection
Parameters
- requestParameters: MediationUpdateKeylistConnIdPostRequest
Returns Promise<KeylistUpdate>
- Defined in client/apis/MediationApi.ts:683

mediationUpdateKeylistConnIdPostRaw

mediationUpdateKeylistConnIdPostRaw(requestParameters): Promise<ApiResponse<KeylistUpdate>>
Update keylist for a connection
Parameters
- requestParameters: MediationUpdateKeylistConnIdPostRequest
Returns Promise<ApiResponse<KeylistUpdate>>
- Defined in client/apis/MediationApi.ts:645

`Protected` request

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

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