Update typedocs files (#43)

team-telnyx · Sep 25, 2020 · a5105ea · a5105ea
1 parent 4f15142
commit a5105ea
Show file tree

Hide file tree

Showing 85 changed files with 9,968 additions and 271 deletions.
diff --git a/packages/js/docs/ts/README.md b/packages/js/docs/ts/README.md
diff --git a/packages/js/docs/ts/classes/basecall.md b/packages/js/docs/ts/classes/basecall.md
diff --git a/packages/js/docs/ts/classes/baseclient.md b/packages/js/docs/ts/classes/baseclient.md
@@ -1,4 +1,4 @@
-[@telnyx/webrtc - v2.1.0](../README.md) › [BaseClient](baseclient.md)
+[@telnyx/webrtc - v2.1.5](../README.md) › [BaseClient](baseclient.md)
 
 # Class: BaseClient
 
@@ -44,7 +44,7 @@
 
 \+ **new BaseClient**(`o?`: [IClientOptions](../interfaces/iclientoptions.md)): *[BaseClient](baseclient.md)*
 
-*Defined in [src/BaseClient.ts:49](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L49)*
+*Defined in [packages/js/src/BaseClient.ts:49](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L49)*
 
 **Parameters:**
 
@@ -60,101 +60,101 @@ Name | Type |
 
 • **credentials**: *[ICredentials](../interfaces/icredentials.md)*
 
-*Defined in [src/BaseClient.ts:36](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L36)*
+*Defined in [packages/js/src/BaseClient.ts:36](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L36)*
 
 ___
 
 ###  displayName
 
 • **displayName**: *string*
 
-*Defined in [src/BaseClient.ts:40](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L40)*
+*Defined in [packages/js/src/BaseClient.ts:40](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L40)*
 
 ___
 
 ###  env
 
 • **env**: *[Env](../README.md#env)*
 
-*Defined in [src/BaseClient.ts:33](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L33)*
+*Defined in [packages/js/src/BaseClient.ts:33](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L33)*
 
 ___
 
 ###  host
 
 • **host**: *string*
 
-*Defined in [src/BaseClient.ts:31](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L31)*
+*Defined in [packages/js/src/BaseClient.ts:31](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L31)*
 
 ___
 
 ###  module
 
 • **module**: *[Module](../README.md#module)*
 
-*Defined in [src/BaseClient.ts:34](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L34)*
+*Defined in [packages/js/src/BaseClient.ts:34](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L34)*
 
 ___
 
 ###  port
 
 • **port**: *number*
 
-*Defined in [src/BaseClient.ts:32](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L32)*
+*Defined in [packages/js/src/BaseClient.ts:32](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L32)*
 
 ___
 
 ### `Optional` project
 
 • **project**? : *string*
 
-*Defined in [src/BaseClient.ts:35](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L35)*
+*Defined in [packages/js/src/BaseClient.ts:35](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L35)*
 
 ___
 
 ### `Optional` ringFile
 
 • **ringFile**? : *string*
 
-*Defined in [src/BaseClient.ts:41](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L41)*
+*Defined in [packages/js/src/BaseClient.ts:41](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L41)*
 
 ___
 
 ###  useCamera
 
 • **useCamera**: *string | boolean*
 
-*Defined in [src/BaseClient.ts:39](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L39)*
+*Defined in [packages/js/src/BaseClient.ts:39](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L39)*
 
 ___
 
 ###  useMic
 
 • **useMic**: *string | boolean*
 
-*Defined in [src/BaseClient.ts:37](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L37)*
+*Defined in [packages/js/src/BaseClient.ts:37](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L37)*
 
 ___
 
 ###  useSpeaker
 
 • **useSpeaker**: *string | boolean*
 
-*Defined in [src/BaseClient.ts:38](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L38)*
+*Defined in [packages/js/src/BaseClient.ts:38](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L38)*
 
 ## Accessors
 
 ###  localElement
 
 • **get localElement**(): *string | Function | HTMLMediaElement*
 
-*Defined in [src/BaseClient.ts:65](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L65)*
+*Defined in [packages/js/src/BaseClient.ts:65](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L65)*
 
 **Returns:** *string | Function | HTMLMediaElement*
 
 • **set localElement**(`el`: [RTCElement](../README.md#rtcelement)): *void*
 
-*Defined in [src/BaseClient.ts:61](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L61)*
+*Defined in [packages/js/src/BaseClient.ts:61](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L61)*
 
 **Parameters:**
 
@@ -170,13 +170,13 @@ ___
 
 • **get remoteElement**(): *string | Function | HTMLMediaElement*
 
-*Defined in [src/BaseClient.ts:73](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L73)*
+*Defined in [packages/js/src/BaseClient.ts:73](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L73)*
 
 **Returns:** *string | Function | HTMLMediaElement*
 
 • **set remoteElement**(`el`: [RTCElement](../README.md#rtcelement)): *void*
 
-*Defined in [src/BaseClient.ts:69](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L69)*
+*Defined in [packages/js/src/BaseClient.ts:69](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L69)*
 
 **Parameters:**
 
@@ -192,7 +192,7 @@ Name | Type |
 
 ▸ **connect**(): *void*
 
-*Defined in [src/BaseClient.ts:85](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L85)*
+*Defined in [packages/js/src/BaseClient.ts:85](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L85)*
 
 **Returns:** *void*
 
@@ -202,7 +202,7 @@ ___
 
 ▸ **disconnect**(): *void*
 
-*Defined in [src/BaseClient.ts:86](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L86)*
+*Defined in [packages/js/src/BaseClient.ts:86](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L86)*
 
 **Returns:** *void*
 
@@ -212,7 +212,7 @@ ___
 
 ▸ **newCall**(`options`: [ICallOptions](../interfaces/icalloptions.md)): *[ICall](../interfaces/icall.md)*
 
-*Defined in [src/BaseClient.ts:95](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L95)*
+*Defined in [packages/js/src/BaseClient.ts:95](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L95)*
 
 **Parameters:**
 
@@ -228,7 +228,7 @@ ___
 
 ▸ **on**‹**E**›(`message`: E, `cb`: MessageEvents[E]): *[BaseClient](baseclient.md)*
 
-*Defined in [src/BaseClient.ts:77](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L77)*
+*Defined in [packages/js/src/BaseClient.ts:77](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L77)*
 
 **Type parameters:**
 

diff --git a/packages/js/docs/ts/classes/baserequest.md b/packages/js/docs/ts/classes/baserequest.md
@@ -0,0 +1,89 @@
+[@telnyx/webrtc - v2.1.5](../README.md) › [BaseRequest](baserequest.md)
+
+# Class: BaseRequest
+
+## Hierarchy
+
+* BaseMessage
+
+  ↳ **BaseRequest**
+
+## Index
+
+### Constructors
+
+* [constructor](baserequest.md#constructor)
+
+### Properties
+
+* [request](baserequest.md#request)
+* [response](baserequest.md#response)
+* [targetNodeId](baserequest.md#targetnodeid)
+
+### Methods
+
+* [buildRequest](baserequest.md#buildrequest)
+
+## Constructors
+
+###  constructor
+
+\+ **new BaseRequest**(`params`: any): *[BaseRequest](baserequest.md)*
+
+*Defined in [packages/js/src/Modules/Verto/messages/verto/BaseRequest.ts:12](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/verto/BaseRequest.ts#L12)*
+
+**Parameters:**
+
+Name | Type | Default |
+------ | ------ | ------ |
+`params` | any |  {} |
+
+**Returns:** *[BaseRequest](baserequest.md)*
+
+## Properties
+
+###  request
+
+• **request**: *any*
+
+*Inherited from void*
+
+*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:5](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L5)*
+
+___
+
+###  response
+
+• **response**: *any*
+
+*Inherited from void*
+
+*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:6](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L6)*
+
+___
+
+###  targetNodeId
+
+• **targetNodeId**: *string*
+
+*Inherited from void*
+
+*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:7](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L7)*
+
+## Methods
+
+###  buildRequest
+
+▸ **buildRequest**(`params`: any): *void*
+
+*Inherited from void*
+
+*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:9](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L9)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`params` | any |
+
+**Returns:** *void*