Class ConnectionApi

Hierarchy

BaseAPI
- ConnectionApi

Index

Constructors

constructor

new ConnectionApi(configuration?: Configuration): ConnectionApi

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

Properties

Protected configuration

configuration: Configuration = ...

Methods

connectionsConnIdAcceptInvitationPost

connectionsConnIdAcceptInvitationPost(requestParameters: ConnectionsConnIdAcceptInvitationPostRequest): Promise<ConnRecord>

- Defined in client/apis/ConnectionApi.ts:171
Accept a stored connection invitation

Parameters
- requestParameters: ConnectionsConnIdAcceptInvitationPostRequest
Returns Promise<ConnRecord>

connectionsConnIdAcceptInvitationPostRaw

connectionsConnIdAcceptInvitationPostRaw(requestParameters: ConnectionsConnIdAcceptInvitationPostRequest): Promise<ApiResponse<ConnRecord>>

- Defined in client/apis/ConnectionApi.ts:124
Accept a stored connection invitation

Parameters
- requestParameters: ConnectionsConnIdAcceptInvitationPostRequest
Returns Promise<ApiResponse<ConnRecord>>

connectionsConnIdAcceptRequestPost

connectionsConnIdAcceptRequestPost(requestParameters: ConnectionsConnIdAcceptRequestPostRequest): Promise<ConnRecord>

- Defined in client/apis/ConnectionApi.ts:222
Accept a stored connection request

Parameters
- requestParameters: ConnectionsConnIdAcceptRequestPostRequest
Returns Promise<ConnRecord>

connectionsConnIdAcceptRequestPostRaw

connectionsConnIdAcceptRequestPostRaw(requestParameters: ConnectionsConnIdAcceptRequestPostRequest): Promise<ApiResponse<ConnRecord>>

- Defined in client/apis/ConnectionApi.ts:183
Accept a stored connection request

Parameters
- requestParameters: ConnectionsConnIdAcceptRequestPostRequest
Returns Promise<ApiResponse<ConnRecord>>

connectionsConnIdDelete

connectionsConnIdDelete(requestParameters: ConnectionsConnIdDeleteRequest): Promise<object>

- Defined in client/apis/ConnectionApi.ts:267
Remove an existing connection record

Parameters
- requestParameters: ConnectionsConnIdDeleteRequest
Returns Promise<object>

connectionsConnIdDeleteRaw

connectionsConnIdDeleteRaw(requestParameters: ConnectionsConnIdDeleteRequest): Promise<ApiResponse<object>>

- Defined in client/apis/ConnectionApi.ts:234
Remove an existing connection record

Parameters
- requestParameters: ConnectionsConnIdDeleteRequest
Returns Promise<ApiResponse<object>>

connectionsConnIdEndpointsGet

connectionsConnIdEndpointsGet(requestParameters: ConnectionsConnIdEndpointsGetRequest): Promise<EndpointsResult>

- Defined in client/apis/ConnectionApi.ts:312
Fetch connection remote endpoint

Parameters
- requestParameters: ConnectionsConnIdEndpointsGetRequest
Returns Promise<EndpointsResult>

connectionsConnIdEndpointsGetRaw

connectionsConnIdEndpointsGetRaw(requestParameters: ConnectionsConnIdEndpointsGetRequest): Promise<ApiResponse<EndpointsResult>>

- Defined in client/apis/ConnectionApi.ts:277
Fetch connection remote endpoint

Parameters
- requestParameters: ConnectionsConnIdEndpointsGetRequest
Returns Promise<ApiResponse<EndpointsResult>>

connectionsConnIdEstablishInboundRefIdPost

connectionsConnIdEstablishInboundRefIdPost(requestParameters: ConnectionsConnIdEstablishInboundRefIdPostRequest): Promise<object>

- Defined in client/apis/ConnectionApi.ts:372
Assign another connection as the inbound connection

Parameters
- requestParameters: ConnectionsConnIdEstablishInboundRefIdPostRequest
Returns Promise<object>

connectionsConnIdEstablishInboundRefIdPostRaw

connectionsConnIdEstablishInboundRefIdPostRaw(requestParameters: ConnectionsConnIdEstablishInboundRefIdPostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/ConnectionApi.ts:324
Assign another connection as the inbound connection

Parameters
- requestParameters: ConnectionsConnIdEstablishInboundRefIdPostRequest
Returns Promise<ApiResponse<object>>

connectionsConnIdGet

connectionsConnIdGet(requestParameters: ConnectionsConnIdGetRequest): Promise<ConnRecord>

- Defined in client/apis/ConnectionApi.ts:419
Fetch a single connection record

Parameters
- requestParameters: ConnectionsConnIdGetRequest
Returns Promise<ConnRecord>

connectionsConnIdGetRaw

connectionsConnIdGetRaw(requestParameters: ConnectionsConnIdGetRequest): Promise<ApiResponse<ConnRecord>>

- Defined in client/apis/ConnectionApi.ts:384
Fetch a single connection record

Parameters
- requestParameters: ConnectionsConnIdGetRequest
Returns Promise<ApiResponse<ConnRecord>>

connectionsConnIdMetadataGet

connectionsConnIdMetadataGet(requestParameters: ConnectionsConnIdMetadataGetRequest): Promise<ConnectionMetadata>

- Defined in client/apis/ConnectionApi.ts:468
Fetch connection metadata

Parameters
- requestParameters: ConnectionsConnIdMetadataGetRequest
Returns Promise<ConnectionMetadata>

connectionsConnIdMetadataGetRaw

connectionsConnIdMetadataGetRaw(requestParameters: ConnectionsConnIdMetadataGetRequest): Promise<ApiResponse<ConnectionMetadata>>

- Defined in client/apis/ConnectionApi.ts:429
Fetch connection metadata

Parameters
- requestParameters: ConnectionsConnIdMetadataGetRequest
Returns Promise<ApiResponse<ConnectionMetadata>>

connectionsConnIdMetadataPost

connectionsConnIdMetadataPost(requestParameters: ConnectionsConnIdMetadataPostRequest): Promise<ConnectionMetadata>

- Defined in client/apis/ConnectionApi.ts:518
Set connection metadata

Parameters
- requestParameters: ConnectionsConnIdMetadataPostRequest
Returns Promise<ConnectionMetadata>

connectionsConnIdMetadataPostRaw

connectionsConnIdMetadataPostRaw(requestParameters: ConnectionsConnIdMetadataPostRequest): Promise<ApiResponse<ConnectionMetadata>>

- Defined in client/apis/ConnectionApi.ts:480
Set connection metadata

Parameters
- requestParameters: ConnectionsConnIdMetadataPostRequest
Returns Promise<ApiResponse<ConnectionMetadata>>

connectionsCreateInvitationPost

connectionsCreateInvitationPost(requestParameters: ConnectionsCreateInvitationPostRequest): Promise<InvitationResult>

- Defined in client/apis/ConnectionApi.ts:571
Create a new connection invitation

Parameters
- requestParameters: ConnectionsCreateInvitationPostRequest
Returns Promise<InvitationResult>

connectionsCreateInvitationPostRaw

connectionsCreateInvitationPostRaw(requestParameters: ConnectionsCreateInvitationPostRequest): Promise<ApiResponse<InvitationResult>>

- Defined in client/apis/ConnectionApi.ts:530
Create a new connection invitation

Parameters
- requestParameters: ConnectionsCreateInvitationPostRequest
Returns Promise<ApiResponse<InvitationResult>>

connectionsCreateStaticPost

connectionsCreateStaticPost(requestParameters: ConnectionsCreateStaticPostRequest): Promise<ConnectionStaticResult>

- Defined in client/apis/ConnectionApi.ts:608
Create a new static connection

Parameters
- requestParameters: ConnectionsCreateStaticPostRequest
Returns Promise<ConnectionStaticResult>

connectionsCreateStaticPostRaw

connectionsCreateStaticPostRaw(requestParameters: ConnectionsCreateStaticPostRequest): Promise<ApiResponse<ConnectionStaticResult>>

- Defined in client/apis/ConnectionApi.ts:583
Create a new static connection

Parameters
- requestParameters: ConnectionsCreateStaticPostRequest
Returns Promise<ApiResponse<ConnectionStaticResult>>

connectionsGet

connectionsGet(requestParameters: ConnectionsGetRequest): Promise<ConnectionList>

- Defined in client/apis/ConnectionApi.ts:679
Query agent-to-agent connections

Parameters
- requestParameters: ConnectionsGetRequest
Returns Promise<ConnectionList>

connectionsGetRaw

connectionsGetRaw(requestParameters: ConnectionsGetRequest): Promise<ApiResponse<ConnectionList>>

- Defined in client/apis/ConnectionApi.ts:620
Query agent-to-agent connections

Parameters
- requestParameters: ConnectionsGetRequest
Returns Promise<ApiResponse<ConnectionList>>

connectionsReceiveInvitationPost

connectionsReceiveInvitationPost(requestParameters: ConnectionsReceiveInvitationPostRequest): Promise<ConnRecord>

- Defined in client/apis/ConnectionApi.ts:726
Receive a new connection invitation

Parameters
- requestParameters: ConnectionsReceiveInvitationPostRequest
Returns Promise<ConnRecord>

connectionsReceiveInvitationPostRaw

connectionsReceiveInvitationPostRaw(requestParameters: ConnectionsReceiveInvitationPostRequest): Promise<ApiResponse<ConnRecord>>

- Defined in client/apis/ConnectionApi.ts:689
Receive a new connection invitation

Parameters
- requestParameters: ConnectionsReceiveInvitationPostRequest
Returns Promise<ApiResponse<ConnRecord>>

Protected request

request(context: RequestOpts): Promise<Response>

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

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