Skip to content

Commit 0d56a01

Browse files
ckoegelckoegel
authored
SWI-7769 Update to Generator v7.13.0 and Add Docs (#71)
* SWI-7769 Update to Generator v7.13.0 and Add Docs * update callback type enum (breaking)
1 parent 417aaf8 commit 0d56a01

File tree

160 files changed

+7509
-10
lines changed

Some content is hidden

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

160 files changed

+7509
-10
lines changed

‎.openapi-generator/FILES‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,161 @@ api/transcriptions-api.ts
1515
base.ts
1616
common.ts
1717
configuration.ts
18+
docs/AccountStatistics.md
19+
docs/AdditionalDenialReason.md
20+
docs/Address.md
21+
docs/AnswerCallback.md
22+
docs/BridgeCompleteCallback.md
23+
docs/BridgeTargetCompleteCallback.md
24+
docs/CallDirectionEnum.md
25+
docs/CallRecordingMetadata.md
26+
docs/CallState.md
27+
docs/CallStateEnum.md
28+
docs/CallTranscription.md
29+
docs/CallTranscriptionDetectedLanguageEnum.md
30+
docs/CallTranscriptionMetadata.md
31+
docs/CallTranscriptionResponse.md
32+
docs/CallTranscriptionTrackEnum.md
33+
docs/CallbackMethodEnum.md
34+
docs/CallbackTypeEnum.md
35+
docs/CallsApi.md
36+
docs/CardWidthEnum.md
37+
docs/CodeRequest.md
38+
docs/Conference.md
39+
docs/ConferenceCompletedCallback.md
40+
docs/ConferenceCreatedCallback.md
41+
docs/ConferenceMember.md
42+
docs/ConferenceMemberExitCallback.md
43+
docs/ConferenceMemberJoinCallback.md
44+
docs/ConferenceRecordingAvailableCallback.md
45+
docs/ConferenceRecordingMetadata.md
46+
docs/ConferenceRedirectCallback.md
47+
docs/ConferenceStateEnum.md
48+
docs/ConferencesApi.md
49+
docs/Contact.md
50+
docs/CreateCall.md
51+
docs/CreateCallResponse.md
52+
docs/CreateLookupResponse.md
53+
docs/CreateMessageRequestError.md
54+
docs/CreateMultiChannelMessageResponse.md
55+
docs/DeferredResult.md
56+
docs/DisconnectCallback.md
57+
docs/Diversion.md
58+
docs/DtmfCallback.md
59+
docs/Error.md
60+
docs/ErrorObject.md
61+
docs/FailureWebhook.md
62+
docs/FieldError.md
63+
docs/FileFormatEnum.md
64+
docs/GatherCallback.md
65+
docs/InitiateCallback.md
66+
docs/Link.md
67+
docs/LinksObject.md
68+
docs/ListMessageDirectionEnum.md
69+
docs/ListMessageItem.md
70+
docs/LookupRequest.md
71+
docs/LookupResult.md
72+
docs/LookupStatus.md
73+
docs/LookupStatusEnum.md
74+
docs/MFAApi.md
75+
docs/MachineDetectionCompleteCallback.md
76+
docs/MachineDetectionConfiguration.md
77+
docs/MachineDetectionModeEnum.md
78+
docs/MachineDetectionResult.md
79+
docs/Media.md
80+
docs/MediaApi.md
81+
docs/Message.md
82+
docs/MessageCallback.md
83+
docs/MessageCallbackMessage.md
84+
docs/MessageDirectionEnum.md
85+
docs/MessageRequest.md
86+
docs/MessageStatusEnum.md
87+
docs/MessageTypeEnum.md
88+
docs/MessagesApi.md
89+
docs/MessagesList.md
90+
docs/MessagingCodeResponse.md
91+
docs/MessagingRequestError.md
92+
docs/MfaForbiddenRequestError.md
93+
docs/MfaRequestError.md
94+
docs/MfaUnauthorizedRequestError.md
95+
docs/MmsMessageContent.md
96+
docs/MultiChannelAction.md
97+
docs/MultiChannelActionCalendarEvent.md
98+
docs/MultiChannelApi.md
99+
docs/MultiChannelCallbackData.md
100+
docs/MultiChannelChannelListObject.md
101+
docs/MultiChannelChannelListObjectContent.md
102+
docs/MultiChannelMessageCallbackData.md
103+
docs/MultiChannelMessageChannelEnum.md
104+
docs/MultiChannelMessageData.md
105+
docs/MultiChannelMessageDirectionEnum.md
106+
docs/MultiChannelMessageRequest.md
107+
docs/MultiChannelStatusEnum.md
108+
docs/OptInWorkflow.md
109+
docs/PageInfo.md
110+
docs/PhoneNumberLookupApi.md
111+
docs/PriorityEnum.md
112+
docs/RbmActionBase.md
113+
docs/RbmActionDial.md
114+
docs/RbmActionOpenUrl.md
115+
docs/RbmActionTypeEnum.md
116+
docs/RbmActionViewLocation.md
117+
docs/RbmCardContent.md
118+
docs/RbmCardContentMedia.md
119+
docs/RbmMediaHeightEnum.md
120+
docs/RbmMessageCarouselCard.md
121+
docs/RbmMessageContentFile.md
122+
docs/RbmMessageContentRichCard.md
123+
docs/RbmMessageContentText.md
124+
docs/RbmMessageMedia.md
125+
docs/RbmStandaloneCard.md
126+
docs/RecordingAvailableCallback.md
127+
docs/RecordingCompleteCallback.md
128+
docs/RecordingStateEnum.md
129+
docs/RecordingTranscriptionMetadata.md
130+
docs/RecordingTranscriptions.md
131+
docs/RecordingsApi.md
132+
docs/RedirectCallback.md
133+
docs/RedirectMethodEnum.md
134+
docs/SmsMessageContent.md
135+
docs/StandaloneCardOrientationEnum.md
136+
docs/StatisticsApi.md
137+
docs/StirShaken.md
138+
docs/TelephoneNumber.md
139+
docs/TfvBasicAuthentication.md
140+
docs/TfvCallbackStatusEnum.md
141+
docs/TfvError.md
142+
docs/TfvStatus.md
143+
docs/TfvStatusEnum.md
144+
docs/TfvSubmissionInfo.md
145+
docs/TfvSubmissionWrapper.md
146+
docs/ThumbnailAlignmentEnum.md
147+
docs/TnLookupRequestError.md
148+
docs/TollFreeVerificationApi.md
149+
docs/TranscribeRecording.md
150+
docs/Transcription.md
151+
docs/TranscriptionAvailableCallback.md
152+
docs/TranscriptionsApi.md
153+
docs/TransferAnswerCallback.md
154+
docs/TransferCompleteCallback.md
155+
docs/TransferDisconnectCallback.md
156+
docs/UpdateCall.md
157+
docs/UpdateCallRecording.md
158+
docs/UpdateConference.md
159+
docs/UpdateConferenceMember.md
160+
docs/VerificationDenialWebhook.md
161+
docs/VerificationRequest.md
162+
docs/VerificationUpdateRequest.md
163+
docs/VerificationWebhook.md
164+
docs/VerifyCodeRequest.md
165+
docs/VerifyCodeResponse.md
166+
docs/VoiceApiError.md
167+
docs/VoiceCodeResponse.md
168+
docs/WebhookSubscription.md
169+
docs/WebhookSubscriptionBasicAuthentication.md
170+
docs/WebhookSubscriptionRequestSchema.md
171+
docs/WebhookSubscriptionTypeEnum.md
172+
docs/WebhookSubscriptionsListBody.md
18173
git_push.sh
19174
index.ts
20175
models/account-statistics.ts

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.10.0
1+
7.13.0

‎docs/AccountStatistics.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AccountStatistics
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**currentCallQueueSize** | **number** | The number of calls currently enqueued. | [optional] [default to undefined]
9+
**maxCallQueueSize** | **number** | The maximum size of the queue before outgoing calls start being rejected. | [optional] [default to undefined]
10+
11+
## Example
12+
13+
```typescript
14+
import { AccountStatistics } from 'bandwidth-sdk';
15+
16+
const instance: AccountStatistics = {
17+
currentCallQueueSize,
18+
maxCallQueueSize,
19+
};
20+
```
21+
22+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/AdditionalDenialReason.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# AdditionalDenialReason
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**statusCode** | **number** | Reason code for denial. | [default to undefined]
9+
**reason** | **string** | Explanation for why a verification request was declined. | [default to undefined]
10+
**resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [default to undefined]
11+
12+
## Example
13+
14+
```typescript
15+
import { AdditionalDenialReason } from 'bandwidth-sdk';
16+
17+
const instance: AdditionalDenialReason = {
18+
statusCode,
19+
reason,
20+
resubmitAllowed,
21+
};
22+
```
23+
24+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/Address.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Address
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **string** | The name of the business using the toll-free number. | [default to undefined]
9+
**addr1** | **string** | The address of the business using the toll-free number. | [default to undefined]
10+
**addr2** | **string** | The address of the business using the toll-free number. | [optional] [default to undefined]
11+
**city** | **string** | The city of the business using the toll-free number. | [default to undefined]
12+
**state** | **string** | The state of the business using the toll-free number. | [default to undefined]
13+
**zip** | **string** | The zip of the business using the toll-free number. | [default to undefined]
14+
**url** | **string** | The website of the business using the toll-free number. | [default to undefined]
15+
16+
## Example
17+
18+
```typescript
19+
import { Address } from 'bandwidth-sdk';
20+
21+
const instance: Address = {
22+
name,
23+
addr1,
24+
addr2,
25+
city,
26+
state,
27+
zip,
28+
url,
29+
};
30+
```
31+
32+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/AnswerCallback.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# AnswerCallback
2+
3+
The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**eventType** | **string** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] [default to undefined]
10+
**eventTime** | **string** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] [default to undefined]
11+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
12+
**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
13+
**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
14+
**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
15+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
16+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
17+
**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
18+
**enqueuedTime** | **string** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] [default to undefined]
19+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
20+
**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
21+
**tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
22+
**machineDetectionResult** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] [default to undefined]
23+
24+
## Example
25+
26+
```typescript
27+
import { AnswerCallback } from 'bandwidth-sdk';
28+
29+
const instance: AnswerCallback = {
30+
eventType,
31+
eventTime,
32+
accountId,
33+
applicationId,
34+
from,
35+
to,
36+
direction,
37+
callId,
38+
callUrl,
39+
enqueuedTime,
40+
startTime,
41+
answerTime,
42+
tag,
43+
machineDetectionResult,
44+
};
45+
```
46+
47+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/BridgeCompleteCallback.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# BridgeCompleteCallback
2+
3+
If the target call leaves the <Bridge>, then this callback is sent to the bridgeCompleteUrl, and the BXML returned in it is executed on the call. If this webhook is sent, the Bridge Target Complete webhook is NOT sent. This callback is also sent if any problem occurs that prevents the calls to be bridged.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**eventType** | **string** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] [default to undefined]
10+
**eventTime** | **string** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] [default to undefined]
11+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
12+
**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
13+
**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
14+
**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
15+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
16+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
17+
**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
18+
**enqueuedTime** | **string** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] [default to undefined]
19+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
20+
**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
21+
**tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
22+
**cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] [default to undefined]
23+
**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
24+
**errorId** | **string** | Bandwidth\&#39;s internal id that references the error event. | [optional] [default to undefined]
25+
26+
## Example
27+
28+
```typescript
29+
import { BridgeCompleteCallback } from 'bandwidth-sdk';
30+
31+
const instance: BridgeCompleteCallback = {
32+
eventType,
33+
eventTime,
34+
accountId,
35+
applicationId,
36+
from,
37+
to,
38+
direction,
39+
callId,
40+
callUrl,
41+
enqueuedTime,
42+
startTime,
43+
answerTime,
44+
tag,
45+
cause,
46+
errorMessage,
47+
errorId,
48+
};
49+
```
50+
51+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/BridgeTargetCompleteCallback.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# BridgeTargetCompleteCallback
2+
3+
If the originating call leaves the <Bridge>, then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**eventType** | **string** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] [default to undefined]
10+
**eventTime** | **string** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] [default to undefined]
11+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
12+
**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
13+
**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
14+
**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
15+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
16+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
17+
**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
18+
**enqueuedTime** | **string** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] [default to undefined]
19+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
20+
**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
21+
**tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
22+
23+
## Example
24+
25+
```typescript
26+
import { BridgeTargetCompleteCallback } from 'bandwidth-sdk';
27+
28+
const instance: BridgeTargetCompleteCallback = {
29+
eventType,
30+
eventTime,
31+
accountId,
32+
applicationId,
33+
from,
34+
to,
35+
direction,
36+
callId,
37+
callUrl,
38+
enqueuedTime,
39+
startTime,
40+
answerTime,
41+
tag,
42+
};
43+
```
44+
45+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)