Skip to content

Commit b5eb897

Browse files
smoghe-bwclaudeckoegel
authored
VAPI-2755 Update documentation and models for various API endpoints (#104)
* Update documentation and models for various API endpoints - Modified LookupResult.md to correct field names and descriptions. - Updated MachineDetectionConfiguration.md to improve clarity in descriptions. - Revised MessageRequest.md for consistency in formatting. - Added new Page.md documentation for pagination support. - Adjusted RbmOpenUrlEnum.md and RbmWebViewEnum.md for better readability. - Introduced new SipConnectionMetadata.md and SipCredentials.md models. - Enhanced StatusCallback.md to clarify the carrierName field description. - Created new models for endpoint management including CreateEndpointRequestBase, CreateEndpointResponse, and related types. - Added device-related models including Device, DeviceStatusEnum, and Endpoint management types. - Implemented error handling models such as ErrorResponse and updated InboundCallback types. - Added list-endpoints response model for better API response handling. * Add unit tests for endpoint models and responses * Add comprehensive tests for EndpointsApi functionality * Fix type checks and update pagination property names in endpoint tests * Enhance CreateEndpointResponseData and Endpoint models with token property; update tests to validate new structure and behavior * Refactor EndpointsApi tests to access nested data structure in responses; ensure proper validation of endpoint properties * Comment out updateEndpointBxml tests until implementation is complete * empty commit * Add spacing for better readability before deleteEndpoint tests * Add unit tests for EndpointsApi and related models * Refactor endpoint tests for clarity and organization * Update endpoint tests to use containKeys for link validation * Update endpoint tests to use containKeys for key validation * Trigger build * Address PR review feedback for BRTC endpoints - Add Connect and Endpoint BXML verb implementations and tests - Export new verbs from bxml/verbs/index.ts - Combine model tests into single comprehensive tests per model - Add Object.values assertions to all enum tests - Improve date assertions to verify year and specific ISO timestamps - Use request body variable with CreateWebRtcConnectionRequest type in unit API tests - Remove toContainKeys assertions from unit API tests - Rename test descriptions to "should create/list/get/delete endpoint" - Add missing delete endpoint unit test - Remove unnecessary filtered-by-type test from smoke tests - Rename smoke test descriptions for consistency Generated from Claude9 with Claude Code Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix remaining review feedback Add missing unit tests for 5 new models: CreateWebRtcConnectionRequest, SipConnectionMetadata, SipCredentials, ErrorResponse, and Page. Generated from Claude9 with Claude Code Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix endpoint test coverage gaps and remove redundant test file - Remove endpoint-event.test.ts (redundant; EndpointEvent is a type alias for Endpoints) - Fix endpoint-response.test.ts to use Endpoint type instead of Endpoints, add devices field assertions - Add devices field assertions to create-endpoint-response-data.test.ts - Add devices field assertions to create-endpoint-response.test.ts - Add creationTimestamp assertions on devices in endpoint.test.ts - Add type and timestamp assertions for second endpoint in list-endpoints-response.test.ts - Replace conditional guard with explicit length assertion in endpoints-api.test.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Address PR review comments: add Object.values assertions and endpoint-event test - Add Object.values() assertions to all 37 enum tests to catch future changes - Add missing endpoint-event.test.ts with proper date assertions Generated from Claude9 with Claude Code Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Revert non-endpoint enum Object.values changes and remove redundant endpoint-event test EndpointEvent is just a type alias for Endpoints, which is already tested in endpoints.test.ts. Generated from Claude9 with Claude Code Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Add endpoint-event model test Generated from Claude9 with Claude Code Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Hoist createEndpointBody to describe scope as a typed variable Addresses review comment to use the model/interface at the top level. Generated from Claude9 with Claude Code Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Fix Connect and Endpoint BXML verbs to match API docs Connect: replace incorrect attributes (copied from Transfer) with the single documented attribute: eventCallbackUrl. Endpoint: remove EndpointAttributes interface — per the docs, Endpoint has no attributes, only text content (the endpoint ID). Generated from Claude9 with Claude Code Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Add updateEndpointBxml unit test for endpoints API The spec defines PUT /accounts/{accountId}/endpoints/{endpointId}/bxml but there was no unit test covering this operation. Generated from Claude9 with Claude Code Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Update models/bxml/verbs/Endpoint.ts Co-authored-by: Cameron Koegel <53310569+ckoegel@users.noreply.github.com> --------- Co-authored-by: smoghe-bw <smoghe-bw> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Cameron Koegel <53310569+ckoegel@users.noreply.github.com>
1 parent fdbd3a5 commit b5eb897

90 files changed

Lines changed: 3819 additions & 33 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openapi-generator/FILES

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ README.md
33
api.ts
44
api/calls-api.ts
55
api/conferences-api.ts
6+
api/endpoints-api.ts
67
api/media-api.ts
78
api/messages-api.ts
89
api/mfaapi.ts
@@ -56,16 +57,32 @@ docs/CreateAsyncBulkLookupResponse.md
5657
docs/CreateAsyncBulkLookupResponseData.md
5758
docs/CreateCall.md
5859
docs/CreateCallResponse.md
60+
docs/CreateEndpointRequestBase.md
61+
docs/CreateEndpointResponse.md
62+
docs/CreateEndpointResponseData.md
5963
docs/CreateMessageRequestError.md
6064
docs/CreateMultiChannelMessageResponse.md
6165
docs/CreateSyncLookupResponse.md
6266
docs/CreateSyncLookupResponseData.md
67+
docs/CreateWebRtcConnectionRequest.md
6368
docs/DeactivationEventEnum.md
69+
docs/Device.md
70+
docs/DeviceStatusEnum.md
6471
docs/DisconnectCallback.md
6572
docs/Diversion.md
6673
docs/DtmfCallback.md
74+
docs/Endpoint.md
75+
docs/EndpointDirectionEnum.md
76+
docs/EndpointEvent.md
77+
docs/EndpointEventTypeEnum.md
78+
docs/EndpointResponse.md
79+
docs/EndpointStatusEnum.md
80+
docs/EndpointTypeEnum.md
81+
docs/Endpoints.md
82+
docs/EndpointsApi.md
6783
docs/Error.md
6884
docs/ErrorObject.md
85+
docs/ErrorResponse.md
6986
docs/ErrorSource.md
7087
docs/FailureWebhook.md
7188
docs/FieldError.md
@@ -83,6 +100,7 @@ docs/LineTypeEnum.md
83100
docs/Link.md
84101
docs/LinkSchema.md
85102
docs/LinksObject.md
103+
docs/ListEndpointsResponse.md
86104
docs/ListMessageDirectionEnum.md
87105
docs/ListMessageItem.md
88106
docs/LookupErrorResponse.md
@@ -130,6 +148,7 @@ docs/MultiChannelMessageContent.md
130148
docs/MultiChannelMessageRequest.md
131149
docs/MultiChannelMessageResponseData.md
132150
docs/OptInWorkflow.md
151+
docs/Page.md
133152
docs/PageInfo.md
134153
docs/PhoneNumberLookupApi.md
135154
docs/PriorityEnum.md
@@ -160,6 +179,8 @@ docs/RecordingTranscriptions.md
160179
docs/RecordingsApi.md
161180
docs/RedirectCallback.md
162181
docs/RedirectMethodEnum.md
182+
docs/SipConnectionMetadata.md
183+
docs/SipCredentials.md
163184
docs/SmsMessageContent.md
164185
docs/StandaloneCardOrientationEnum.md
165186
docs/StatisticsApi.md
@@ -243,15 +264,30 @@ models/create-async-bulk-lookup-response-data.ts
243264
models/create-async-bulk-lookup-response.ts
244265
models/create-call-response.ts
245266
models/create-call.ts
267+
models/create-endpoint-request-base.ts
268+
models/create-endpoint-response-data.ts
269+
models/create-endpoint-response.ts
246270
models/create-message-request-error.ts
247271
models/create-multi-channel-message-response.ts
248272
models/create-sync-lookup-response-data.ts
249273
models/create-sync-lookup-response.ts
274+
models/create-web-rtc-connection-request.ts
250275
models/deactivation-event-enum.ts
276+
models/device-status-enum.ts
277+
models/device.ts
251278
models/disconnect-callback.ts
252279
models/diversion.ts
253280
models/dtmf-callback.ts
281+
models/endpoint-direction-enum.ts
282+
models/endpoint-event-type-enum.ts
283+
models/endpoint-event.ts
284+
models/endpoint-response.ts
285+
models/endpoint-status-enum.ts
286+
models/endpoint-type-enum.ts
287+
models/endpoint.ts
288+
models/endpoints.ts
254289
models/error-object.ts
290+
models/error-response.ts
255291
models/error-source.ts
256292
models/failure-webhook.ts
257293
models/field-error.ts
@@ -270,6 +306,7 @@ models/line-type-enum.ts
270306
models/link-schema.ts
271307
models/link.ts
272308
models/links-object.ts
309+
models/list-endpoints-response.ts
273310
models/list-message-direction-enum.ts
274311
models/list-message-item.ts
275312
models/lookup-error-response.ts
@@ -315,6 +352,7 @@ models/multi-channel-message-request.ts
315352
models/multi-channel-message-response-data.ts
316353
models/opt-in-workflow.ts
317354
models/page-info.ts
355+
models/page.ts
318356
models/priority-enum.ts
319357
models/product-type-enum.ts
320358
models/rbm-action-base.ts
@@ -342,6 +380,8 @@ models/recording-transcription-metadata.ts
342380
models/recording-transcriptions.ts
343381
models/redirect-callback.ts
344382
models/redirect-method-enum.ts
383+
models/sip-connection-metadata.ts
384+
models/sip-credentials.ts
345385
models/sms-message-content.ts
346386
models/standalone-card-orientation-enum.ts
347387
models/status-callback-message.ts

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,11 @@ Class | Method | HTTP request | Description
120120
*ConferencesApi* | [**updateConference**](docs/ConferencesApi.md#updateconference) | **POST** /accounts/{accountId}/conferences/{conferenceId} | Update Conference
121121
*ConferencesApi* | [**updateConferenceBxml**](docs/ConferencesApi.md#updateconferencebxml) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/bxml | Update Conference BXML
122122
*ConferencesApi* | [**updateConferenceMember**](docs/ConferencesApi.md#updateconferencemember) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Update Conference Member
123+
*EndpointsApi* | [**createEndpoint**](docs/EndpointsApi.md#createendpoint) | **POST** /accounts/{accountId}/endpoints | Create Endpoint
124+
*EndpointsApi* | [**deleteEndpoint**](docs/EndpointsApi.md#deleteendpoint) | **DELETE** /accounts/{accountId}/endpoints/{endpointId} | Delete Endpoint
125+
*EndpointsApi* | [**getEndpoint**](docs/EndpointsApi.md#getendpoint) | **GET** /accounts/{accountId}/endpoints/{endpointId} | Get Endpoint
126+
*EndpointsApi* | [**listEndpoints**](docs/EndpointsApi.md#listendpoints) | **GET** /accounts/{accountId}/endpoints | List Endpoints
127+
*EndpointsApi* | [**updateEndpointBxml**](docs/EndpointsApi.md#updateendpointbxml) | **PUT** /accounts/{accountId}/endpoints/{endpointId}/bxml | Update Endpoint BXML
123128
*MFAApi* | [**generateMessagingCode**](docs/MFAApi.md#generatemessagingcode) | **POST** /accounts/{accountId}/code/messaging | Messaging Authentication Code
124129
*MFAApi* | [**generateVoiceCode**](docs/MFAApi.md#generatevoicecode) | **POST** /accounts/{accountId}/code/voice | Voice Authentication Code
125130
*MFAApi* | [**verifyCode**](docs/MFAApi.md#verifycode) | **POST** /accounts/{accountId}/code/verify | Verify Authentication Code
@@ -199,15 +204,30 @@ Class | Method | HTTP request | Description
199204
- [CreateAsyncBulkLookupResponseData](docs/CreateAsyncBulkLookupResponseData.md)
200205
- [CreateCall](docs/CreateCall.md)
201206
- [CreateCallResponse](docs/CreateCallResponse.md)
207+
- [CreateEndpointRequestBase](docs/CreateEndpointRequestBase.md)
208+
- [CreateEndpointResponse](docs/CreateEndpointResponse.md)
209+
- [CreateEndpointResponseData](docs/CreateEndpointResponseData.md)
202210
- [CreateMessageRequestError](docs/CreateMessageRequestError.md)
203211
- [CreateMultiChannelMessageResponse](docs/CreateMultiChannelMessageResponse.md)
204212
- [CreateSyncLookupResponse](docs/CreateSyncLookupResponse.md)
205213
- [CreateSyncLookupResponseData](docs/CreateSyncLookupResponseData.md)
214+
- [CreateWebRtcConnectionRequest](docs/CreateWebRtcConnectionRequest.md)
206215
- [DeactivationEventEnum](docs/DeactivationEventEnum.md)
216+
- [Device](docs/Device.md)
217+
- [DeviceStatusEnum](docs/DeviceStatusEnum.md)
207218
- [DisconnectCallback](docs/DisconnectCallback.md)
208219
- [Diversion](docs/Diversion.md)
209220
- [DtmfCallback](docs/DtmfCallback.md)
221+
- [Endpoint](docs/Endpoint.md)
222+
- [EndpointDirectionEnum](docs/EndpointDirectionEnum.md)
223+
- [EndpointEvent](docs/EndpointEvent.md)
224+
- [EndpointEventTypeEnum](docs/EndpointEventTypeEnum.md)
225+
- [EndpointResponse](docs/EndpointResponse.md)
226+
- [EndpointStatusEnum](docs/EndpointStatusEnum.md)
227+
- [EndpointTypeEnum](docs/EndpointTypeEnum.md)
228+
- [Endpoints](docs/Endpoints.md)
210229
- [ErrorObject](docs/ErrorObject.md)
230+
- [ErrorResponse](docs/ErrorResponse.md)
211231
- [ErrorSource](docs/ErrorSource.md)
212232
- [FailureWebhook](docs/FailureWebhook.md)
213233
- [FieldError](docs/FieldError.md)
@@ -225,6 +245,7 @@ Class | Method | HTTP request | Description
225245
- [Link](docs/Link.md)
226246
- [LinkSchema](docs/LinkSchema.md)
227247
- [LinksObject](docs/LinksObject.md)
248+
- [ListEndpointsResponse](docs/ListEndpointsResponse.md)
228249
- [ListMessageDirectionEnum](docs/ListMessageDirectionEnum.md)
229250
- [ListMessageItem](docs/ListMessageItem.md)
230251
- [LookupErrorResponse](docs/LookupErrorResponse.md)
@@ -269,6 +290,7 @@ Class | Method | HTTP request | Description
269290
- [MultiChannelMessageRequest](docs/MultiChannelMessageRequest.md)
270291
- [MultiChannelMessageResponseData](docs/MultiChannelMessageResponseData.md)
271292
- [OptInWorkflow](docs/OptInWorkflow.md)
293+
- [Page](docs/Page.md)
272294
- [PageInfo](docs/PageInfo.md)
273295
- [PriorityEnum](docs/PriorityEnum.md)
274296
- [ProductTypeEnum](docs/ProductTypeEnum.md)
@@ -297,6 +319,8 @@ Class | Method | HTTP request | Description
297319
- [RecordingTranscriptions](docs/RecordingTranscriptions.md)
298320
- [RedirectCallback](docs/RedirectCallback.md)
299321
- [RedirectMethodEnum](docs/RedirectMethodEnum.md)
322+
- [SipConnectionMetadata](docs/SipConnectionMetadata.md)
323+
- [SipCredentials](docs/SipCredentials.md)
300324
- [SmsMessageContent](docs/SmsMessageContent.md)
301325
- [StandaloneCardOrientationEnum](docs/StandaloneCardOrientationEnum.md)
302326
- [StatusCallback](docs/StatusCallback.md)

api.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
export * from './api/calls-api';
1818
export * from './api/conferences-api';
19+
export * from './api/endpoints-api';
1920
export * from './api/mfaapi';
2021
export * from './api/media-api';
2122
export * from './api/messages-api';

0 commit comments

Comments
 (0)