Skip to content

VAPI-2700 Add Endpoint Event Model and Related Enums #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
smoghe-bw wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

VAPI-2700 Add Endpoint Event Model and Related Enums #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
866 changes: 853 additions & 13 deletions bandwidth.yml
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions docs/CreateEndpointRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth.Standard.Model.CreateEndpointRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **EndpointTypeEnum** | |
**Direction** | **EndpointDirectionEnum** | |
**EventCallbackUrl** | **string** | The URL to send event callbacks to. | [optional]
**EventFallbackUrl** | **string** | The URL to send event fallbacks to. | [optional]
**Tag** | **string** | A tag for the endpoint. | [optional]
**ConnectionMetadata** | **Object** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14 changes: 14 additions & 0 deletions docs/CreateEndpointRequestBase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Bandwidth.Standard.Model.CreateEndpointRequestBase

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **EndpointTypeEnum** | |
**Direction** | **EndpointDirectionEnum** | |
**EventCallbackUrl** | **string** | The URL to send event callbacks to. | [optional]
**EventFallbackUrl** | **string** | The URL to send event fallbacks to. | [optional]
**Tag** | **string** | A tag for the endpoint. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions docs/CreateEndpointResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Bandwidth.Standard.Model.CreateEndpointResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Links** | [**List<Link>**](Link.md) | |
**Data** | [**CreateEndpointResponseObject**](CreateEndpointResponseObject.md) | |
**Errors** | [**List<Error>**](Error.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17 changes: 17 additions & 0 deletions docs/CreateEndpointResponseObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Bandwidth.Standard.Model.CreateEndpointResponseObject

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EndpointId** | **string** | The unique ID of the endpoint. |
**Type** | **EndpointTypeEnum** | |
**Status** | **EndpointStatusEnum** | |
**CreationTimestamp** | **DateTime** | The time the endpoint was created. In ISO-8601 format. |
**ExpirationTimestamp** | **DateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |
**Tag** | **string** | A tag for the endpoint. | [optional]
**Devices** | [**List<Device>**](Device.md) | | [optional]
**Token** | **string** | The json web token specific to the endpoint. Used to authenticate the client with the media gateway. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15 changes: 15 additions & 0 deletions docs/CreateWebRtcConnectionRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth.Standard.Model.CreateWebRtcConnectionRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **EndpointTypeEnum** | |
**Direction** | **EndpointDirectionEnum** | |
**EventCallbackUrl** | **string** | The URL to send event callbacks to. | [optional]
**EventFallbackUrl** | **string** | The URL to send event fallbacks to. | [optional]
**Tag** | **string** | A tag for the endpoint. | [optional]
**ConnectionMetadata** | **Object** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13 changes: 13 additions & 0 deletions docs/Device.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Bandwidth.Standard.Model.Device

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DeviceId** | **string** | The unique ID of the device. |
**DeviceName** | **string** | The name of the device. | [optional]
**Status** | **DeviceStatusEnum** | |
**CreationTimestamp** | **DateTime** | The time the device was created. In ISO-8601 format. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/DeviceStatusEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bandwidth.Standard.Model.DeviceStatusEnum

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16 changes: 16 additions & 0 deletions docs/Endpoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Bandwidth.Standard.Model.Endpoint

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EndpointId** | **string** | The unique ID of the endpoint. |
**Type** | **EndpointTypeEnum** | |
**Status** | **EndpointStatusEnum** | |
**CreationTimestamp** | **DateTime** | The time the endpoint was created. In ISO-8601 format. |
**ExpirationTimestamp** | **DateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |
**Tag** | **string** | A tag for the endpoint. | [optional]
**Devices** | [**List<Device>**](Device.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/EndpointDirectionEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bandwidth.Standard.Model.EndpointDirectionEnum

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19 changes: 19 additions & 0 deletions docs/EndpointEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Bandwidth.Standard.Model.EndpointEvent
An event that occurred on an endpoint.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EndpointId** | **string** | The unique ID of the endpoint. |
**Type** | **EndpointTypeEnum** | |
**Status** | **EndpointStatusEnum** | |
**CreationTimestamp** | **DateTime** | The time the endpoint was created. In ISO-8601 format. |
**ExpirationTimestamp** | **DateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |
**Tag** | **string** | A tag for the endpoint. | [optional]
**EventTime** | **DateTime** | The time the event occurred. In ISO-8601 format. |
**EventType** | **EndpointEventTypeEnum** | |
**Device** | [**Device**](Device.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/EndpointEventTypeEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bandwidth.Standard.Model.EndpointEventTypeEnum

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions docs/EndpointResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Bandwidth.Standard.Model.EndpointResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Links** | [**List<Link>**](Link.md) | |
**Data** | [**Endpoint**](Endpoint.md) | |
**Errors** | [**List<Error>**](Error.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/EndpointStatusEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bandwidth.Standard.Model.EndpointStatusEnum

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/EndpointTypeEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bandwidth.Standard.Model.EndpointTypeEnum

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15 changes: 15 additions & 0 deletions docs/Endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth.Standard.Model.Endpoints

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EndpointId** | **string** | The unique ID of the endpoint. |
**Type** | **EndpointTypeEnum** | |
**Status** | **EndpointStatusEnum** | |
**CreationTimestamp** | **DateTime** | The time the endpoint was created. In ISO-8601 format. |
**ExpirationTimestamp** | **DateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |
**Tag** | **string** | A tag for the endpoint. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading
Loading