SWI-7769 Update to Generator v7.13.0 and Add Docs

.openapi-generator/FILES

@@ -15,6 +15,161 @@ api/transcriptions-api.ts
 base.ts
 common.ts
 configuration.ts
+docs/AccountStatistics.md
+docs/AdditionalDenialReason.md
+docs/Address.md
+docs/AnswerCallback.md
+docs/BridgeCompleteCallback.md
+docs/BridgeTargetCompleteCallback.md
+docs/CallDirectionEnum.md
+docs/CallRecordingMetadata.md
+docs/CallState.md
+docs/CallStateEnum.md
+docs/CallTranscription.md
+docs/CallTranscriptionDetectedLanguageEnum.md
+docs/CallTranscriptionMetadata.md
+docs/CallTranscriptionResponse.md
+docs/CallTranscriptionTrackEnum.md
+docs/CallbackMethodEnum.md
+docs/CallbackTypeEnum.md
+docs/CallsApi.md
+docs/CardWidthEnum.md
+docs/CodeRequest.md
+docs/Conference.md
+docs/ConferenceCompletedCallback.md
+docs/ConferenceCreatedCallback.md
+docs/ConferenceMember.md
+docs/ConferenceMemberExitCallback.md
+docs/ConferenceMemberJoinCallback.md
+docs/ConferenceRecordingAvailableCallback.md
+docs/ConferenceRecordingMetadata.md
+docs/ConferenceRedirectCallback.md
+docs/ConferenceStateEnum.md
+docs/ConferencesApi.md
+docs/Contact.md
+docs/CreateCall.md
+docs/CreateCallResponse.md
+docs/CreateLookupResponse.md
+docs/CreateMessageRequestError.md
+docs/CreateMultiChannelMessageResponse.md
+docs/DeferredResult.md
+docs/DisconnectCallback.md
+docs/Diversion.md
+docs/DtmfCallback.md
+docs/Error.md
+docs/ErrorObject.md
+docs/FailureWebhook.md
+docs/FieldError.md
+docs/FileFormatEnum.md
+docs/GatherCallback.md
+docs/InitiateCallback.md
+docs/Link.md
+docs/LinksObject.md
+docs/ListMessageDirectionEnum.md
+docs/ListMessageItem.md
+docs/LookupRequest.md
+docs/LookupResult.md
+docs/LookupStatus.md
+docs/LookupStatusEnum.md
+docs/MFAApi.md
+docs/MachineDetectionCompleteCallback.md
+docs/MachineDetectionConfiguration.md
+docs/MachineDetectionModeEnum.md
+docs/MachineDetectionResult.md
+docs/Media.md
+docs/MediaApi.md
+docs/Message.md
+docs/MessageCallback.md
+docs/MessageCallbackMessage.md
+docs/MessageDirectionEnum.md
+docs/MessageRequest.md
+docs/MessageStatusEnum.md
+docs/MessageTypeEnum.md
+docs/MessagesApi.md
+docs/MessagesList.md
+docs/MessagingCodeResponse.md
+docs/MessagingRequestError.md
+docs/MfaForbiddenRequestError.md
+docs/MfaRequestError.md
+docs/MfaUnauthorizedRequestError.md
+docs/MmsMessageContent.md
+docs/MultiChannelAction.md
+docs/MultiChannelActionCalendarEvent.md
+docs/MultiChannelApi.md
+docs/MultiChannelCallbackData.md
+docs/MultiChannelChannelListObject.md
+docs/MultiChannelChannelListObjectContent.md
+docs/MultiChannelMessageCallbackData.md
+docs/MultiChannelMessageChannelEnum.md
+docs/MultiChannelMessageData.md
+docs/MultiChannelMessageDirectionEnum.md
+docs/MultiChannelMessageRequest.md
+docs/MultiChannelStatusEnum.md
+docs/OptInWorkflow.md
+docs/PageInfo.md
+docs/PhoneNumberLookupApi.md
+docs/PriorityEnum.md
+docs/RbmActionBase.md
+docs/RbmActionDial.md
+docs/RbmActionOpenUrl.md
+docs/RbmActionTypeEnum.md
+docs/RbmActionViewLocation.md
+docs/RbmCardContent.md
+docs/RbmCardContentMedia.md
+docs/RbmMediaHeightEnum.md
+docs/RbmMessageCarouselCard.md
+docs/RbmMessageContentFile.md
+docs/RbmMessageContentRichCard.md
+docs/RbmMessageContentText.md
+docs/RbmMessageMedia.md
+docs/RbmStandaloneCard.md
+docs/RecordingAvailableCallback.md
+docs/RecordingCompleteCallback.md
+docs/RecordingStateEnum.md
+docs/RecordingTranscriptionMetadata.md
+docs/RecordingTranscriptions.md
+docs/RecordingsApi.md
+docs/RedirectCallback.md
+docs/RedirectMethodEnum.md
+docs/SmsMessageContent.md
+docs/StandaloneCardOrientationEnum.md
+docs/StatisticsApi.md
+docs/StirShaken.md
+docs/TelephoneNumber.md
+docs/TfvBasicAuthentication.md
+docs/TfvCallbackStatusEnum.md
+docs/TfvError.md
+docs/TfvStatus.md
+docs/TfvStatusEnum.md
+docs/TfvSubmissionInfo.md
+docs/TfvSubmissionWrapper.md
+docs/ThumbnailAlignmentEnum.md
+docs/TnLookupRequestError.md
+docs/TollFreeVerificationApi.md
+docs/TranscribeRecording.md
+docs/Transcription.md
+docs/TranscriptionAvailableCallback.md
+docs/TranscriptionsApi.md
+docs/TransferAnswerCallback.md
+docs/TransferCompleteCallback.md
+docs/TransferDisconnectCallback.md
+docs/UpdateCall.md
+docs/UpdateCallRecording.md
+docs/UpdateConference.md
+docs/UpdateConferenceMember.md
+docs/VerificationDenialWebhook.md
+docs/VerificationRequest.md
+docs/VerificationUpdateRequest.md
+docs/VerificationWebhook.md
+docs/VerifyCodeRequest.md
+docs/VerifyCodeResponse.md
+docs/VoiceApiError.md
+docs/VoiceCodeResponse.md
+docs/WebhookSubscription.md
+docs/WebhookSubscriptionBasicAuthentication.md
+docs/WebhookSubscriptionRequestSchema.md
+docs/WebhookSubscriptionTypeEnum.md
+docs/WebhookSubscriptionsListBody.md
 git_push.sh
 index.ts
 models/account-statistics.ts

.openapi-generator/VERSION

@@ -1 +1 @@
-7.10.0
+7.13.0

docs/AccountStatistics.md

@@ -0,0 +1,22 @@
+# AccountStatistics
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currentCallQueueSize** | **number** | The number of calls currently enqueued. | [optional] [default to undefined]
+**maxCallQueueSize** | **number** | The maximum size of the queue before outgoing calls start being rejected. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountStatistics } from 'bandwidth-sdk';
+
+const instance: AccountStatistics = {
+    currentCallQueueSize,
+    maxCallQueueSize,
+};
+```
+
+[[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

@@ -0,0 +1,24 @@
+# AdditionalDenialReason
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | Reason code for denial. | [default to undefined]
+**reason** | **string** | Explanation for why a verification request was declined. | [default to undefined]
+**resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [default to undefined]
+
+## Example
+
+```typescript
+import { AdditionalDenialReason } from 'bandwidth-sdk';
+
+const instance: AdditionalDenialReason = {
+    statusCode,
+    reason,
+    resubmitAllowed,
+};
+```
+
+[[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

@@ -0,0 +1,32 @@
+# Address
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the business using the toll-free number. | [default to undefined]
+**addr1** | **string** | The address of the business using the toll-free number. | [default to undefined]
+**addr2** | **string** | The address of the business using the toll-free number. | [optional] [default to undefined]
+**city** | **string** | The city of the business using the toll-free number. | [default to undefined]
+**state** | **string** | The state of the business using the toll-free number. | [default to undefined]
+**zip** | **string** | The zip of the business using the toll-free number. | [default to undefined]
+**url** | **string** | The website of the business using the toll-free number. | [default to undefined]
+
+## Example
+
+```typescript
+import { Address } from 'bandwidth-sdk';
+
+const instance: Address = {
+    name,
+    addr1,
+    addr2,
+    city,
+    state,
+    zip,
+    url,
+};
+```
+
+[[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

@@ -0,0 +1,47 @@
+# AnswerCallback
+
+The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+**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]
+**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
+**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
+**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
+**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
+**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] [default to undefined]
+**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
+**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
+**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]
+**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
+**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
+**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]
+**machineDetectionResult** | [**MachineDetectionResult**](MachineDetectionResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnswerCallback } from 'bandwidth-sdk';
+
+const instance: AnswerCallback = {
+    eventType,
+    eventTime,
+    accountId,
+    applicationId,
+    from,
+    to,
+    direction,
+    callId,
+    callUrl,
+    enqueuedTime,
+    startTime,
+    answerTime,
+    tag,
+    machineDetectionResult,
+};
+```
+
+[[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

@@ -0,0 +1,51 @@
+# BridgeCompleteCallback
+
+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.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+**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]
+**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
+**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
+**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
+**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
+**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] [default to undefined]
+**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
+**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
+**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]
+**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
+**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
+**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]
+**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]
+**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
+**errorId** | **string** | Bandwidth\&#39;s internal id that references the error event. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BridgeCompleteCallback } from 'bandwidth-sdk';
+
+const instance: BridgeCompleteCallback = {
+    eventType,
+    eventTime,
+    accountId,
+    applicationId,
+    from,
+    to,
+    direction,
+    callId,
+    callUrl,
+    enqueuedTime,
+    startTime,
+    answerTime,
+    tag,
+    cause,
+    errorMessage,
+    errorId,
+};
+```
+
+[[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

@@ -0,0 +1,45 @@
+# BridgeTargetCompleteCallback
+
+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.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+**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]
+**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
+**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
+**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
+**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
+**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] [default to undefined]
+**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
+**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
+**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]
+**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
+**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
+**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]
+
+## Example
+
+```typescript
+import { BridgeTargetCompleteCallback } from 'bandwidth-sdk';
+
+const instance: BridgeTargetCompleteCallback = {
+    eventType,
+    eventTime,
+    accountId,
+    applicationId,
+    from,
+    to,
+    direction,
+    callId,
+    callUrl,
+    enqueuedTime,
+    startTime,
+    answerTime,
+    tag,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)