diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index ef5b34f..e986b28 100644 --- a/.openapi-generator/FILES +++ b/.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 diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index 758bb9c..eb1dc6a 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.10.0 +7.13.0 diff --git a/docs/AccountStatistics.md b/docs/AccountStatistics.md new file mode 100644 index 0000000..72f1194 --- /dev/null +++ b/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) diff --git a/docs/AdditionalDenialReason.md b/docs/AdditionalDenialReason.md new file mode 100644 index 0000000..1ec0a0f --- /dev/null +++ b/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) diff --git a/docs/Address.md b/docs/Address.md new file mode 100644 index 0000000..d2ae471 --- /dev/null +++ b/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) diff --git a/docs/AnswerCallback.md b/docs/AnswerCallback.md new file mode 100644 index 0000000..4ad5b52 --- /dev/null +++ b/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) diff --git a/docs/BridgeCompleteCallback.md b/docs/BridgeCompleteCallback.md new file mode 100644 index 0000000..90299cd --- /dev/null +++ b/docs/BridgeCompleteCallback.md @@ -0,0 +1,51 @@ +# BridgeCompleteCallback + +If the target call leaves the , 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\'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) diff --git a/docs/BridgeTargetCompleteCallback.md b/docs/BridgeTargetCompleteCallback.md new file mode 100644 index 0000000..e4cb645 --- /dev/null +++ b/docs/BridgeTargetCompleteCallback.md @@ -0,0 +1,45 @@ +# BridgeTargetCompleteCallback + +If the originating call leaves the , 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) diff --git a/docs/CallDirectionEnum.md b/docs/CallDirectionEnum.md new file mode 100644 index 0000000..08c9f44 --- /dev/null +++ b/docs/CallDirectionEnum.md @@ -0,0 +1,11 @@ +# CallDirectionEnum + +The direction of the call. + +## Enum + +* `Inbound` (value: `'inbound'`) + +* `Outbound` (value: `'outbound'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallRecordingMetadata.md b/docs/CallRecordingMetadata.md new file mode 100644 index 0000000..9ab12c3 --- /dev/null +++ b/docs/CallRecordingMetadata.md @@ -0,0 +1,56 @@ +# CallRecordingMetadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined] +**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined] +**callId** | **string** | The call id associated with the event. | [optional] [default to undefined] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined] +**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined] +**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [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] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined] +**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined] +**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] [default to undefined] +**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined] +**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined] +**status** | **string** | The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined] +**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] [default to undefined] +**transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) | | [optional] [default to undefined] +**recordingName** | **string** | A name to identify this recording. | [optional] [default to undefined] + +## Example + +```typescript +import { CallRecordingMetadata } from 'bandwidth-sdk'; + +const instance: CallRecordingMetadata = { + applicationId, + accountId, + callId, + parentCallId, + recordingId, + to, + from, + transferCallerId, + transferTo, + duration, + direction, + channels, + startTime, + endTime, + fileFormat, + status, + mediaUrl, + transcription, + recordingName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallState.md b/docs/CallState.md new file mode 100644 index 0000000..a23eae7 --- /dev/null +++ b/docs/CallState.md @@ -0,0 +1,54 @@ +# CallState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applicationId** | **string** | The application id associated with the call. | [optional] [default to undefined] +**accountId** | **string** | The account id associated with the call. | [optional] [default to undefined] +**callId** | **string** | The programmable voice API call ID. | [optional] [default to undefined] +**parentCallId** | **string** | The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer). | [optional] [default to undefined] +**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI. | [optional] [default to undefined] +**from** | **string** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined] +**state** | **string** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined] +**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] [default to undefined] +**identity** | **string** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] [default to undefined] +**enqueuedTime** | **string** | The time this call was placed in queue. | [optional] [default to undefined] +**startTime** | **string** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] [default to undefined] +**answerTime** | **string** | Populated once the call has been answered, with the time in ISO 8601 format. | [optional] [default to undefined] +**endTime** | **string** | Populated once the call has ended, with the time in ISO 8601 format. | [optional] [default to undefined] +**disconnectCause** | **string** | | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [`<Hangup>`](../../bxml/verbs/hangup.md) verb was executed, or there was no more BXML to execute; it indicates that the call ended normally. | | `busy` | Callee was busy. | | `timeout` | Call wasn\'t answered before the `callTimeout` was reached. | | `cancel` | Call was cancelled by its originator while it was ringing. | | `rejected` | Call was rejected by the callee. | | `callback-error` | BXML callback couldn\'t be delivered to your callback server. | | `invalid-bxml` | Invalid BXML was returned in response to a callback. | | `application-error` | An unsupported action was tried on the call, e.g. trying to play a .ogg audio. | | `account-limit` | Account rate limits were reached. | | `node-capacity-exceeded` | System maximum capacity was reached. | | `error` | Some error not described in any of the other causes happened on the call. | | `unknown` | Unknown error happened on the call. | Note: This list is not exhaustive and other values can appear in the future. | [optional] [default to undefined] +**errorMessage** | **string** | Populated only if the call ended with an error, with text explaining the reason. | [optional] [default to undefined] +**errorId** | **string** | Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. | [optional] [default to undefined] +**lastUpdate** | **string** | The last time the call had a state update, in ISO 8601 format. | [optional] [default to undefined] + +## Example + +```typescript +import { CallState } from 'bandwidth-sdk'; + +const instance: CallState = { + applicationId, + accountId, + callId, + parentCallId, + to, + from, + direction, + state, + stirShaken, + identity, + enqueuedTime, + startTime, + answerTime, + endTime, + disconnectCause, + errorMessage, + errorId, + lastUpdate, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallStateEnum.md b/docs/CallStateEnum.md new file mode 100644 index 0000000..b8315a8 --- /dev/null +++ b/docs/CallStateEnum.md @@ -0,0 +1,11 @@ +# CallStateEnum + +The call state. Possible values:
`active` to redirect the call (default)
`completed` to hang up the call if it is answered, cancel it if it is an unanswered outbound call, or reject it if it an unanswered inbound call + +## Enum + +* `Active` (value: `'active'`) + +* `Completed` (value: `'completed'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallTranscription.md b/docs/CallTranscription.md new file mode 100644 index 0000000..7a79cd7 --- /dev/null +++ b/docs/CallTranscription.md @@ -0,0 +1,26 @@ +# CallTranscription + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detectedLanguage** | [**CallTranscriptionDetectedLanguageEnum**](CallTranscriptionDetectedLanguageEnum.md) | | [optional] [default to undefined] +**track** | [**CallTranscriptionTrackEnum**](CallTranscriptionTrackEnum.md) | | [optional] [default to undefined] +**transcript** | **string** | The transcription itself. | [optional] [default to undefined] +**confidence** | **number** | How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). | [optional] [default to undefined] + +## Example + +```typescript +import { CallTranscription } from 'bandwidth-sdk'; + +const instance: CallTranscription = { + detectedLanguage, + track, + transcript, + confidence, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallTranscriptionDetectedLanguageEnum.md b/docs/CallTranscriptionDetectedLanguageEnum.md new file mode 100644 index 0000000..7c2bef9 --- /dev/null +++ b/docs/CallTranscriptionDetectedLanguageEnum.md @@ -0,0 +1,13 @@ +# CallTranscriptionDetectedLanguageEnum + +The detected language for this transcription. + +## Enum + +* `EnUs` (value: `'en-US'`) + +* `EsUs` (value: `'es-US'`) + +* `FrFr` (value: `'fr-FR'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallTranscriptionMetadata.md b/docs/CallTranscriptionMetadata.md new file mode 100644 index 0000000..7611b7d --- /dev/null +++ b/docs/CallTranscriptionMetadata.md @@ -0,0 +1,24 @@ +# CallTranscriptionMetadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional] [default to undefined] +**transcriptionName** | **string** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] [default to undefined] +**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] [default to undefined] + +## Example + +```typescript +import { CallTranscriptionMetadata } from 'bandwidth-sdk'; + +const instance: CallTranscriptionMetadata = { + transcriptionId, + transcriptionName, + transcriptionUrl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallTranscriptionResponse.md b/docs/CallTranscriptionResponse.md new file mode 100644 index 0000000..cea7757 --- /dev/null +++ b/docs/CallTranscriptionResponse.md @@ -0,0 +1,26 @@ +# CallTranscriptionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined] +**callId** | **string** | The call id associated with the event. | [optional] [default to undefined] +**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional] [default to undefined] +**tracks** | [**Array<CallTranscription>**](CallTranscription.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CallTranscriptionResponse } from 'bandwidth-sdk'; + +const instance: CallTranscriptionResponse = { + accountId, + callId, + transcriptionId, + tracks, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallTranscriptionTrackEnum.md b/docs/CallTranscriptionTrackEnum.md new file mode 100644 index 0000000..31d4ff1 --- /dev/null +++ b/docs/CallTranscriptionTrackEnum.md @@ -0,0 +1,11 @@ +# CallTranscriptionTrackEnum + +Which `track` this transcription is derived from. + +## Enum + +* `Inbound` (value: `'inbound'`) + +* `Outbound` (value: `'outbound'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallbackMethodEnum.md b/docs/CallbackMethodEnum.md new file mode 100644 index 0000000..3c857e6 --- /dev/null +++ b/docs/CallbackMethodEnum.md @@ -0,0 +1,11 @@ +# CallbackMethodEnum + +The HTTP method to use to deliver the callback. GET or POST. Default value is POST. + +## Enum + +* `Get` (value: `'GET'`) + +* `Post` (value: `'POST'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallbackTypeEnum.md b/docs/CallbackTypeEnum.md new file mode 100644 index 0000000..d467cc5 --- /dev/null +++ b/docs/CallbackTypeEnum.md @@ -0,0 +1,15 @@ +# CallbackTypeEnum + +Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks. + +## Enum + +* `MessageReceived` (value: `'message-received'`) + +* `MessageSending` (value: `'message-sending'`) + +* `MessageDelivered` (value: `'message-delivered'`) + +* `MessageFailed` (value: `'message-failed'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CallsApi.md b/docs/CallsApi.md new file mode 100644 index 0000000..2763650 --- /dev/null +++ b/docs/CallsApi.md @@ -0,0 +1,350 @@ +# CallsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createCall**](#createcall) | **POST** /accounts/{accountId}/calls | Create Call| +|[**getCallState**](#getcallstate) | **GET** /accounts/{accountId}/calls/{callId} | Get Call State Information| +|[**listCalls**](#listcalls) | **GET** /accounts/{accountId}/calls | Get Calls| +|[**updateCall**](#updatecall) | **POST** /accounts/{accountId}/calls/{callId} | Update Call| +|[**updateCallBxml**](#updatecallbxml) | **PUT** /accounts/{accountId}/calls/{callId}/bxml | Update Call BXML| + +# **createCall** +> CreateCallResponse createCall(createCall) + +Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. Please note: Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed. + +### Example + +```typescript +import { + CallsApi, + Configuration, + CreateCall +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new CallsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let createCall: CreateCall; //JSON object containing information to create an outbound call + +const { status, data } = await apiInstance.createCall( + accountId, + createCall +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createCall** | **CreateCall**| JSON object containing information to create an outbound call | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**CreateCallResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created | * Location - The URL for further interactions with this call
| +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getCallState** +> CallState getCallState() + +Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response. + +### Example + +```typescript +import { + CallsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new CallsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) + +const { status, data } = await apiInstance.getCallState( + accountId, + callId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| + + +### Return type + +**CallState** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listCalls** +> Array listCalls() + +Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of calls in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response. + +### Example + +```typescript +import { + CallsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new CallsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let to: string; //Filter results by the `to` field. (optional) (default to undefined) +let from: string; //Filter results by the `from` field. (optional) (default to undefined) +let minStartTime: string; //Filter results to calls which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional) (default to undefined) +let maxStartTime: string; //Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format). (optional) (default to undefined) +let disconnectCause: string; //Filter results to calls with specified call Disconnect Cause. (optional) (default to undefined) +let pageSize: number; //Specifies the max number of calls that will be returned. (optional) (default to 1000) +let pageToken: string; //Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional) (default to undefined) + +const { status, data } = await apiInstance.listCalls( + accountId, + to, + from, + minStartTime, + maxStartTime, + disconnectCause, + pageSize, + pageToken +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **to** | [**string**] | Filter results by the `to` field. | (optional) defaults to undefined| +| **from** | [**string**] | Filter results by the `from` field. | (optional) defaults to undefined| +| **minStartTime** | [**string**] | Filter results to calls which have a `startTime` after or including `minStartTime` (in ISO8601 format). | (optional) defaults to undefined| +| **maxStartTime** | [**string**] | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format). | (optional) defaults to undefined| +| **disconnectCause** | [**string**] | Filter results to calls with specified call Disconnect Cause. | (optional) defaults to undefined| +| **pageSize** | [**number**] | Specifies the max number of calls that will be returned. | (optional) defaults to 1000| +| **pageToken** | [**string**] | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateCall** +> updateCall(updateCall) + +Interrupts and redirects a call to a different URL that should return a BXML document. + +### Example + +```typescript +import { + CallsApi, + Configuration, + UpdateCall +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new CallsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let updateCall: UpdateCall; //JSON object containing information to redirect an existing call to a new BXML document + +const { status, data } = await apiInstance.updateCall( + accountId, + callId, + updateCall +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateCall** | **UpdateCall**| JSON object containing information to redirect an existing call to a new BXML document | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**409** | Conflict | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateCallBxml** +> updateCallBxml(body) + +Interrupts and replaces an active call\'s BXML document. + +### Example + +```typescript +import { + CallsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new CallsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let body: string; // + +const { status, data } = await apiInstance.updateCallBxml( + accountId, + callId, + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **string**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/xml + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Call BXML was successfully replaced. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**409** | Conflict | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CardWidthEnum.md b/docs/CardWidthEnum.md new file mode 100644 index 0000000..47dcca5 --- /dev/null +++ b/docs/CardWidthEnum.md @@ -0,0 +1,10 @@ +# CardWidthEnum + + +## Enum + +* `Small` (value: `'SMALL'`) + +* `Medium` (value: `'MEDIUM'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CodeRequest.md b/docs/CodeRequest.md new file mode 100644 index 0000000..047f6d8 --- /dev/null +++ b/docs/CodeRequest.md @@ -0,0 +1,30 @@ +# CodeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**to** | **string** | The phone number to send the mfa code to. | [default to undefined] +**from** | **string** | The application phone number, the sender of the mfa code. | [default to undefined] +**applicationId** | **string** | The application unique ID, obtained from Bandwidth. | [default to undefined] +**scope** | **string** | An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\". | [optional] [default to undefined] +**message** | **string** | The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server. | [default to undefined] +**digits** | **number** | The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively. | [default to undefined] + +## Example + +```typescript +import { CodeRequest } from 'bandwidth-sdk'; + +const instance: CodeRequest = { + to, + from, + applicationId, + scope, + message, + digits, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Conference.md b/docs/Conference.md new file mode 100644 index 0000000..10c750d --- /dev/null +++ b/docs/Conference.md @@ -0,0 +1,34 @@ +# Conference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The Bandwidth-generated conference ID. | [optional] [default to undefined] +**name** | **string** | The name of the conference, as specified by your application. | [optional] [default to undefined] +**createdTime** | **string** | The time the conference was initiated, in ISO 8601 format. | [optional] [default to undefined] +**completedTime** | **string** | The time the conference was terminated, in ISO 8601 format. | [optional] [default to undefined] +**conferenceEventUrl** | **string** | The URL to send the conference-related events. | [optional] [default to undefined] +**conferenceEventMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**tag** | **string** | The custom string attached to the conference that will be sent with callbacks. | [optional] [default to undefined] +**activeMembers** | [**Array<ConferenceMember>**](ConferenceMember.md) | A list of active members of the conference. Omitted if this is a response to the [Get Conferences endpoint](/apis/voice#tag/Conferences/operation/listConferences). | [optional] [default to undefined] + +## Example + +```typescript +import { Conference } from 'bandwidth-sdk'; + +const instance: Conference = { + id, + name, + createdTime, + completedTime, + conferenceEventUrl, + conferenceEventMethod, + tag, + activeMembers, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ConferenceCompletedCallback.md b/docs/ConferenceCompletedCallback.md new file mode 100644 index 0000000..330acc8 --- /dev/null +++ b/docs/ConferenceCompletedCallback.md @@ -0,0 +1,29 @@ +# ConferenceCompletedCallback + +The Conference Completed event is fired when the last member leaves the conference. The response to this event may not contain BXML. + +## 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] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [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 { ConferenceCompletedCallback } from 'bandwidth-sdk'; + +const instance: ConferenceCompletedCallback = { + eventType, + eventTime, + conferenceId, + name, + 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) diff --git a/docs/ConferenceCreatedCallback.md b/docs/ConferenceCreatedCallback.md new file mode 100644 index 0000000..bb9c11e --- /dev/null +++ b/docs/ConferenceCreatedCallback.md @@ -0,0 +1,29 @@ +# ConferenceCreatedCallback + +The Conference Created event is fired whenever a new conference that specified a callbackUrl is created. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. + +## 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] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [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 { ConferenceCreatedCallback } from 'bandwidth-sdk'; + +const instance: ConferenceCreatedCallback = { + eventType, + eventTime, + conferenceId, + name, + 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) diff --git a/docs/ConferenceMember.md b/docs/ConferenceMember.md new file mode 100644 index 0000000..f1742c5 --- /dev/null +++ b/docs/ConferenceMember.md @@ -0,0 +1,30 @@ +# ConferenceMember + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**callId** | **string** | The call id associated with the event. | [optional] [default to undefined] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] [default to undefined] +**mute** | **boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member\'s mute status. Has no effect if omitted. | [optional] [default to undefined] +**hold** | **boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member\'s hold status. Has no effect if omitted. | [optional] [default to undefined] +**callIdsToCoach** | **Array<string>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] [default to undefined] + +## Example + +```typescript +import { ConferenceMember } from 'bandwidth-sdk'; + +const instance: ConferenceMember = { + callId, + conferenceId, + memberUrl, + mute, + hold, + callIdsToCoach, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ConferenceMemberExitCallback.md b/docs/ConferenceMemberExitCallback.md new file mode 100644 index 0000000..5441552 --- /dev/null +++ b/docs/ConferenceMemberExitCallback.md @@ -0,0 +1,35 @@ +# ConferenceMemberExitCallback + +The Conference Member Exit event is fired whenever a caller exits a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. + +## 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] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [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] +**callId** | **string** | The call id associated with the event. | [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 { ConferenceMemberExitCallback } from 'bandwidth-sdk'; + +const instance: ConferenceMemberExitCallback = { + eventType, + eventTime, + conferenceId, + name, + from, + to, + callId, + 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) diff --git a/docs/ConferenceMemberJoinCallback.md b/docs/ConferenceMemberJoinCallback.md new file mode 100644 index 0000000..c952039 --- /dev/null +++ b/docs/ConferenceMemberJoinCallback.md @@ -0,0 +1,35 @@ +# ConferenceMemberJoinCallback + +The Conference Member Join event is fired whenever a caller joins a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. + +## 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] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [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] +**callId** | **string** | The call id associated with the event. | [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 { ConferenceMemberJoinCallback } from 'bandwidth-sdk'; + +const instance: ConferenceMemberJoinCallback = { + eventType, + eventTime, + conferenceId, + name, + from, + to, + callId, + 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) diff --git a/docs/ConferenceRecordingAvailableCallback.md b/docs/ConferenceRecordingAvailableCallback.md new file mode 100644 index 0000000..3b40771 --- /dev/null +++ b/docs/ConferenceRecordingAvailableCallback.md @@ -0,0 +1,47 @@ +# ConferenceRecordingAvailableCallback + +The Conference Recording Available event is sent after a conference recording has been processed. It indicates that the recording is available for download. + +## 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] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] +**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined] +**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined] +**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] [default to undefined] +**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined] +**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined] +**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined] +**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [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] +**status** | **string** | The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined] + +## Example + +```typescript +import { ConferenceRecordingAvailableCallback } from 'bandwidth-sdk'; + +const instance: ConferenceRecordingAvailableCallback = { + eventType, + eventTime, + conferenceId, + name, + accountId, + recordingId, + channels, + startTime, + endTime, + duration, + fileFormat, + mediaUrl, + tag, + status, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ConferenceRecordingMetadata.md b/docs/ConferenceRecordingMetadata.md new file mode 100644 index 0000000..b344f09 --- /dev/null +++ b/docs/ConferenceRecordingMetadata.md @@ -0,0 +1,42 @@ +# ConferenceRecordingMetadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] +**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined] +**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined] +**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] [default to undefined] +**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined] +**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined] +**status** | **string** | The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined] +**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] [default to undefined] +**recordingName** | **string** | A name to identify this recording. | [optional] [default to undefined] + +## Example + +```typescript +import { ConferenceRecordingMetadata } from 'bandwidth-sdk'; + +const instance: ConferenceRecordingMetadata = { + accountId, + conferenceId, + name, + recordingId, + duration, + channels, + startTime, + endTime, + fileFormat, + status, + mediaUrl, + recordingName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ConferenceRedirectCallback.md b/docs/ConferenceRedirectCallback.md new file mode 100644 index 0000000..321d30d --- /dev/null +++ b/docs/ConferenceRedirectCallback.md @@ -0,0 +1,29 @@ +# ConferenceRedirectCallback + +The Conference Redirect event is fired whenever an existing conference is modified via a POST request made to the /conferences/{conferenceId} endpoint. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. + +## 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] +**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] +**name** | **string** | The user-specified name of the conference that was recorded | [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 { ConferenceRedirectCallback } from 'bandwidth-sdk'; + +const instance: ConferenceRedirectCallback = { + eventType, + eventTime, + conferenceId, + name, + 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) diff --git a/docs/ConferenceStateEnum.md b/docs/ConferenceStateEnum.md new file mode 100644 index 0000000..2b76fcb --- /dev/null +++ b/docs/ConferenceStateEnum.md @@ -0,0 +1,11 @@ +# ConferenceStateEnum + +Setting the conference state to `completed` ends the conference and ejects all members. + +## Enum + +* `Active` (value: `'active'`) + +* `Completed` (value: `'completed'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ConferencesApi.md b/docs/ConferencesApi.md new file mode 100644 index 0000000..0e651cc --- /dev/null +++ b/docs/ConferencesApi.md @@ -0,0 +1,609 @@ +# ConferencesApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**downloadConferenceRecording**](#downloadconferencerecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media | Download Conference Recording| +|[**getConference**](#getconference) | **GET** /accounts/{accountId}/conferences/{conferenceId} | Get Conference Information| +|[**getConferenceMember**](#getconferencemember) | **GET** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Get Conference Member| +|[**getConferenceRecording**](#getconferencerecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId} | Get Conference Recording Information| +|[**listConferenceRecordings**](#listconferencerecordings) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings | Get Conference Recordings| +|[**listConferences**](#listconferences) | **GET** /accounts/{accountId}/conferences | Get Conferences| +|[**updateConference**](#updateconference) | **POST** /accounts/{accountId}/conferences/{conferenceId} | Update Conference| +|[**updateConferenceBxml**](#updateconferencebxml) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/bxml | Update Conference BXML| +|[**updateConferenceMember**](#updateconferencemember) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Update Conference Member| + +# **downloadConferenceRecording** +> File downloadConferenceRecording() + +Downloads the specified recording file. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.downloadConferenceRecording( + accountId, + conferenceId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +**File** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/vnd.wave, audio/mpeg, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getConference** +> Conference getConference() + +Returns information about the specified conference. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) + +const { status, data } = await apiInstance.getConference( + accountId, + conferenceId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| + + +### Return type + +**Conference** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getConferenceMember** +> ConferenceMember getConferenceMember() + +Returns information about the specified conference member. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) +let memberId: string; //Programmable Voice API Conference Member ID. (default to undefined) + +const { status, data } = await apiInstance.getConferenceMember( + accountId, + conferenceId, + memberId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| +| **memberId** | [**string**] | Programmable Voice API Conference Member ID. | defaults to undefined| + + +### Return type + +**ConferenceMember** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getConferenceRecording** +> ConferenceRecordingMetadata getConferenceRecording() + +Returns metadata for the specified recording. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.getConferenceRecording( + accountId, + conferenceId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +**ConferenceRecordingMetadata** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listConferenceRecordings** +> Array listConferenceRecordings() + +Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) + +const { status, data } = await apiInstance.listConferenceRecordings( + accountId, + conferenceId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listConferences** +> Array listConferences() + +Returns a max of 1000 conferences, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of conference records. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let name: string; //Filter results by the `name` field. (optional) (default to undefined) +let minCreatedTime: string; //Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). (optional) (default to undefined) +let maxCreatedTime: string; //Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). (optional) (default to undefined) +let pageSize: number; //Specifies the max number of conferences that will be returned. (optional) (default to 1000) +let pageToken: string; //Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional) (default to undefined) + +const { status, data } = await apiInstance.listConferences( + accountId, + name, + minCreatedTime, + maxCreatedTime, + pageSize, + pageToken +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **name** | [**string**] | Filter results by the `name` field. | (optional) defaults to undefined| +| **minCreatedTime** | [**string**] | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). | (optional) defaults to undefined| +| **maxCreatedTime** | [**string**] | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). | (optional) defaults to undefined| +| **pageSize** | [**number**] | Specifies the max number of conferences that will be returned. | (optional) defaults to 1000| +| **pageToken** | [**string**] | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateConference** +> updateConference(updateConference) + +Update the conference state. + +### Example + +```typescript +import { + ConferencesApi, + Configuration, + UpdateConference +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) +let updateConference: UpdateConference; // + +const { status, data } = await apiInstance.updateConference( + accountId, + conferenceId, + updateConference +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateConference** | **UpdateConference**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Conference was successfully modified. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateConferenceBxml** +> updateConferenceBxml(body) + +Update the conference BXML document. + +### Example + +```typescript +import { + ConferencesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) +let body: string; // + +const { status, data } = await apiInstance.updateConferenceBxml( + accountId, + conferenceId, + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **string**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/xml + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Conference successfully modified. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateConferenceMember** +> updateConferenceMember(updateConferenceMember) + +Updates settings for a particular conference member. + +### Example + +```typescript +import { + ConferencesApi, + Configuration, + UpdateConferenceMember +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new ConferencesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined) +let memberId: string; //Programmable Voice API Conference Member ID. (default to undefined) +let updateConferenceMember: UpdateConferenceMember; // + +const { status, data } = await apiInstance.updateConferenceMember( + accountId, + conferenceId, + memberId, + updateConferenceMember +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateConferenceMember** | **UpdateConferenceMember**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined| +| **memberId** | [**string**] | Programmable Voice API Conference Member ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Conference member was successfully modified. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Contact.md b/docs/Contact.md new file mode 100644 index 0000000..02e7400 --- /dev/null +++ b/docs/Contact.md @@ -0,0 +1,26 @@ +# Contact + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**firstName** | **string** | The first name of the business contact using the toll-free number. | [default to undefined] +**lastName** | **string** | The last name of the business contact using the toll-free number. | [default to undefined] +**email** | **string** | | [default to undefined] +**phoneNumber** | **string** | Contact telephone number | [default to undefined] + +## Example + +```typescript +import { Contact } from 'bandwidth-sdk'; + +const instance: Contact = { + firstName, + lastName, + email, + phoneNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateCall.md b/docs/CreateCall.md new file mode 100644 index 0000000..6a3f5d8 --- /dev/null +++ b/docs/CreateCall.md @@ -0,0 +1,60 @@ +# CreateCall + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**to** | **string** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | [default to undefined] +**from** | **string** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | [default to undefined] +**privacy** | **boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] [default to undefined] +**displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] [default to undefined] +**uui** | **string** | A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] [default to undefined] +**applicationId** | **string** | The id of the application associated with the `from` number. | [default to undefined] +**answerUrl** | **string** | The full URL to send the <a href=\'/docs/voice/webhooks/answer\'>Answer</a> event to when the called party answers. This endpoint should return the first <a href=\'/docs/voice/bxml\'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | [default to undefined] +**answerMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**username** | **string** | Basic auth username. | [optional] [default to undefined] +**password** | **string** | Basic auth password. | [optional] [default to undefined] +**answerFallbackUrl** | **string** | A fallback url which, if provided, will be used to retry the `answer` webhook delivery in case `answerUrl` fails to respond Must use `https` if specifying `fallbackUsername` and `fallbackPassword`. | [optional] [default to undefined] +**answerFallbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined] +**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined] +**disconnectUrl** | **string** | The URL to send the <a href=\'/docs/voice/webhooks/disconnect\'>Disconnect</a> event to when the call ends. This event does not expect a BXML response. | [optional] [default to undefined] +**disconnectMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**callTimeout** | **number** | The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Can be any numeric value (including decimals) between 1 and 300. | [optional] [default to 30] +**callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. | [optional] [default to 15] +**machineDetection** | [**MachineDetectionConfiguration**](MachineDetectionConfiguration.md) | | [optional] [default to undefined] +**priority** | **number** | The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. | [optional] [default to 5] +**tag** | **string** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href=\'/docs/voice/bxml/tag\'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=\"\"` Max length 256 characters. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateCall } from 'bandwidth-sdk'; + +const instance: CreateCall = { + to, + from, + privacy, + displayName, + uui, + applicationId, + answerUrl, + answerMethod, + username, + password, + answerFallbackUrl, + answerFallbackMethod, + fallbackUsername, + fallbackPassword, + disconnectUrl, + disconnectMethod, + callTimeout, + callbackTimeout, + machineDetection, + priority, + 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) diff --git a/docs/CreateCallResponse.md b/docs/CreateCallResponse.md new file mode 100644 index 0000000..8f32138 --- /dev/null +++ b/docs/CreateCallResponse.md @@ -0,0 +1,60 @@ +# CreateCallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applicationId** | **string** | The id of the application associated with the `from` number. | [default to undefined] +**accountId** | **string** | The bandwidth account ID associated with the call. | [default to undefined] +**callId** | **string** | Programmable Voice API Call ID. | [default to undefined] +**to** | **string** | Recipient of the outgoing call. | [default to undefined] +**from** | **string** | Phone number that created the outbound call. | [default to undefined] +**enqueuedTime** | **string** | The time at which the call was accepted into the queue. | [optional] [default to undefined] +**callUrl** | **string** | The URL to update this call\'s state. | [default to undefined] +**callTimeout** | **number** | The timeout (in seconds) for the callee to answer the call after it starts ringing. | [optional] [default to undefined] +**callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering webhooks for the call. | [optional] [default to undefined] +**tag** | **string** | Custom tag value. | [optional] [default to undefined] +**answerMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [default to undefined] +**answerUrl** | **string** | URL to deliver the `answer` event webhook. | [default to undefined] +**answerFallbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**answerFallbackUrl** | **string** | Fallback URL to deliver the `answer` event webhook. | [optional] [default to undefined] +**disconnectMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [default to undefined] +**disconnectUrl** | **string** | URL to deliver the `disconnect` event webhook. | [optional] [default to undefined] +**username** | **string** | Basic auth username. | [optional] [default to undefined] +**password** | **string** | Basic auth password. | [optional] [default to undefined] +**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined] +**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined] +**priority** | **number** | The priority of this call over other calls from your account. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateCallResponse } from 'bandwidth-sdk'; + +const instance: CreateCallResponse = { + applicationId, + accountId, + callId, + to, + from, + enqueuedTime, + callUrl, + callTimeout, + callbackTimeout, + tag, + answerMethod, + answerUrl, + answerFallbackMethod, + answerFallbackUrl, + disconnectMethod, + disconnectUrl, + username, + password, + fallbackUsername, + fallbackPassword, + priority, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateLookupResponse.md b/docs/CreateLookupResponse.md new file mode 100644 index 0000000..b37c651 --- /dev/null +++ b/docs/CreateLookupResponse.md @@ -0,0 +1,23 @@ +# CreateLookupResponse + +The request has been accepted for processing but not yet finished and in a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED). + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined] +**status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CreateLookupResponse } from 'bandwidth-sdk'; + +const instance: CreateLookupResponse = { + requestId, + status, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateMessageRequestError.md b/docs/CreateMessageRequestError.md new file mode 100644 index 0000000..e367604 --- /dev/null +++ b/docs/CreateMessageRequestError.md @@ -0,0 +1,24 @@ +# CreateMessageRequestError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**description** | **string** | | [default to undefined] +**fieldErrors** | [**Array<FieldError>**](FieldError.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CreateMessageRequestError } from 'bandwidth-sdk'; + +const instance: CreateMessageRequestError = { + type, + description, + fieldErrors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateMultiChannelMessageResponse.md b/docs/CreateMultiChannelMessageResponse.md new file mode 100644 index 0000000..90c8af9 --- /dev/null +++ b/docs/CreateMultiChannelMessageResponse.md @@ -0,0 +1,24 @@ +# CreateMultiChannelMessageResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Array<Link>**](Link.md) | | [optional] [default to undefined] +**data** | [**MultiChannelMessageData**](MultiChannelMessageData.md) | | [optional] [default to undefined] +**errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CreateMultiChannelMessageResponse } from 'bandwidth-sdk'; + +const instance: CreateMultiChannelMessageResponse = { + links, + data, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DeferredResult.md b/docs/DeferredResult.md new file mode 100644 index 0000000..843e45b --- /dev/null +++ b/docs/DeferredResult.md @@ -0,0 +1,22 @@ +# DeferredResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | **object** | | [optional] [default to undefined] +**setOrExpired** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { DeferredResult } from 'bandwidth-sdk'; + +const instance: DeferredResult = { + result, + setOrExpired, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DisconnectCallback.md b/docs/DisconnectCallback.md new file mode 100644 index 0000000..69bee1c --- /dev/null +++ b/docs/DisconnectCallback.md @@ -0,0 +1,53 @@ +# DisconnectCallback + +The Disconnect event is fired when a call ends, for any reason. + +## 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] +**callId** | **string** | The call id associated with the event. | [optional] [default to undefined] +**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [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] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [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\'s internal id that references the error event. | [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 { DisconnectCallback } from 'bandwidth-sdk'; + +const instance: DisconnectCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + callId, + direction, + callUrl, + enqueuedTime, + startTime, + answerTime, + endTime, + cause, + errorMessage, + errorId, + 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) diff --git a/docs/Diversion.md b/docs/Diversion.md new file mode 100644 index 0000000..7b30773 --- /dev/null +++ b/docs/Diversion.md @@ -0,0 +1,32 @@ +# Diversion + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **string** | The reason for the diversion. Common values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. | [optional] [default to undefined] +**privacy** | **string** | off or full | [optional] [default to undefined] +**screen** | **string** | No if the number was provided by the user, yes if the number was provided by the network | [optional] [default to undefined] +**counter** | **string** | The number of diversions that have occurred | [optional] [default to undefined] +**limit** | **string** | The maximum number of diversions allowed for this session | [optional] [default to undefined] +**unknown** | **string** | The normal list of values is not exhaustive. Your application must be tolerant of unlisted keys and unlisted values of those keys. | [optional] [default to undefined] +**origTo** | **string** | Always present. Indicates the last telephone number that the call was diverted from. | [optional] [default to undefined] + +## Example + +```typescript +import { Diversion } from 'bandwidth-sdk'; + +const instance: Diversion = { + reason, + privacy, + screen, + counter, + limit, + unknown, + origTo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DtmfCallback.md b/docs/DtmfCallback.md new file mode 100644 index 0000000..c7e7e8f --- /dev/null +++ b/docs/DtmfCallback.md @@ -0,0 +1,53 @@ +# DtmfCallback + +The DTMF event is sent for every digit detected after a verb is executed. You may not respond to this event with BXML. + +## 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] +**callId** | **string** | The call id associated with the event. | [optional] [default to undefined] +**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined] +**digit** | **string** | The digit collected in the call. | [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] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [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 { DtmfCallback } from 'bandwidth-sdk'; + +const instance: DtmfCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + callId, + direction, + digit, + callUrl, + enqueuedTime, + startTime, + answerTime, + parentCallId, + transferCallerId, + transferTo, + 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) diff --git a/docs/Error.md b/docs/Error.md new file mode 100644 index 0000000..3514538 --- /dev/null +++ b/docs/Error.md @@ -0,0 +1,24 @@ +# ModelError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **number** | | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**telephoneNumbers** | [**Array<TelephoneNumber>**](TelephoneNumber.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { ModelError } from 'bandwidth-sdk'; + +const instance: ModelError = { + code, + description, + telephoneNumbers, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ErrorObject.md b/docs/ErrorObject.md new file mode 100644 index 0000000..5bbdd48 --- /dev/null +++ b/docs/ErrorObject.md @@ -0,0 +1,22 @@ +# ErrorObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **string** | | [optional] [default to undefined] +**message** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ErrorObject } from 'bandwidth-sdk'; + +const instance: ErrorObject = { + code, + message, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/FailureWebhook.md b/docs/FailureWebhook.md new file mode 100644 index 0000000..b84f070 --- /dev/null +++ b/docs/FailureWebhook.md @@ -0,0 +1,30 @@ +# FailureWebhook + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **string** | User\'s account ID. | [optional] [default to undefined] +**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined] +**errorCode** | **string** | An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. | [optional] [default to undefined] +**errorDescription** | **string** | A description of the error that was encountered. | [optional] [default to undefined] +**errors** | **Array<string>** | Details of the errors that were encountered when processing the request. | [optional] [default to undefined] +**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined] + +## Example + +```typescript +import { FailureWebhook } from 'bandwidth-sdk'; + +const instance: FailureWebhook = { + accountId, + phoneNumber, + errorCode, + errorDescription, + errors, + internalTicketNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/FieldError.md b/docs/FieldError.md new file mode 100644 index 0000000..4d15bd3 --- /dev/null +++ b/docs/FieldError.md @@ -0,0 +1,22 @@ +# FieldError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fieldName** | **string** | The name of the field that contains the error | [optional] [default to undefined] +**description** | **string** | The error associated with the field | [optional] [default to undefined] + +## Example + +```typescript +import { FieldError } from 'bandwidth-sdk'; + +const instance: FieldError = { + fieldName, + description, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/FileFormatEnum.md b/docs/FileFormatEnum.md new file mode 100644 index 0000000..3874fc9 --- /dev/null +++ b/docs/FileFormatEnum.md @@ -0,0 +1,11 @@ +# FileFormatEnum + +The format that the recording is stored in. + +## Enum + +* `Mp3` (value: `'mp3'`) + +* `Wav` (value: `'wav'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GatherCallback.md b/docs/GatherCallback.md new file mode 100644 index 0000000..1555aa1 --- /dev/null +++ b/docs/GatherCallback.md @@ -0,0 +1,55 @@ +# GatherCallback + +The gather event is sent after a verb is executed. Its purpose is to report the gathered digits to the calling application. + +## 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] +**digits** | **string** | (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. | [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] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined] +**terminatingDigit** | **string** | (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. | [optional] [default to undefined] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [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 { GatherCallback } from 'bandwidth-sdk'; + +const instance: GatherCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + digits, + callUrl, + enqueuedTime, + startTime, + answerTime, + parentCallId, + terminatingDigit, + transferCallerId, + transferTo, + 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) diff --git a/docs/InitiateCallback.md b/docs/InitiateCallback.md new file mode 100644 index 0000000..7a28b4c --- /dev/null +++ b/docs/InitiateCallback.md @@ -0,0 +1,45 @@ +# InitiateCallback + +The Initiate event is fired when an inbound call is received for a Telephone Number on your Account. It is sent to the URL specified in the application associated with the location (sip-peer) that the called telephone number belongs to. + +## 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] +**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined] +**diversion** | [**Diversion**](Diversion.md) | | [optional] [default to undefined] +**stirShaken** | [**StirShaken**](StirShaken.md) | | [optional] [default to undefined] +**uui** | **string** | The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] [default to undefined] + +## Example + +```typescript +import { InitiateCallback } from 'bandwidth-sdk'; + +const instance: InitiateCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + startTime, + diversion, + stirShaken, + uui, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Link.md b/docs/Link.md new file mode 100644 index 0000000..c639658 --- /dev/null +++ b/docs/Link.md @@ -0,0 +1,22 @@ +# Link + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rel** | **string** | | [optional] [default to undefined] +**href** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { Link } from 'bandwidth-sdk'; + +const instance: Link = { + rel, + href, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LinksObject.md b/docs/LinksObject.md new file mode 100644 index 0000000..164c299 --- /dev/null +++ b/docs/LinksObject.md @@ -0,0 +1,26 @@ +# LinksObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first** | **string** | The first (or only) page of results matching the query. | [optional] [default to undefined] +**next** | **string** | If more results exist than specified by \'size\', this link returns the next page of \'size\' results. | [optional] [default to undefined] +**previous** | **string** | If the results are more than one page, this link returns the previous page of \'size\' results. | [optional] [default to undefined] +**last** | **string** | If more results exist than specified by \'size\', this link return the last page of result. | [optional] [default to undefined] + +## Example + +```typescript +import { LinksObject } from 'bandwidth-sdk'; + +const instance: LinksObject = { + first, + next, + previous, + last, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListMessageDirectionEnum.md b/docs/ListMessageDirectionEnum.md new file mode 100644 index 0000000..657380d --- /dev/null +++ b/docs/ListMessageDirectionEnum.md @@ -0,0 +1,11 @@ +# ListMessageDirectionEnum + +The direction of the message. One of INBOUND OUTBOUND. + +## Enum + +* `Inbound` (value: `'INBOUND'`) + +* `Outbound` (value: `'OUTBOUND'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListMessageItem.md b/docs/ListMessageItem.md new file mode 100644 index 0000000..3fbfc91 --- /dev/null +++ b/docs/ListMessageItem.md @@ -0,0 +1,52 @@ +# ListMessageItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageId** | **string** | The message id | [optional] [default to undefined] +**accountId** | **string** | The account id associated with this message. | [optional] [default to undefined] +**sourceTn** | **string** | The source phone number of the message. | [optional] [default to undefined] +**destinationTn** | **string** | The recipient phone number of the message. | [optional] [default to undefined] +**messageStatus** | [**MessageStatusEnum**](MessageStatusEnum.md) | | [optional] [default to undefined] +**messageDirection** | [**ListMessageDirectionEnum**](ListMessageDirectionEnum.md) | | [optional] [default to undefined] +**messageType** | [**MessageTypeEnum**](MessageTypeEnum.md) | | [optional] [default to undefined] +**segmentCount** | **number** | The number of segments the message was sent as. | [optional] [default to undefined] +**errorCode** | **number** | The numeric error code of the message. | [optional] [default to undefined] +**receiveTime** | **string** | The ISO 8601 datetime of the message. | [optional] [default to undefined] +**carrierName** | **string** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] [default to undefined] +**messageSize** | **number** | The size of the message including message content and headers. | [optional] [default to undefined] +**messageLength** | **number** | The length of the message content. | [optional] [default to undefined] +**attachmentCount** | **number** | The number of attachments the message has. | [optional] [default to undefined] +**recipientCount** | **number** | The number of recipients the message has. | [optional] [default to undefined] +**campaignClass** | **string** | The campaign class of the message if it has one. | [optional] [default to undefined] +**campaignId** | **string** | The campaign ID of the message if it has one. | [optional] [default to undefined] + +## Example + +```typescript +import { ListMessageItem } from 'bandwidth-sdk'; + +const instance: ListMessageItem = { + messageId, + accountId, + sourceTn, + destinationTn, + messageStatus, + messageDirection, + messageType, + segmentCount, + errorCode, + receiveTime, + carrierName, + messageSize, + messageLength, + attachmentCount, + recipientCount, + campaignClass, + campaignId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupRequest.md b/docs/LookupRequest.md new file mode 100644 index 0000000..39fe75e --- /dev/null +++ b/docs/LookupRequest.md @@ -0,0 +1,21 @@ +# LookupRequest + +Create phone number lookup request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tns** | **Array<string>** | | [default to undefined] + +## Example + +```typescript +import { LookupRequest } from 'bandwidth-sdk'; + +const instance: LookupRequest = { + tns, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupResult.md b/docs/LookupResult.md new file mode 100644 index 0000000..3072615 --- /dev/null +++ b/docs/LookupResult.md @@ -0,0 +1,37 @@ +# LookupResult + +Carrier information results for the specified telephone number. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Response_Code** | **number** | Our vendor\'s response code. | [optional] [default to undefined] +**Message** | **string** | Message associated with the response code. | [optional] [default to undefined] +**E_164_Format** | **string** | The telephone number in E.164 format. | [optional] [default to undefined] +**Formatted** | **string** | The formatted version of the telephone number. | [optional] [default to undefined] +**Country** | **string** | The country of the telephone number. | [optional] [default to undefined] +**Line_Type** | **string** | The line type of the telephone number. | [optional] [default to undefined] +**Line_Provider** | **string** | The messaging service provider of the telephone number. | [optional] [default to undefined] +**Mobile_Country_Code** | **string** | The first half of the Home Network Identity (HNI). | [optional] [default to undefined] +**Mobile_Network_Code** | **string** | The second half of the HNI. | [optional] [default to undefined] + +## Example + +```typescript +import { LookupResult } from 'bandwidth-sdk'; + +const instance: LookupResult = { + Response_Code, + Message, + E_164_Format, + Formatted, + Country, + Line_Type, + Line_Provider, + Mobile_Country_Code, + Mobile_Network_Code, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupStatus.md b/docs/LookupStatus.md new file mode 100644 index 0000000..86001a9 --- /dev/null +++ b/docs/LookupStatus.md @@ -0,0 +1,27 @@ +# LookupStatus + +If requestId exists, the result for that request is returned. See the Examples for details on the various responses that you can receive. Generally, if you see a Response Code of 0 in a result for a TN, information will be available for it. Any other Response Code will indicate no information was available for the TN. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **string** | The requestId. | [optional] [default to undefined] +**status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined] +**result** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] [default to undefined] +**failedTelephoneNumbers** | **Array<string>** | The telephone numbers whose lookup failed. | [optional] [default to undefined] + +## Example + +```typescript +import { LookupStatus } from 'bandwidth-sdk'; + +const instance: LookupStatus = { + requestId, + status, + result, + failedTelephoneNumbers, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupStatusEnum.md b/docs/LookupStatusEnum.md new file mode 100644 index 0000000..144df63 --- /dev/null +++ b/docs/LookupStatusEnum.md @@ -0,0 +1,15 @@ +# LookupStatusEnum + +The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or FAILED). + +## Enum + +* `InProgress` (value: `'IN_PROGRESS'`) + +* `Complete` (value: `'COMPLETE'`) + +* `PartialComplete` (value: `'PARTIAL_COMPLETE'`) + +* `Failed` (value: `'FAILED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MFAApi.md b/docs/MFAApi.md new file mode 100644 index 0000000..4b58380 --- /dev/null +++ b/docs/MFAApi.md @@ -0,0 +1,188 @@ +# MFAApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**generateMessagingCode**](#generatemessagingcode) | **POST** /accounts/{accountId}/code/messaging | Messaging Authentication Code| +|[**generateVoiceCode**](#generatevoicecode) | **POST** /accounts/{accountId}/code/voice | Voice Authentication Code| +|[**verifyCode**](#verifycode) | **POST** /accounts/{accountId}/code/verify | Verify Authentication Code| + +# **generateMessagingCode** +> MessagingCodeResponse generateMessagingCode(codeRequest) + +Send an MFA code via text message (SMS). + +### Example + +```typescript +import { + MFAApi, + Configuration, + CodeRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MFAApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let codeRequest: CodeRequest; //MFA code request body. + +const { status, data } = await apiInstance.generateMessagingCode( + accountId, + codeRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **codeRequest** | **CodeRequest**| MFA code request body. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**MessagingCodeResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generateVoiceCode** +> VoiceCodeResponse generateVoiceCode(codeRequest) + +Send an MFA Code via a phone call. + +### Example + +```typescript +import { + MFAApi, + Configuration, + CodeRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MFAApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let codeRequest: CodeRequest; //MFA code request body. + +const { status, data } = await apiInstance.generateVoiceCode( + accountId, + codeRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **codeRequest** | **CodeRequest**| MFA code request body. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**VoiceCodeResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **verifyCode** +> VerifyCodeResponse verifyCode(verifyCodeRequest) + +Verify a previously sent MFA code. + +### Example + +```typescript +import { + MFAApi, + Configuration, + VerifyCodeRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MFAApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let verifyCodeRequest: VerifyCodeRequest; //MFA code verify request body. + +const { status, data } = await apiInstance.verifyCode( + accountId, + verifyCodeRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **verifyCodeRequest** | **VerifyCodeRequest**| MFA code verify request body. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**VerifyCodeResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MachineDetectionCompleteCallback.md b/docs/MachineDetectionCompleteCallback.md new file mode 100644 index 0000000..1a28a49 --- /dev/null +++ b/docs/MachineDetectionCompleteCallback.md @@ -0,0 +1,47 @@ +# MachineDetectionCompleteCallback + +This event is sent to the url informed when requesting a machine detection operation. It contains the machine detection operation result, which can be: human, answering-machine, silence, timeout, error. This event is not sent when sync answering machine detection mode is chosen. + +## 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 { MachineDetectionCompleteCallback } from 'bandwidth-sdk'; + +const instance: MachineDetectionCompleteCallback = { + 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) diff --git a/docs/MachineDetectionConfiguration.md b/docs/MachineDetectionConfiguration.md new file mode 100644 index 0000000..8139824 --- /dev/null +++ b/docs/MachineDetectionConfiguration.md @@ -0,0 +1,49 @@ +# MachineDetectionConfiguration + +The machine detection request used to perform machine detection on the call. Currently, there is an issue where decimal values are not getting processed correctly. Please use whole number values. We are working to resolve this issue. Please contact Bandwidth Support if you need more information. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | [**MachineDetectionModeEnum**](MachineDetectionModeEnum.md) | | [optional] [default to undefined] +**detectionTimeout** | **number** | The timeout used for the whole operation, in seconds. If no result is determined in this period, a callback with a `timeout` result is sent. | [optional] [default to 15] +**silenceTimeout** | **number** | If no speech is detected in this period, a callback with a \'silence\' result is sent. | [optional] [default to 10] +**speechThreshold** | **number** | When speech has ended and a result couldn\'t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \'answering-machine\'. If the length of speech detected is below this threshold, the result will be \'human\'. | [optional] [default to 10] +**speechEndThreshold** | **number** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional] [default to 5] +**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional] [default to undefined] +**delayResult** | **boolean** | If set to \'true\' and if an answering machine is detected, the \'answering-machine\' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \'detectionTimeout\' is exceeded. If false, the \'answering-machine\' result is sent immediately. | [optional] [default to false] +**callbackUrl** | **string** | The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode. | [optional] [default to undefined] +**callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**username** | **string** | Basic auth username. | [optional] [default to undefined] +**password** | **string** | Basic auth password. | [optional] [default to undefined] +**fallbackUrl** | **string** | A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond | [optional] [default to undefined] +**fallbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined] +**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined] + +## Example + +```typescript +import { MachineDetectionConfiguration } from 'bandwidth-sdk'; + +const instance: MachineDetectionConfiguration = { + mode, + detectionTimeout, + silenceTimeout, + speechThreshold, + speechEndThreshold, + machineSpeechEndThreshold, + delayResult, + callbackUrl, + callbackMethod, + username, + password, + fallbackUrl, + fallbackMethod, + fallbackUsername, + fallbackPassword, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MachineDetectionModeEnum.md b/docs/MachineDetectionModeEnum.md new file mode 100644 index 0000000..b4a9c75 --- /dev/null +++ b/docs/MachineDetectionModeEnum.md @@ -0,0 +1,11 @@ +# MachineDetectionModeEnum + +The machine detection mode. If set to \'async\', the detection result will be sent in a \'machineDetectionComplete\' callback. If set to \'sync\', the \'answer\' callback will wait for the machine detection to complete and will include its result. + +## Enum + +* `Sync` (value: `'sync'`) + +* `Async` (value: `'async'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MachineDetectionResult.md b/docs/MachineDetectionResult.md new file mode 100644 index 0000000..1dd8247 --- /dev/null +++ b/docs/MachineDetectionResult.md @@ -0,0 +1,23 @@ +# MachineDetectionResult + +(optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **string** | Possible values are answering-machine, human, silence, timeout, or error. | [optional] [default to undefined] +**duration** | **string** | The amount of time it took to determine the result. | [optional] [default to undefined] + +## Example + +```typescript +import { MachineDetectionResult } from 'bandwidth-sdk'; + +const instance: MachineDetectionResult = { + value, + duration, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Media.md b/docs/Media.md new file mode 100644 index 0000000..9759eac --- /dev/null +++ b/docs/Media.md @@ -0,0 +1,24 @@ +# Media + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **string** | | [optional] [default to undefined] +**contentLength** | **number** | | [optional] [default to undefined] +**mediaName** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { Media } from 'bandwidth-sdk'; + +const instance: Media = { + content, + contentLength, + mediaName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MediaApi.md b/docs/MediaApi.md new file mode 100644 index 0000000..c4e26c7 --- /dev/null +++ b/docs/MediaApi.md @@ -0,0 +1,268 @@ +# MediaApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteMedia**](#deletemedia) | **DELETE** /users/{accountId}/media/{mediaId} | Delete Media| +|[**getMedia**](#getmedia) | **GET** /users/{accountId}/media/{mediaId} | Get Media| +|[**listMedia**](#listmedia) | **GET** /users/{accountId}/media | List Media| +|[**uploadMedia**](#uploadmedia) | **PUT** /users/{accountId}/media/{mediaId} | Upload Media| + +# **deleteMedia** +> deleteMedia() + +Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name. + +### Example + +```typescript +import { + MediaApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MediaApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let mediaId: string; //Media ID to retrieve. (default to undefined) + +const { status, data } = await apiInstance.deleteMedia( + accountId, + mediaId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | No Content | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**406** | Not Acceptable | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMedia** +> File getMedia() + +Downloads a media file you previously uploaded. + +### Example + +```typescript +import { + MediaApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MediaApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let mediaId: string; //Media ID to retrieve. (default to undefined) + +const { status, data } = await apiInstance.getMedia( + accountId, + mediaId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined| + + +### Return type + +**File** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**406** | Not Acceptable | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listMedia** +> Array listMedia() + +Gets a list of your media files. No query parameters are supported. + +### Example + +```typescript +import { + MediaApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MediaApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let continuationToken: string; //Continuation token used to retrieve subsequent media. (optional) (default to undefined) + +const { status, data } = await apiInstance.listMedia( + accountId, + continuationToken +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **continuationToken** | [**string**] | Continuation token used to retrieve subsequent media. | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | * Continuation-Token - Continuation token used to retrieve subsequent media.
| +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**406** | Not Acceptable | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **uploadMedia** +> uploadMedia(body) + +Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). + +### Example + +```typescript +import { + MediaApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MediaApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let mediaId: string; //Media ID to retrieve. (default to undefined) +let body: File; // +let contentType: string; //The media type of the entity-body. (optional) (default to undefined) +let cacheControl: string; //General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) (default to undefined) + +const { status, data } = await apiInstance.uploadMedia( + accountId, + mediaId, + body, + contentType, + cacheControl +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **File**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined| +| **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined| +| **cacheControl** | [**string**] | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json, application/ogg, application/pdf, application/rtf, application/zip, application/x-tar, application/xml, application/gzip, application/x-bzip2, application/x-gzip, application/smil, application/javascript, audio/mp4, audio/mpeg, audio/ogg, audio/flac, audio/webm, audio/wav, audio/amr, audio/3gpp, image/bmp, image/gif, image/heic, image/heif, image/jpeg, image/pjpeg, image/png, image/svg+xml, image/tiff, image/webp, image/x-icon, text/css, text/csv, text/calendar, text/html, text/plain, text/javascript, text/vcard, text/vnd.wap.wml, text/xml, video/avi, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-ms-wmv, video/x-flv + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | No Content | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**406** | Not Acceptable | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Message.md b/docs/Message.md new file mode 100644 index 0000000..474e946 --- /dev/null +++ b/docs/Message.md @@ -0,0 +1,44 @@ +# Message + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The id of the message. | [optional] [default to undefined] +**owner** | **string** | The Bandwidth phone number associated with the message. | [optional] [default to undefined] +**applicationId** | **string** | The application ID associated with the message. | [optional] [default to undefined] +**time** | **string** | The datetime stamp of the message in ISO 8601 | [optional] [default to undefined] +**segmentCount** | **number** | The number of segments the original message from the user is broken into before sending over to carrier networks. | [optional] [default to undefined] +**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] [default to undefined] +**to** | **Set<string>** | The phone number recipients of the message. | [optional] [default to undefined] +**from** | **string** | The phone number the message was sent from. | [optional] [default to undefined] +**media** | **Set<string>** | The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. | [optional] [default to undefined] +**text** | **string** | The contents of the message. | [optional] [default to undefined] +**tag** | **string** | The custom string set by the user. | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] +**expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined] + +## Example + +```typescript +import { Message } from 'bandwidth-sdk'; + +const instance: Message = { + id, + owner, + applicationId, + time, + segmentCount, + direction, + to, + from, + media, + text, + tag, + priority, + expiration, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageCallback.md b/docs/MessageCallback.md new file mode 100644 index 0000000..e00c46a --- /dev/null +++ b/docs/MessageCallback.md @@ -0,0 +1,31 @@ +# MessageCallback + +Message Callback Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **string** | | [default to undefined] +**type** | [**CallbackTypeEnum**](CallbackTypeEnum.md) | | [default to undefined] +**to** | **string** | | [default to undefined] +**description** | **string** | A detailed description of the event described by the callback. | [default to undefined] +**message** | [**MessageCallbackMessage**](MessageCallbackMessage.md) | | [default to undefined] +**errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined] + +## Example + +```typescript +import { MessageCallback } from 'bandwidth-sdk'; + +const instance: MessageCallback = { + time, + type, + to, + description, + message, + errorCode, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageCallbackMessage.md b/docs/MessageCallbackMessage.md new file mode 100644 index 0000000..9d286f4 --- /dev/null +++ b/docs/MessageCallbackMessage.md @@ -0,0 +1,43 @@ +# MessageCallbackMessage + +Message payload schema within a MessageCallback + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**owner** | **string** | | [default to undefined] +**applicationId** | **string** | | [default to undefined] +**time** | **string** | | [default to undefined] +**segmentCount** | **number** | | [default to undefined] +**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined] +**to** | **Set<string>** | | [default to undefined] +**from** | **string** | | [default to undefined] +**text** | **string** | | [default to undefined] +**tag** | **string** | | [optional] [default to undefined] +**media** | **Array<string>** | Optional media, applicable only for mms | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MessageCallbackMessage } from 'bandwidth-sdk'; + +const instance: MessageCallbackMessage = { + id, + owner, + applicationId, + time, + segmentCount, + direction, + to, + from, + text, + tag, + media, + priority, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageDirectionEnum.md b/docs/MessageDirectionEnum.md new file mode 100644 index 0000000..92e21a7 --- /dev/null +++ b/docs/MessageDirectionEnum.md @@ -0,0 +1,11 @@ +# MessageDirectionEnum + +The direction of the message. One of in out. + +## Enum + +* `In` (value: `'in'`) + +* `Out` (value: `'out'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageRequest.md b/docs/MessageRequest.md new file mode 100644 index 0000000..4734b8c --- /dev/null +++ b/docs/MessageRequest.md @@ -0,0 +1,34 @@ +# MessageRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applicationId** | **string** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] +**to** | **Set<string>** | The phone number(s) the message should be sent to in E164 format. | [default to undefined] +**from** | **string** | Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined] +**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined] +**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] +**expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined] + +## Example + +```typescript +import { MessageRequest } from 'bandwidth-sdk'; + +const instance: MessageRequest = { + applicationId, + to, + from, + text, + media, + tag, + priority, + expiration, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageStatusEnum.md b/docs/MessageStatusEnum.md new file mode 100644 index 0000000..d95843d --- /dev/null +++ b/docs/MessageStatusEnum.md @@ -0,0 +1,23 @@ +# MessageStatusEnum + +The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. + +## Enum + +* `Received` (value: `'RECEIVED'`) + +* `Queued` (value: `'QUEUED'`) + +* `Sending` (value: `'SENDING'`) + +* `Sent` (value: `'SENT'`) + +* `Failed` (value: `'FAILED'`) + +* `Delivered` (value: `'DELIVERED'`) + +* `Accepted` (value: `'ACCEPTED'`) + +* `Undelivered` (value: `'UNDELIVERED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageTypeEnum.md b/docs/MessageTypeEnum.md new file mode 100644 index 0000000..3df44cf --- /dev/null +++ b/docs/MessageTypeEnum.md @@ -0,0 +1,11 @@ +# MessageTypeEnum + +The type of message. Either SMS or MMS. + +## Enum + +* `Sms` (value: `'sms'`) + +* `Mms` (value: `'mms'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessagesApi.md b/docs/MessagesApi.md new file mode 100644 index 0000000..22163df --- /dev/null +++ b/docs/MessagesApi.md @@ -0,0 +1,175 @@ +# MessagesApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createMessage**](#createmessage) | **POST** /users/{accountId}/messages | Create Message| +|[**listMessages**](#listmessages) | **GET** /users/{accountId}/messages | List Messages| + +# **createMessage** +> Message createMessage(messageRequest) + +Endpoint for sending text messages and picture messages using V2 messaging. + +### Example + +```typescript +import { + MessagesApi, + Configuration, + MessageRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MessagesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let messageRequest: MessageRequest; // + +const { status, data } = await apiInstance.createMessage( + accountId, + messageRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **messageRequest** | **MessageRequest**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**Message** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**202** | Accepted | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**406** | Not Acceptable | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listMessages** +> MessagesList listMessages() + +Returns a list of messages based on query parameters. + +### Example + +```typescript +import { + MessagesApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MessagesApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let messageId: string; //The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. (optional) (default to undefined) +let sourceTn: string; //The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). (optional) (default to undefined) +let destinationTn: string; //The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). (optional) (default to undefined) +let messageStatus: MessageStatusEnum; //The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. (optional) (default to undefined) +let messageDirection: ListMessageDirectionEnum; //The direction of the message. One of INBOUND OUTBOUND. (optional) (default to undefined) +let carrierName: string; //The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T). (optional) (default to undefined) +let messageType: MessageTypeEnum; //The type of message. Either sms or mms. (optional) (default to undefined) +let errorCode: number; //The error code of the message. (optional) (default to undefined) +let fromDateTime: string; //The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. (optional) (default to undefined) +let toDateTime: string; //The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. (optional) (default to undefined) +let campaignId: string; //The campaign ID of the message. (optional) (default to undefined) +let sort: string; //The field and direction to sort by combined with a colon. Direction is either asc or desc. (optional) (default to undefined) +let pageToken: string; //A base64 encoded value used for pagination of results. (optional) (default to undefined) +let limit: number; //The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. (optional) (default to undefined) +let limitTotalCount: boolean; //When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results. (optional) (default to undefined) + +const { status, data } = await apiInstance.listMessages( + accountId, + messageId, + sourceTn, + destinationTn, + messageStatus, + messageDirection, + carrierName, + messageType, + errorCode, + fromDateTime, + toDateTime, + campaignId, + sort, + pageToken, + limit, + limitTotalCount +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **messageId** | [**string**] | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. | (optional) defaults to undefined| +| **sourceTn** | [**string**] | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). | (optional) defaults to undefined| +| **destinationTn** | [**string**] | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). | (optional) defaults to undefined| +| **messageStatus** | **MessageStatusEnum** | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. | (optional) defaults to undefined| +| **messageDirection** | **ListMessageDirectionEnum** | The direction of the message. One of INBOUND OUTBOUND. | (optional) defaults to undefined| +| **carrierName** | [**string**] | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T). | (optional) defaults to undefined| +| **messageType** | **MessageTypeEnum** | The type of message. Either sms or mms. | (optional) defaults to undefined| +| **errorCode** | [**number**] | The error code of the message. | (optional) defaults to undefined| +| **fromDateTime** | [**string**] | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | (optional) defaults to undefined| +| **toDateTime** | [**string**] | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | (optional) defaults to undefined| +| **campaignId** | [**string**] | The campaign ID of the message. | (optional) defaults to undefined| +| **sort** | [**string**] | The field and direction to sort by combined with a colon. Direction is either asc or desc. | (optional) defaults to undefined| +| **pageToken** | [**string**] | A base64 encoded value used for pagination of results. | (optional) defaults to undefined| +| **limit** | [**number**] | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | (optional) defaults to undefined| +| **limitTotalCount** | [**boolean**] | When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results. | (optional) defaults to undefined| + + +### Return type + +**MessagesList** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MessagesList.md b/docs/MessagesList.md new file mode 100644 index 0000000..70e04cf --- /dev/null +++ b/docs/MessagesList.md @@ -0,0 +1,24 @@ +# MessagesList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**totalCount** | **number** | The total number of messages matched by the search. When the request has limitTotalCount set to true this value is limited to 10,000. | [optional] [default to undefined] +**pageInfo** | [**PageInfo**](PageInfo.md) | | [optional] [default to undefined] +**messages** | [**Array<ListMessageItem>**](ListMessageItem.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MessagesList } from 'bandwidth-sdk'; + +const instance: MessagesList = { + totalCount, + pageInfo, + messages, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessagingCodeResponse.md b/docs/MessagingCodeResponse.md new file mode 100644 index 0000000..273edc1 --- /dev/null +++ b/docs/MessagingCodeResponse.md @@ -0,0 +1,20 @@ +# MessagingCodeResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageId** | **string** | Messaging API Message ID. | [optional] [default to undefined] + +## Example + +```typescript +import { MessagingCodeResponse } from 'bandwidth-sdk'; + +const instance: MessagingCodeResponse = { + messageId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessagingRequestError.md b/docs/MessagingRequestError.md new file mode 100644 index 0000000..7176f36 --- /dev/null +++ b/docs/MessagingRequestError.md @@ -0,0 +1,22 @@ +# MessagingRequestError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**description** | **string** | | [default to undefined] + +## Example + +```typescript +import { MessagingRequestError } from 'bandwidth-sdk'; + +const instance: MessagingRequestError = { + type, + description, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MfaForbiddenRequestError.md b/docs/MfaForbiddenRequestError.md new file mode 100644 index 0000000..bc533a7 --- /dev/null +++ b/docs/MfaForbiddenRequestError.md @@ -0,0 +1,20 @@ +# MfaForbiddenRequestError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | The message containing the reason behind the request being forbidden. | [optional] [default to undefined] + +## Example + +```typescript +import { MfaForbiddenRequestError } from 'bandwidth-sdk'; + +const instance: MfaForbiddenRequestError = { + message, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MfaRequestError.md b/docs/MfaRequestError.md new file mode 100644 index 0000000..a69c1bc --- /dev/null +++ b/docs/MfaRequestError.md @@ -0,0 +1,22 @@ +# MfaRequestError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **string** | A message describing the error with your request. | [optional] [default to undefined] +**requestId** | **string** | The associated requestId from AWS. | [optional] [default to undefined] + +## Example + +```typescript +import { MfaRequestError } from 'bandwidth-sdk'; + +const instance: MfaRequestError = { + error, + requestId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MfaUnauthorizedRequestError.md b/docs/MfaUnauthorizedRequestError.md new file mode 100644 index 0000000..6d3eb8b --- /dev/null +++ b/docs/MfaUnauthorizedRequestError.md @@ -0,0 +1,20 @@ +# MfaUnauthorizedRequestError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | Unauthorized | [optional] [default to undefined] + +## Example + +```typescript +import { MfaUnauthorizedRequestError } from 'bandwidth-sdk'; + +const instance: MfaUnauthorizedRequestError = { + message, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MmsMessageContent.md b/docs/MmsMessageContent.md new file mode 100644 index 0000000..1a4e740 --- /dev/null +++ b/docs/MmsMessageContent.md @@ -0,0 +1,22 @@ +# MmsMessageContent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined] +**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] [default to undefined] + +## Example + +```typescript +import { MmsMessageContent } from 'bandwidth-sdk'; + +const instance: MmsMessageContent = { + text, + media, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelAction.md b/docs/MultiChannelAction.md new file mode 100644 index 0000000..dfbd0b6 --- /dev/null +++ b/docs/MultiChannelAction.md @@ -0,0 +1,42 @@ +# MultiChannelAction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] +**text** | **string** | Displayed text for user to click | [default to undefined] +**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined] +**latitude** | **number** | The latitude of the location. | [default to undefined] +**longitude** | **number** | The longitude of the location. | [default to undefined] +**label** | **string** | The label of the location. | [optional] [default to undefined] +**title** | **string** | The title of the event. | [default to undefined] +**startTime** | **string** | The start time of the event. | [default to undefined] +**endTime** | **string** | The end time of the event. | [default to undefined] +**description** | **string** | The description of the event. | [optional] [default to undefined] +**url** | **string** | The URL to open in browser. | [default to undefined] + +## Example + +```typescript +import { MultiChannelAction } from 'bandwidth-sdk'; + +const instance: MultiChannelAction = { + type, + text, + postBackData, + phoneNumber, + latitude, + longitude, + label, + title, + startTime, + endTime, + description, + 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) diff --git a/docs/MultiChannelActionCalendarEvent.md b/docs/MultiChannelActionCalendarEvent.md new file mode 100644 index 0000000..fa422da --- /dev/null +++ b/docs/MultiChannelActionCalendarEvent.md @@ -0,0 +1,32 @@ +# MultiChannelActionCalendarEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] +**text** | **string** | Displayed text for user to click | [default to undefined] +**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**title** | **string** | The title of the event. | [default to undefined] +**startTime** | **string** | The start time of the event. | [default to undefined] +**endTime** | **string** | The end time of the event. | [default to undefined] +**description** | **string** | The description of the event. | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelActionCalendarEvent } from 'bandwidth-sdk'; + +const instance: MultiChannelActionCalendarEvent = { + type, + text, + postBackData, + title, + startTime, + endTime, + description, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelApi.md b/docs/MultiChannelApi.md new file mode 100644 index 0000000..55ea3a0 --- /dev/null +++ b/docs/MultiChannelApi.md @@ -0,0 +1,71 @@ +# MultiChannelApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createMultiChannelMessage**](#createmultichannelmessage) | **POST** /users/{accountId}/messages/multiChannel | Create Multi-Channel Message| + +# **createMultiChannelMessage** +> CreateMultiChannelMessageResponse createMultiChannelMessage(multiChannelMessageRequest) + +Endpoint for sending Multi-Channel messages. + +### Example + +```typescript +import { + MultiChannelApi, + Configuration, + MultiChannelMessageRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new MultiChannelApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let multiChannelMessageRequest: MultiChannelMessageRequest; // + +const { status, data } = await apiInstance.createMultiChannelMessage( + accountId, + multiChannelMessageRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **multiChannelMessageRequest** | **MultiChannelMessageRequest**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**CreateMultiChannelMessageResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**202** | Accepted | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**406** | Not Acceptable | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MultiChannelCallbackData.md b/docs/MultiChannelCallbackData.md new file mode 100644 index 0000000..61db1e9 --- /dev/null +++ b/docs/MultiChannelCallbackData.md @@ -0,0 +1,28 @@ +# MultiChannelCallbackData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **string** | The time of the callback event. | [optional] [default to undefined] +**type** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined] +**to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**message** | [**MultiChannelMessageCallbackData**](MultiChannelMessageCallbackData.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelCallbackData } from 'bandwidth-sdk'; + +const instance: MultiChannelCallbackData = { + time, + type, + to, + description, + message, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelChannelListObject.md b/docs/MultiChannelChannelListObject.md new file mode 100644 index 0000000..f349678 --- /dev/null +++ b/docs/MultiChannelChannelListObject.md @@ -0,0 +1,26 @@ +# MultiChannelChannelListObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] +**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined] +**content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | [default to undefined] + +## Example + +```typescript +import { MultiChannelChannelListObject } from 'bandwidth-sdk'; + +const instance: MultiChannelChannelListObject = { + from, + applicationId, + channel, + content, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelChannelListObjectContent.md b/docs/MultiChannelChannelListObjectContent.md new file mode 100644 index 0000000..08539ce --- /dev/null +++ b/docs/MultiChannelChannelListObjectContent.md @@ -0,0 +1,35 @@ +# MultiChannelChannelListObjectContent + +The content of the message. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] +**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [default to undefined] +**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined] +**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined] +**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined] +**cardWidth** | [**CardWidthEnum**](CardWidthEnum.md) | | [default to undefined] +**cardContents** | [**Array<RbmCardContent>**](RbmCardContent.md) | | [default to undefined] + +## Example + +```typescript +import { MultiChannelChannelListObjectContent } from 'bandwidth-sdk'; + +const instance: MultiChannelChannelListObjectContent = { + text, + suggestions, + media, + orientation, + thumbnailImageAlignment, + cardContent, + cardWidth, + cardContents, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageCallbackData.md b/docs/MultiChannelMessageCallbackData.md new file mode 100644 index 0000000..5b05f0b --- /dev/null +++ b/docs/MultiChannelMessageCallbackData.md @@ -0,0 +1,34 @@ +# MultiChannelMessageCallbackData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageId** | **string** | The ID of the message. | [optional] [default to undefined] +**status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined] +**direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined] +**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined] +**to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined] +**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelMessageCallbackData } from 'bandwidth-sdk'; + +const instance: MultiChannelMessageCallbackData = { + messageId, + status, + direction, + from, + to, + applicationId, + channel, + 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) diff --git a/docs/MultiChannelMessageChannelEnum.md b/docs/MultiChannelMessageChannelEnum.md new file mode 100644 index 0000000..5c2708f --- /dev/null +++ b/docs/MultiChannelMessageChannelEnum.md @@ -0,0 +1,13 @@ +# MultiChannelMessageChannelEnum + +The channel of the multi-channel message. + +## Enum + +* `Rbm` (value: `'RBM'`) + +* `Sms` (value: `'SMS'`) + +* `Mms` (value: `'MMS'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageData.md b/docs/MultiChannelMessageData.md new file mode 100644 index 0000000..abe1339 --- /dev/null +++ b/docs/MultiChannelMessageData.md @@ -0,0 +1,36 @@ +# MultiChannelMessageData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageId** | **string** | The ID of the message. | [optional] [default to undefined] +**status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined] +**time** | **string** | The time the message was received by the Bandwidth API. | [optional] [default to undefined] +**direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined] +**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined] +**to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined] +**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelMessageData } from 'bandwidth-sdk'; + +const instance: MultiChannelMessageData = { + messageId, + status, + time, + direction, + from, + to, + applicationId, + channel, + 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) diff --git a/docs/MultiChannelMessageDirectionEnum.md b/docs/MultiChannelMessageDirectionEnum.md new file mode 100644 index 0000000..a5e3b5f --- /dev/null +++ b/docs/MultiChannelMessageDirectionEnum.md @@ -0,0 +1,10 @@ +# MultiChannelMessageDirectionEnum + + +## Enum + +* `Inbound` (value: `'INBOUND'`) + +* `Outbound` (value: `'OUTBOUND'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageRequest.md b/docs/MultiChannelMessageRequest.md new file mode 100644 index 0000000..caa647e --- /dev/null +++ b/docs/MultiChannelMessageRequest.md @@ -0,0 +1,29 @@ +# MultiChannelMessageRequest + +Multi-Channel Message Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**to** | **string** | The phone number the message should be sent to in E164 format. | [default to undefined] +**channelList** | [**Array<MultiChannelChannelListObject>**](MultiChannelChannelListObject.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. | [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] +**expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelMessageRequest } from 'bandwidth-sdk'; + +const instance: MultiChannelMessageRequest = { + to, + channelList, + tag, + priority, + expiration, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelStatusEnum.md b/docs/MultiChannelStatusEnum.md new file mode 100644 index 0000000..9de6b25 --- /dev/null +++ b/docs/MultiChannelStatusEnum.md @@ -0,0 +1,14 @@ +# MultiChannelStatusEnum + + +## Enum + +* `Queued` (value: `'QUEUED'`) + +* `Sending` (value: `'SENDING'`) + +* `Delivered` (value: `'DELIVERED'`) + +* `Failed` (value: `'FAILED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/OptInWorkflow.md b/docs/OptInWorkflow.md new file mode 100644 index 0000000..b9ea1a6 --- /dev/null +++ b/docs/OptInWorkflow.md @@ -0,0 +1,22 @@ +# OptInWorkflow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **string** | | [default to undefined] +**imageUrls** | **Array<string>** | | [default to undefined] + +## Example + +```typescript +import { OptInWorkflow } from 'bandwidth-sdk'; + +const instance: OptInWorkflow = { + description, + imageUrls, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PageInfo.md b/docs/PageInfo.md new file mode 100644 index 0000000..79534bf --- /dev/null +++ b/docs/PageInfo.md @@ -0,0 +1,26 @@ +# PageInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**prevPage** | **string** | The link to the previous page for pagination. | [optional] [default to undefined] +**nextPage** | **string** | The link to the next page for pagination. | [optional] [default to undefined] +**prevPageToken** | **string** | The isolated pagination token for the previous page. | [optional] [default to undefined] +**nextPageToken** | **string** | The isolated pagination token for the next page. | [optional] [default to undefined] + +## Example + +```typescript +import { PageInfo } from 'bandwidth-sdk'; + +const instance: PageInfo = { + prevPage, + nextPage, + prevPageToken, + nextPageToken, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PhoneNumberLookupApi.md b/docs/PhoneNumberLookupApi.md new file mode 100644 index 0000000..ad635d6 --- /dev/null +++ b/docs/PhoneNumberLookupApi.md @@ -0,0 +1,130 @@ +# PhoneNumberLookupApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createLookup**](#createlookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup| +|[**getLookupStatus**](#getlookupstatus) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status| + +# **createLookup** +> CreateLookupResponse createLookup(lookupRequest) + +Create a Phone Number Lookup Request. + +### Example + +```typescript +import { + PhoneNumberLookupApi, + Configuration, + LookupRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new PhoneNumberLookupApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let lookupRequest: LookupRequest; //Phone number lookup request. + +const { status, data } = await apiInstance.createLookup( + accountId, + lookupRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **lookupRequest** | **LookupRequest**| Phone number lookup request. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**CreateLookupResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**202** | Accepted | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getLookupStatus** +> LookupStatus getLookupStatus() + +Get an existing Phone Number Lookup Request. + +### Example + +```typescript +import { + PhoneNumberLookupApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new PhoneNumberLookupApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let requestId: string; //The phone number lookup request ID from Bandwidth. (default to undefined) + +const { status, data } = await apiInstance.getLookupStatus( + accountId, + requestId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **requestId** | [**string**] | The phone number lookup request ID from Bandwidth. | defaults to undefined| + + +### Return type + +**LookupStatus** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PriorityEnum.md b/docs/PriorityEnum.md new file mode 100644 index 0000000..5d38ab6 --- /dev/null +++ b/docs/PriorityEnum.md @@ -0,0 +1,11 @@ +# PriorityEnum + +The priority specified by the user. + +## Enum + +* `Default` (value: `'default'`) + +* `High` (value: `'high'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmActionBase.md b/docs/RbmActionBase.md new file mode 100644 index 0000000..d1884a3 --- /dev/null +++ b/docs/RbmActionBase.md @@ -0,0 +1,24 @@ +# RbmActionBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] +**text** | **string** | Displayed text for user to click | [default to undefined] +**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] + +## Example + +```typescript +import { RbmActionBase } from 'bandwidth-sdk'; + +const instance: RbmActionBase = { + type, + text, + postBackData, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmActionDial.md b/docs/RbmActionDial.md new file mode 100644 index 0000000..35f56e8 --- /dev/null +++ b/docs/RbmActionDial.md @@ -0,0 +1,26 @@ +# RbmActionDial + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] +**text** | **string** | Displayed text for user to click | [default to undefined] +**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined] + +## Example + +```typescript +import { RbmActionDial } from 'bandwidth-sdk'; + +const instance: RbmActionDial = { + type, + text, + postBackData, + phoneNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmActionOpenUrl.md b/docs/RbmActionOpenUrl.md new file mode 100644 index 0000000..fcb2a01 --- /dev/null +++ b/docs/RbmActionOpenUrl.md @@ -0,0 +1,26 @@ +# RbmActionOpenUrl + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] +**text** | **string** | Displayed text for user to click | [default to undefined] +**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**url** | **string** | The URL to open in browser. | [default to undefined] + +## Example + +```typescript +import { RbmActionOpenUrl } from 'bandwidth-sdk'; + +const instance: RbmActionOpenUrl = { + type, + text, + postBackData, + 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) diff --git a/docs/RbmActionTypeEnum.md b/docs/RbmActionTypeEnum.md new file mode 100644 index 0000000..fd68ce4 --- /dev/null +++ b/docs/RbmActionTypeEnum.md @@ -0,0 +1,18 @@ +# RbmActionTypeEnum + + +## Enum + +* `Reply` (value: `'REPLY'`) + +* `DialPhone` (value: `'DIAL_PHONE'`) + +* `ShowLocation` (value: `'SHOW_LOCATION'`) + +* `CreateCalendarEvent` (value: `'CREATE_CALENDAR_EVENT'`) + +* `OpenUrl` (value: `'OPEN_URL'`) + +* `RequestLocation` (value: `'REQUEST_LOCATION'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmActionViewLocation.md b/docs/RbmActionViewLocation.md new file mode 100644 index 0000000..864e901 --- /dev/null +++ b/docs/RbmActionViewLocation.md @@ -0,0 +1,30 @@ +# RbmActionViewLocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] +**text** | **string** | Displayed text for user to click | [default to undefined] +**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**latitude** | **number** | The latitude of the location. | [default to undefined] +**longitude** | **number** | The longitude of the location. | [default to undefined] +**label** | **string** | The label of the location. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmActionViewLocation } from 'bandwidth-sdk'; + +const instance: RbmActionViewLocation = { + type, + text, + postBackData, + latitude, + longitude, + label, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmCardContent.md b/docs/RbmCardContent.md new file mode 100644 index 0000000..a83d013 --- /dev/null +++ b/docs/RbmCardContent.md @@ -0,0 +1,26 @@ +# RbmCardContent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **string** | The title of the card. Must be 200 characters or less. | [optional] [default to undefined] +**description** | **string** | The description of the card. Must be 2000 characters or less. | [optional] [default to undefined] +**media** | [**RbmCardContentMedia**](RbmCardContentMedia.md) | | [optional] [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient that will be displayed on the rich card. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmCardContent } from 'bandwidth-sdk'; + +const instance: RbmCardContent = { + title, + description, + media, + suggestions, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmCardContentMedia.md b/docs/RbmCardContentMedia.md new file mode 100644 index 0000000..01525ff --- /dev/null +++ b/docs/RbmCardContentMedia.md @@ -0,0 +1,24 @@ +# RbmCardContentMedia + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fileUrl** | **string** | The URL of the media file. 100MB is the maximum file size. | [default to undefined] +**thumbnailUrl** | **string** | The URL of the thumbnail image. Applies only to video file media. | [optional] [default to undefined] +**height** | [**RbmMediaHeightEnum**](RbmMediaHeightEnum.md) | | [default to undefined] + +## Example + +```typescript +import { RbmCardContentMedia } from 'bandwidth-sdk'; + +const instance: RbmCardContentMedia = { + fileUrl, + thumbnailUrl, + height, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmMediaHeightEnum.md b/docs/RbmMediaHeightEnum.md new file mode 100644 index 0000000..c2daa9d --- /dev/null +++ b/docs/RbmMediaHeightEnum.md @@ -0,0 +1,13 @@ +# RbmMediaHeightEnum + +The height of the media. + +## Enum + +* `Short` (value: `'SHORT'`) + +* `Medium` (value: `'MEDIUM'`) + +* `Tall` (value: `'TALL'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmMessageCarouselCard.md b/docs/RbmMessageCarouselCard.md new file mode 100644 index 0000000..ad07853 --- /dev/null +++ b/docs/RbmMessageCarouselCard.md @@ -0,0 +1,24 @@ +# RbmMessageCarouselCard + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cardWidth** | [**CardWidthEnum**](CardWidthEnum.md) | | [default to undefined] +**cardContents** | [**Array<RbmCardContent>**](RbmCardContent.md) | | [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmMessageCarouselCard } from 'bandwidth-sdk'; + +const instance: RbmMessageCarouselCard = { + cardWidth, + cardContents, + suggestions, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmMessageContentFile.md b/docs/RbmMessageContentFile.md new file mode 100644 index 0000000..19f65cc --- /dev/null +++ b/docs/RbmMessageContentFile.md @@ -0,0 +1,22 @@ +# RbmMessageContentFile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fileUrl** | **string** | The URL of the media file. 100MB is the maximum file size. | [default to undefined] +**thumbnailUrl** | **string** | The URL of the thumbnail image. Applies only to video file media. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmMessageContentFile } from 'bandwidth-sdk'; + +const instance: RbmMessageContentFile = { + fileUrl, + thumbnailUrl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmMessageContentRichCard.md b/docs/RbmMessageContentRichCard.md new file mode 100644 index 0000000..8032c4d --- /dev/null +++ b/docs/RbmMessageContentRichCard.md @@ -0,0 +1,30 @@ +# RbmMessageContentRichCard + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined] +**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined] +**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] +**cardWidth** | [**CardWidthEnum**](CardWidthEnum.md) | | [default to undefined] +**cardContents** | [**Array<RbmCardContent>**](RbmCardContent.md) | | [default to undefined] + +## Example + +```typescript +import { RbmMessageContentRichCard } from 'bandwidth-sdk'; + +const instance: RbmMessageContentRichCard = { + orientation, + thumbnailImageAlignment, + cardContent, + suggestions, + cardWidth, + cardContents, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmMessageContentText.md b/docs/RbmMessageContentText.md new file mode 100644 index 0000000..9f55509 --- /dev/null +++ b/docs/RbmMessageContentText.md @@ -0,0 +1,22 @@ +# RbmMessageContentText + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | The text associated with the message. Must be 3270 characters or less | [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmMessageContentText } from 'bandwidth-sdk'; + +const instance: RbmMessageContentText = { + text, + suggestions, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmMessageMedia.md b/docs/RbmMessageMedia.md new file mode 100644 index 0000000..a941751 --- /dev/null +++ b/docs/RbmMessageMedia.md @@ -0,0 +1,22 @@ +# RbmMessageMedia + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmMessageMedia } from 'bandwidth-sdk'; + +const instance: RbmMessageMedia = { + media, + suggestions, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmStandaloneCard.md b/docs/RbmStandaloneCard.md new file mode 100644 index 0000000..67aabc3 --- /dev/null +++ b/docs/RbmStandaloneCard.md @@ -0,0 +1,26 @@ +# RbmStandaloneCard + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined] +**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined] +**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined] +**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmStandaloneCard } from 'bandwidth-sdk'; + +const instance: RbmStandaloneCard = { + orientation, + thumbnailImageAlignment, + cardContent, + suggestions, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RecordingAvailableCallback.md b/docs/RecordingAvailableCallback.md new file mode 100644 index 0000000..3923875 --- /dev/null +++ b/docs/RecordingAvailableCallback.md @@ -0,0 +1,63 @@ +# RecordingAvailableCallback + +The Recording Available event is sent after a recording has been processed. It indicates that the recording is available for download. + +## 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] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined] +**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined] +**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [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] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined] +**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined] +**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined] +**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [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] +**status** | **string** | The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] + +## Example + +```typescript +import { RecordingAvailableCallback } from 'bandwidth-sdk'; + +const instance: RecordingAvailableCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + parentCallId, + recordingId, + mediaUrl, + enqueuedTime, + startTime, + endTime, + duration, + fileFormat, + channels, + tag, + status, + transferCallerId, + transferTo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RecordingCompleteCallback.md b/docs/RecordingCompleteCallback.md new file mode 100644 index 0000000..8ea67e5 --- /dev/null +++ b/docs/RecordingCompleteCallback.md @@ -0,0 +1,63 @@ +# RecordingCompleteCallback + +The Record Complete event is sent after a verb has executed if the call is still active. The BXML returned by this callback is executed next. When the recording is available for download, a Recording Available event will be 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] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined] +**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined] +**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [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] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined] +**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined] +**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined] +**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [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] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] + +## Example + +```typescript +import { RecordingCompleteCallback } from 'bandwidth-sdk'; + +const instance: RecordingCompleteCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + parentCallId, + recordingId, + mediaUrl, + enqueuedTime, + startTime, + answerTime, + endTime, + duration, + fileFormat, + channels, + tag, + transferCallerId, + transferTo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RecordingStateEnum.md b/docs/RecordingStateEnum.md new file mode 100644 index 0000000..8d3f51a --- /dev/null +++ b/docs/RecordingStateEnum.md @@ -0,0 +1,11 @@ +# RecordingStateEnum + +The recording state. Possible values: `paused` to pause an active recording `recording` to resume a paused recording + +## Enum + +* `Paused` (value: `'paused'`) + +* `Recording` (value: `'recording'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RecordingTranscriptionMetadata.md b/docs/RecordingTranscriptionMetadata.md new file mode 100644 index 0000000..e251315 --- /dev/null +++ b/docs/RecordingTranscriptionMetadata.md @@ -0,0 +1,27 @@ +# RecordingTranscriptionMetadata + +If the recording was transcribed, metadata about the transcription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique transcription ID | [optional] [default to undefined] +**status** | **string** | The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined] +**completedTime** | **string** | The time that the transcription was completed | [optional] [default to undefined] +**url** | **string** | The URL of the [transcription](#operation/getCallTranscription) | [optional] [default to undefined] + +## Example + +```typescript +import { RecordingTranscriptionMetadata } from 'bandwidth-sdk'; + +const instance: RecordingTranscriptionMetadata = { + id, + status, + completedTime, + 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) diff --git a/docs/RecordingTranscriptions.md b/docs/RecordingTranscriptions.md new file mode 100644 index 0000000..78b1d25 --- /dev/null +++ b/docs/RecordingTranscriptions.md @@ -0,0 +1,20 @@ +# RecordingTranscriptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transcripts** | [**Array<Transcription>**](Transcription.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { RecordingTranscriptions } from 'bandwidth-sdk'; + +const instance: RecordingTranscriptions = { + transcripts, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RecordingsApi.md b/docs/RecordingsApi.md new file mode 100644 index 0000000..6a741a5 --- /dev/null +++ b/docs/RecordingsApi.md @@ -0,0 +1,675 @@ +# RecordingsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteRecording**](#deleterecording) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording| +|[**deleteRecordingMedia**](#deleterecordingmedia) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media| +|[**deleteRecordingTranscription**](#deleterecordingtranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription| +|[**downloadCallRecording**](#downloadcallrecording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording| +|[**getCallRecording**](#getcallrecording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording| +|[**getRecordingTranscription**](#getrecordingtranscription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription| +|[**listAccountCallRecordings**](#listaccountcallrecordings) | **GET** /accounts/{accountId}/recordings | Get Call Recordings| +|[**listCallRecordings**](#listcallrecordings) | **GET** /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings| +|[**transcribeCallRecording**](#transcribecallrecording) | **POST** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request| +|[**updateCallRecordingState**](#updatecallrecordingstate) | **PUT** /accounts/{accountId}/calls/{callId}/recording | Update Recording| + +# **deleteRecording** +> deleteRecording() + +Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.deleteRecording( + accountId, + callId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Recording was deleted. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteRecordingMedia** +> deleteRecordingMedia() + +Deletes the specified recording\'s media. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.deleteRecordingMedia( + accountId, + callId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | The recording media was successfully deleted. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteRecordingTranscription** +> deleteRecordingTranscription() + +Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.deleteRecordingTranscription( + accountId, + callId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | The transcription was successfully deleted. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **downloadCallRecording** +> File downloadCallRecording() + +Downloads the specified recording. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.downloadCallRecording( + accountId, + callId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +**File** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/vnd.wave, audio/mpeg, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getCallRecording** +> CallRecordingMetadata getCallRecording() + +Returns metadata for the specified recording. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.getCallRecording( + accountId, + callId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +**CallRecordingMetadata** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getRecordingTranscription** +> RecordingTranscriptions getRecordingTranscription() + +Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [``](/docs/voice/bxml/playAudio) and [``](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [``](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) + +const { status, data } = await apiInstance.getRecordingTranscription( + accountId, + callId, + recordingId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +**RecordingTranscriptions** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listAccountCallRecordings** +> Array listAccountCallRecordings() + +Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let to: string; //Filter results by the `to` field. (optional) (default to undefined) +let from: string; //Filter results by the `from` field. (optional) (default to undefined) +let minStartTime: string; //Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional) (default to undefined) +let maxStartTime: string; //Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). (optional) (default to undefined) + +const { status, data } = await apiInstance.listAccountCallRecordings( + accountId, + to, + from, + minStartTime, + maxStartTime +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **to** | [**string**] | Filter results by the `to` field. | (optional) defaults to undefined| +| **from** | [**string**] | Filter results by the `from` field. | (optional) defaults to undefined| +| **minStartTime** | [**string**] | Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). | (optional) defaults to undefined| +| **maxStartTime** | [**string**] | Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listCallRecordings** +> Array listCallRecordings() + +Returns a (potentially empty) list of metadata for the recordings that took place during the specified call. + +### Example + +```typescript +import { + RecordingsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) + +const { status, data } = await apiInstance.listCallRecordings( + accountId, + callId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **transcribeCallRecording** +> transcribeCallRecording(transcribeRecording) + +Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. + +### Example + +```typescript +import { + RecordingsApi, + Configuration, + TranscribeRecording +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let recordingId: string; //Programmable Voice API Recording ID. (default to undefined) +let transcribeRecording: TranscribeRecording; // + +const { status, data } = await apiInstance.transcribeCallRecording( + accountId, + callId, + recordingId, + transcribeRecording +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **transcribeRecording** | **TranscribeRecording**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Transcription was successfully requested. | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateCallRecordingState** +> updateCallRecordingState(updateCallRecording) + +Pause or resume a recording on an active phone call. + +### Example + +```typescript +import { + RecordingsApi, + Configuration, + UpdateCallRecording +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new RecordingsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let updateCallRecording: UpdateCallRecording; // + +const { status, data } = await apiInstance.updateCallRecordingState( + accountId, + callId, + updateCallRecording +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateCallRecording** | **UpdateCallRecording**| | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RedirectCallback.md b/docs/RedirectCallback.md new file mode 100644 index 0000000..1ef5497 --- /dev/null +++ b/docs/RedirectCallback.md @@ -0,0 +1,51 @@ +# RedirectCallback + +The Redirect event is fired when a verb is executed. Its purpose is to get the next set of verbs from the calling application. + +## 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] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [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] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] + +## Example + +```typescript +import { RedirectCallback } from 'bandwidth-sdk'; + +const instance: RedirectCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + parentCallId, + enqueuedTime, + startTime, + answerTime, + tag, + transferCallerId, + transferTo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RedirectMethodEnum.md b/docs/RedirectMethodEnum.md new file mode 100644 index 0000000..74f82bf --- /dev/null +++ b/docs/RedirectMethodEnum.md @@ -0,0 +1,11 @@ +# RedirectMethodEnum + +The HTTP method to use for the request to `redirectUrl`. GET or POST. Default value is POST.

Not allowed if `state` is `completed`. + +## Enum + +* `Get` (value: `'GET'`) + +* `Post` (value: `'POST'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SmsMessageContent.md b/docs/SmsMessageContent.md new file mode 100644 index 0000000..59227ed --- /dev/null +++ b/docs/SmsMessageContent.md @@ -0,0 +1,20 @@ +# SmsMessageContent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [default to undefined] + +## Example + +```typescript +import { SmsMessageContent } from 'bandwidth-sdk'; + +const instance: SmsMessageContent = { + text, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StandaloneCardOrientationEnum.md b/docs/StandaloneCardOrientationEnum.md new file mode 100644 index 0000000..cf7bef6 --- /dev/null +++ b/docs/StandaloneCardOrientationEnum.md @@ -0,0 +1,10 @@ +# StandaloneCardOrientationEnum + + +## Enum + +* `Horizontal` (value: `'HORIZONTAL'`) + +* `Vertical` (value: `'VERTICAL'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StatisticsApi.md b/docs/StatisticsApi.md new file mode 100644 index 0000000..fc9a069 --- /dev/null +++ b/docs/StatisticsApi.md @@ -0,0 +1,67 @@ +# StatisticsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getStatistics**](#getstatistics) | **GET** /accounts/{accountId}/statistics | Get Account Statistics| + +# **getStatistics** +> AccountStatistics getStatistics() + +Returns details about the current state of the account. + +### Example + +```typescript +import { + StatisticsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new StatisticsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) + +const { status, data } = await apiInstance.getStatistics( + accountId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**AccountStatistics** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/StirShaken.md b/docs/StirShaken.md new file mode 100644 index 0000000..3eb3d3f --- /dev/null +++ b/docs/StirShaken.md @@ -0,0 +1,24 @@ +# StirShaken + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**verstat** | **string** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed. | [optional] [default to undefined] +**attestationIndicator** | **string** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] [default to undefined] +**originatingId** | **string** | (optional) A unique origination identifier. | [optional] [default to undefined] + +## Example + +```typescript +import { StirShaken } from 'bandwidth-sdk'; + +const instance: StirShaken = { + verstat, + attestationIndicator, + originatingId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TelephoneNumber.md b/docs/TelephoneNumber.md new file mode 100644 index 0000000..6045acc --- /dev/null +++ b/docs/TelephoneNumber.md @@ -0,0 +1,20 @@ +# TelephoneNumber + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**telephoneNumber** | **string** | Simple Telephone Number. | [optional] [default to undefined] + +## Example + +```typescript +import { TelephoneNumber } from 'bandwidth-sdk'; + +const instance: TelephoneNumber = { + telephoneNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvBasicAuthentication.md b/docs/TfvBasicAuthentication.md new file mode 100644 index 0000000..8848463 --- /dev/null +++ b/docs/TfvBasicAuthentication.md @@ -0,0 +1,22 @@ +# TfvBasicAuthentication + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **string** | | [default to undefined] +**password** | **string** | | [default to undefined] + +## Example + +```typescript +import { TfvBasicAuthentication } from 'bandwidth-sdk'; + +const instance: TfvBasicAuthentication = { + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvCallbackStatusEnum.md b/docs/TfvCallbackStatusEnum.md new file mode 100644 index 0000000..95fbf9d --- /dev/null +++ b/docs/TfvCallbackStatusEnum.md @@ -0,0 +1,10 @@ +# TfvCallbackStatusEnum + + +## Enum + +* `Verified` (value: `'VERIFIED'`) + +* `Unverified` (value: `'UNVERIFIED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvError.md b/docs/TfvError.md new file mode 100644 index 0000000..a143b4c --- /dev/null +++ b/docs/TfvError.md @@ -0,0 +1,25 @@ +# TfvError + +A generic error object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**errors** | **object** | Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field. | [optional] [default to undefined] + +## Example + +```typescript +import { TfvError } from 'bandwidth-sdk'; + +const instance: TfvError = { + type, + description, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvStatus.md b/docs/TfvStatus.md new file mode 100644 index 0000000..6926476 --- /dev/null +++ b/docs/TfvStatus.md @@ -0,0 +1,38 @@ +# TfvStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined] +**status** | [**TfvStatusEnum**](TfvStatusEnum.md) | | [optional] [default to undefined] +**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] [default to undefined] +**declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined] +**resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined] +**createdDateTime** | **string** | Date and time the verification request was created. | [optional] [default to undefined] +**modifiedDateTime** | **string** | Date and time the verification request was last modified. | [optional] [default to undefined] +**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] [default to undefined] +**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined] + +## Example + +```typescript +import { TfvStatus } from 'bandwidth-sdk'; + +const instance: TfvStatus = { + phoneNumber, + status, + internalTicketNumber, + declineReasonDescription, + resubmitAllowed, + createdDateTime, + modifiedDateTime, + submission, + blocked, + blockedReason, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvStatusEnum.md b/docs/TfvStatusEnum.md new file mode 100644 index 0000000..feb7bd9 --- /dev/null +++ b/docs/TfvStatusEnum.md @@ -0,0 +1,16 @@ +# TfvStatusEnum + + +## Enum + +* `Verified` (value: `'VERIFIED'`) + +* `Unverified` (value: `'UNVERIFIED'`) + +* `Pending` (value: `'PENDING'`) + +* `PartiallyVerified` (value: `'PARTIALLY_VERIFIED'`) + +* `InvalidStatus` (value: `'INVALID_STATUS'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md new file mode 100644 index 0000000..1754f98 --- /dev/null +++ b/docs/TfvSubmissionInfo.md @@ -0,0 +1,42 @@ +# TfvSubmissionInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**businessAddress** | [**Address**](Address.md) | | [optional] [default to undefined] +**businessContact** | [**Contact**](Contact.md) | | [optional] [default to undefined] +**messageVolume** | **number** | Estimated monthly volume of messages from the toll-free number. | [optional] [default to undefined] +**useCase** | **string** | The category of the use case. | [optional] [default to undefined] +**useCaseSummary** | **string** | A general idea of the use case and customer. | [optional] [default to undefined] +**productionMessageContent** | **string** | Example of message content. | [optional] [default to undefined] +**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [optional] [default to undefined] +**additionalInformation** | **string** | Any additional information. | [optional] [default to undefined] +**isvReseller** | **string** | ISV name. | [optional] [default to undefined] +**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] + +## Example + +```typescript +import { TfvSubmissionInfo } from 'bandwidth-sdk'; + +const instance: TfvSubmissionInfo = { + businessAddress, + businessContact, + messageVolume, + useCase, + useCaseSummary, + productionMessageContent, + optInWorkflow, + additionalInformation, + isvReseller, + privacyPolicyUrl, + termsAndConditionsUrl, + businessDBA, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvSubmissionWrapper.md b/docs/TfvSubmissionWrapper.md new file mode 100644 index 0000000..dbed269 --- /dev/null +++ b/docs/TfvSubmissionWrapper.md @@ -0,0 +1,20 @@ +# TfvSubmissionWrapper + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submission** | [**VerificationUpdateRequest**](VerificationUpdateRequest.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { TfvSubmissionWrapper } from 'bandwidth-sdk'; + +const instance: TfvSubmissionWrapper = { + submission, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ThumbnailAlignmentEnum.md b/docs/ThumbnailAlignmentEnum.md new file mode 100644 index 0000000..b6dcc80 --- /dev/null +++ b/docs/ThumbnailAlignmentEnum.md @@ -0,0 +1,11 @@ +# ThumbnailAlignmentEnum + +The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation. + +## Enum + +* `Left` (value: `'LEFT'`) + +* `Right` (value: `'RIGHT'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TnLookupRequestError.md b/docs/TnLookupRequestError.md new file mode 100644 index 0000000..0eca6ef --- /dev/null +++ b/docs/TnLookupRequestError.md @@ -0,0 +1,20 @@ +# TnLookupRequestError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | A description of what validation error occurred. | [optional] [default to undefined] + +## Example + +```typescript +import { TnLookupRequestError } from 'bandwidth-sdk'; + +const instance: TnLookupRequestError = { + message, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TollFreeVerificationApi.md b/docs/TollFreeVerificationApi.md new file mode 100644 index 0000000..4460458 --- /dev/null +++ b/docs/TollFreeVerificationApi.md @@ -0,0 +1,505 @@ +# TollFreeVerificationApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createWebhookSubscription**](#createwebhooksubscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription| +|[**deleteWebhookSubscription**](#deletewebhooksubscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription| +|[**getTollFreeVerificationStatus**](#gettollfreeverificationstatus) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status| +|[**listTollFreeUseCases**](#listtollfreeusecases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases| +|[**listWebhookSubscriptions**](#listwebhooksubscriptions) | **GET** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | List Webhook Subscriptions| +|[**requestTollFreeVerification**](#requesttollfreeverification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification| +|[**updateTollFreeVerificationRequest**](#updatetollfreeverificationrequest) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request| +|[**updateWebhookSubscription**](#updatewebhooksubscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription| + +# **createWebhookSubscription** +> WebhookSubscription createWebhookSubscription(webhookSubscriptionRequestSchema) + +Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time. + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration, + WebhookSubscriptionRequestSchema +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema; //Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. + +const { status, data } = await apiInstance.createWebhookSubscription( + accountId, + webhookSubscriptionRequestSchema +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **webhookSubscriptionRequestSchema** | **WebhookSubscriptionRequestSchema**| Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**WebhookSubscription** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteWebhookSubscription** +> deleteWebhookSubscription() + +Delete a webhook subscription by ID. + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let id: string; //Webhook subscription ID (default to undefined) + +const { status, data } = await apiInstance.deleteWebhookSubscription( + accountId, + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **id** | [**string**] | Webhook subscription ID | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | No Content | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getTollFreeVerificationStatus** +> TfvStatus getTollFreeVerificationStatus() + +Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available. + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let phoneNumber: string; //Valid Toll-Free telephone number in E.164 format. (default to undefined) + +const { status, data } = await apiInstance.getTollFreeVerificationStatus( + accountId, + phoneNumber +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **phoneNumber** | [**string**] | Valid Toll-Free telephone number in E.164 format. | defaults to undefined| + + +### Return type + +**TfvStatus** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listTollFreeUseCases** +> Array listTollFreeUseCases() + +Lists valid toll-free use cases. + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +const { status, data } = await apiInstance.listTollFreeUseCases(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listWebhookSubscriptions** +> WebhookSubscriptionsListBody listWebhookSubscriptions() + +Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null). + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) + +const { status, data } = await apiInstance.listWebhookSubscriptions( + accountId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +**WebhookSubscriptionsListBody** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **requestTollFreeVerification** +> requestTollFreeVerification(verificationRequest) + +Submit a request for verification of a toll-free phone number. + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration, + VerificationRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let verificationRequest: VerificationRequest; //Request for verification of a toll-free phone number. + +const { status, data } = await apiInstance.requestTollFreeVerification( + accountId, + verificationRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **verificationRequest** | **VerificationRequest**| Request for verification of a toll-free phone number. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**202** | Accepted | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateTollFreeVerificationRequest** +> updateTollFreeVerificationRequest(tfvSubmissionWrapper) + +Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration, + TfvSubmissionWrapper +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let phoneNumber: string; //Valid Toll-Free telephone number in E.164 format. (default to undefined) +let tfvSubmissionWrapper: TfvSubmissionWrapper; //Update a request for verification of a toll-free phone number. + +const { status, data } = await apiInstance.updateTollFreeVerificationRequest( + accountId, + phoneNumber, + tfvSubmissionWrapper +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **tfvSubmissionWrapper** | **TfvSubmissionWrapper**| Update a request for verification of a toll-free phone number. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **phoneNumber** | [**string**] | Valid Toll-Free telephone number in E.164 format. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**202** | Accepted | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateWebhookSubscription** +> WebhookSubscription updateWebhookSubscription(webhookSubscriptionRequestSchema) + +Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated). + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration, + WebhookSubscriptionRequestSchema +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let id: string; //Webhook subscription ID (default to undefined) +let webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema; //Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. + +const { status, data } = await apiInstance.updateWebhookSubscription( + accountId, + id, + webhookSubscriptionRequestSchema +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **webhookSubscriptionRequestSchema** | **WebhookSubscriptionRequestSchema**| Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. | | +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **id** | [**string**] | Webhook subscription ID | defaults to undefined| + + +### Return type + +**WebhookSubscription** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TranscribeRecording.md b/docs/TranscribeRecording.md new file mode 100644 index 0000000..c415fa5 --- /dev/null +++ b/docs/TranscribeRecording.md @@ -0,0 +1,32 @@ +# TranscribeRecording + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**callbackUrl** | **string** | The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization. | [optional] [default to undefined] +**callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined] +**username** | **string** | Basic auth username. | [optional] [default to undefined] +**password** | **string** | Basic auth password. | [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] +**callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering the webhook to `callbackUrl`. Can be any numeric value (including decimals) between 1 and 25. | [optional] [default to 15] +**detectLanguage** | **boolean** | A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish. | [optional] [default to false] + +## Example + +```typescript +import { TranscribeRecording } from 'bandwidth-sdk'; + +const instance: TranscribeRecording = { + callbackUrl, + callbackMethod, + username, + password, + tag, + callbackTimeout, + detectLanguage, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Transcription.md b/docs/Transcription.md new file mode 100644 index 0000000..5588e23 --- /dev/null +++ b/docs/Transcription.md @@ -0,0 +1,22 @@ +# Transcription + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | The transcribed text | [optional] [default to undefined] +**confidence** | **number** | The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence. | [optional] [default to undefined] + +## Example + +```typescript +import { Transcription } from 'bandwidth-sdk'; + +const instance: Transcription = { + text, + confidence, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TranscriptionAvailableCallback.md b/docs/TranscriptionAvailableCallback.md new file mode 100644 index 0000000..c6aa331 --- /dev/null +++ b/docs/TranscriptionAvailableCallback.md @@ -0,0 +1,61 @@ +# TranscriptionAvailableCallback + +The Transcription Available event is sent when the recording transcription is available to be downloaded. + +## 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] +**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] [default to undefined] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined] +**recordingId** | **string** | The unique ID of this recording | [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] +**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined] +**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined] +**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [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] +**transcription** | [**Transcription**](Transcription.md) | | [optional] [default to undefined] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] + +## Example + +```typescript +import { TranscriptionAvailableCallback } from 'bandwidth-sdk'; + +const instance: TranscriptionAvailableCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + mediaUrl, + parentCallId, + recordingId, + enqueuedTime, + startTime, + endTime, + duration, + fileFormat, + tag, + transcription, + transferCallerId, + transferTo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TranscriptionsApi.md b/docs/TranscriptionsApi.md new file mode 100644 index 0000000..3cc5e9f --- /dev/null +++ b/docs/TranscriptionsApi.md @@ -0,0 +1,202 @@ +# TranscriptionsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteRealTimeTranscription**](#deleterealtimetranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription| +|[**getRealTimeTranscription**](#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription| +|[**listRealTimeTranscriptions**](#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription| + +# **deleteRealTimeTranscription** +> deleteRealTimeTranscription() + +Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + +### Example + +```typescript +import { + TranscriptionsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TranscriptionsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let transcriptionId: string; //Programmable Voice API Transcription ID. (default to undefined) + +const { status, data } = await apiInstance.deleteRealTimeTranscription( + accountId, + callId, + transcriptionId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **transcriptionId** | [**string**] | Programmable Voice API Transcription ID. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | No Content | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getRealTimeTranscription** +> CallTranscriptionResponse getRealTimeTranscription() + +Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). + +### Example + +```typescript +import { + TranscriptionsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TranscriptionsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) +let transcriptionId: string; //Programmable Voice API Transcription ID. (default to undefined) + +const { status, data } = await apiInstance.getRealTimeTranscription( + accountId, + callId, + transcriptionId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| +| **transcriptionId** | [**string**] | Programmable Voice API Transcription ID. | defaults to undefined| + + +### Return type + +**CallTranscriptionResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listRealTimeTranscriptions** +> Array listRealTimeTranscriptions() + +Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription). + +### Example + +```typescript +import { + TranscriptionsApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TranscriptionsApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let callId: string; //Programmable Voice API Call ID. (default to undefined) + +const { status, data } = await apiInstance.listRealTimeTranscriptions( + accountId, + callId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Not Found | - | +|**405** | Method Not Allowed | - | +|**415** | Unsupported Media Type | - | +|**429** | Too Many Requests | * Retry-After - When you should try your request again.
| +|**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TransferAnswerCallback.md b/docs/TransferAnswerCallback.md new file mode 100644 index 0000000..86ce77b --- /dev/null +++ b/docs/TransferAnswerCallback.md @@ -0,0 +1,49 @@ +# TransferAnswerCallback + +When processing a verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed. + +## 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] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] + +## Example + +```typescript +import { TransferAnswerCallback } from 'bandwidth-sdk'; + +const instance: TransferAnswerCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + enqueuedTime, + startTime, + answerTime, + tag, + transferCallerId, + transferTo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransferCompleteCallback.md b/docs/TransferCompleteCallback.md new file mode 100644 index 0000000..7de4230 --- /dev/null +++ b/docs/TransferCompleteCallback.md @@ -0,0 +1,55 @@ +# TransferCompleteCallback + +This event is sent to the transferCompleteUrl of the A-leg\'s verb when the transferred call (B-leg) completes. In a simultaneous ringing scenario, only one B-leg succeeds and this event corresponds to that successful leg. If none of the calls were answered, the transferComplete event corresponds to one of the legs. + +## 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] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [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\'s internal id that references the error event. | [optional] [default to undefined] + +## Example + +```typescript +import { TransferCompleteCallback } from 'bandwidth-sdk'; + +const instance: TransferCompleteCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + enqueuedTime, + startTime, + answerTime, + tag, + transferCallerId, + transferTo, + 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) diff --git a/docs/TransferDisconnectCallback.md b/docs/TransferDisconnectCallback.md new file mode 100644 index 0000000..ff644c5 --- /dev/null +++ b/docs/TransferDisconnectCallback.md @@ -0,0 +1,59 @@ +# TransferDisconnectCallback + +This event is sent to the transferDisconnectUrl of each tag when its respective call leg ends for any reason. The event is sent in the normal case, when the transferred leg is answered and later hung up, but is also sent if the new leg was never answered in the first place, if it was rejected, and if the original call leg hung up before the transferred leg. + +## 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] +**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [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] +**endTime** | **string** | The time that the recording ended 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] +**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined] +**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [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\'s internal id that references the error event. | [optional] [default to undefined] + +## Example + +```typescript +import { TransferDisconnectCallback } from 'bandwidth-sdk'; + +const instance: TransferDisconnectCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + parentCallId, + enqueuedTime, + startTime, + answerTime, + endTime, + tag, + transferCallerId, + transferTo, + 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) diff --git a/docs/UpdateCall.md b/docs/UpdateCall.md new file mode 100644 index 0000000..d016dd9 --- /dev/null +++ b/docs/UpdateCall.md @@ -0,0 +1,38 @@ +# UpdateCall + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**CallStateEnum**](CallStateEnum.md) | | [optional] [default to undefined] +**redirectUrl** | **string** | The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML. Required if `state` is `active`. Not allowed if `state` is `completed`. | [optional] [default to undefined] +**redirectMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined] +**username** | **string** | Basic auth username. | [optional] [default to undefined] +**password** | **string** | Basic auth password. | [optional] [default to undefined] +**redirectFallbackUrl** | **string** | A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond. | [optional] [default to undefined] +**redirectFallbackMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined] +**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined] +**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined] +**tag** | **string** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 256 characters. Not allowed if `state` is `completed`. | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateCall } from 'bandwidth-sdk'; + +const instance: UpdateCall = { + state, + redirectUrl, + redirectMethod, + username, + password, + redirectFallbackUrl, + redirectFallbackMethod, + fallbackUsername, + fallbackPassword, + 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) diff --git a/docs/UpdateCallRecording.md b/docs/UpdateCallRecording.md new file mode 100644 index 0000000..4f9af6e --- /dev/null +++ b/docs/UpdateCallRecording.md @@ -0,0 +1,20 @@ +# UpdateCallRecording + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**RecordingStateEnum**](RecordingStateEnum.md) | | [default to undefined] + +## Example + +```typescript +import { UpdateCallRecording } from 'bandwidth-sdk'; + +const instance: UpdateCallRecording = { + state, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateConference.md b/docs/UpdateConference.md new file mode 100644 index 0000000..3a37140 --- /dev/null +++ b/docs/UpdateConference.md @@ -0,0 +1,36 @@ +# UpdateConference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | [**ConferenceStateEnum**](ConferenceStateEnum.md) | | [optional] [default to undefined] +**redirectUrl** | **string** | The URL to send the [conferenceRedirect](/docs/voice/webhooks/conferenceRedirect) event which will provide new BXML. Not allowed if `state` is `completed`, but required if `state` is `active`. | [optional] [default to undefined] +**redirectMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined] +**username** | **string** | Basic auth username. | [optional] [default to undefined] +**password** | **string** | Basic auth password. | [optional] [default to undefined] +**redirectFallbackUrl** | **string** | A fallback url which, if provided, will be used to retry the `conferenceRedirect` webhook delivery in case `redirectUrl` fails to respond. Not allowed if `state` is `completed`. | [optional] [default to undefined] +**redirectFallbackMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined] +**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined] +**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateConference } from 'bandwidth-sdk'; + +const instance: UpdateConference = { + status, + redirectUrl, + redirectMethod, + username, + password, + redirectFallbackUrl, + redirectFallbackMethod, + fallbackUsername, + fallbackPassword, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateConferenceMember.md b/docs/UpdateConferenceMember.md new file mode 100644 index 0000000..0f52f59 --- /dev/null +++ b/docs/UpdateConferenceMember.md @@ -0,0 +1,24 @@ +# UpdateConferenceMember + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mute** | **boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. Updates this member\'s mute status. Has no effect if omitted. | [optional] [default to undefined] +**hold** | **boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. Updates this member\'s hold status. Has no effect if omitted. | [optional] [default to undefined] +**callIdsToCoach** | **Array<string>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. Modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateConferenceMember } from 'bandwidth-sdk'; + +const instance: UpdateConferenceMember = { + mute, + hold, + callIdsToCoach, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VerificationDenialWebhook.md b/docs/VerificationDenialWebhook.md new file mode 100644 index 0000000..0636e39 --- /dev/null +++ b/docs/VerificationDenialWebhook.md @@ -0,0 +1,38 @@ +# VerificationDenialWebhook + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **string** | User\'s account ID. | [optional] [default to undefined] +**additionalDenialReasons** | [**Array<AdditionalDenialReason>**](AdditionalDenialReason.md) | An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. | [optional] [default to undefined] +**declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined] +**denialStatusCode** | **number** | Reason code for denial. | [optional] [default to undefined] +**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined] +**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined] +**resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined] +**status** | **string** | | [optional] [default to 'UNVERIFIED'] +**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined] + +## Example + +```typescript +import { VerificationDenialWebhook } from 'bandwidth-sdk'; + +const instance: VerificationDenialWebhook = { + accountId, + additionalDenialReasons, + declineReasonDescription, + denialStatusCode, + internalTicketNumber, + phoneNumber, + resubmitAllowed, + status, + blocked, + blockedReason, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md new file mode 100644 index 0000000..114a9f1 --- /dev/null +++ b/docs/VerificationRequest.md @@ -0,0 +1,44 @@ +# VerificationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**businessAddress** | [**Address**](Address.md) | | [default to undefined] +**businessContact** | [**Contact**](Contact.md) | | [default to undefined] +**messageVolume** | **number** | Estimated monthly volume of messages from the toll-free number. | [default to undefined] +**phoneNumbers** | **Array<string>** | | [default to undefined] +**useCase** | **string** | The category of the use case. | [default to undefined] +**useCaseSummary** | **string** | A general idea of the use case and customer. | [default to undefined] +**productionMessageContent** | **string** | Example of message content. | [default to undefined] +**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [default to undefined] +**additionalInformation** | **string** | Any additional information. | [optional] [default to undefined] +**isvReseller** | **string** | ISV name. | [optional] [default to undefined] +**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] + +## Example + +```typescript +import { VerificationRequest } from 'bandwidth-sdk'; + +const instance: VerificationRequest = { + businessAddress, + businessContact, + messageVolume, + phoneNumbers, + useCase, + useCaseSummary, + productionMessageContent, + optInWorkflow, + additionalInformation, + isvReseller, + privacyPolicyUrl, + termsAndConditionsUrl, + businessDBA, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md new file mode 100644 index 0000000..14e2493 --- /dev/null +++ b/docs/VerificationUpdateRequest.md @@ -0,0 +1,42 @@ +# VerificationUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**businessAddress** | [**Address**](Address.md) | | [default to undefined] +**businessContact** | [**Contact**](Contact.md) | | [default to undefined] +**messageVolume** | **number** | Estimated monthly volume of messages from the toll-free number. | [default to undefined] +**useCase** | **string** | The category of the use case. | [default to undefined] +**useCaseSummary** | **string** | A general idea of the use case and customer. | [default to undefined] +**productionMessageContent** | **string** | Example of message content. | [default to undefined] +**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [default to undefined] +**additionalInformation** | **string** | Any additional information. | [optional] [default to undefined] +**isvReseller** | **string** | ISV name. | [optional] [default to undefined] +**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] + +## Example + +```typescript +import { VerificationUpdateRequest } from 'bandwidth-sdk'; + +const instance: VerificationUpdateRequest = { + businessAddress, + businessContact, + messageVolume, + useCase, + useCaseSummary, + productionMessageContent, + optInWorkflow, + additionalInformation, + isvReseller, + privacyPolicyUrl, + termsAndConditionsUrl, + businessDBA, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VerificationWebhook.md b/docs/VerificationWebhook.md new file mode 100644 index 0000000..0d56a18 --- /dev/null +++ b/docs/VerificationWebhook.md @@ -0,0 +1,26 @@ +# VerificationWebhook + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **string** | User\'s account ID. | [optional] [default to undefined] +**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined] +**status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] [default to undefined] +**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined] + +## Example + +```typescript +import { VerificationWebhook } from 'bandwidth-sdk'; + +const instance: VerificationWebhook = { + accountId, + phoneNumber, + status, + internalTicketNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VerifyCodeRequest.md b/docs/VerifyCodeRequest.md new file mode 100644 index 0000000..9e3b015 --- /dev/null +++ b/docs/VerifyCodeRequest.md @@ -0,0 +1,26 @@ +# VerifyCodeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**to** | **string** | The phone number to send the mfa code to. | [default to undefined] +**scope** | **string** | An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\". | [optional] [default to undefined] +**expirationTimeInMinutes** | **number** | The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively. | [default to undefined] +**code** | **string** | The generated mfa code to check if valid. | [default to undefined] + +## Example + +```typescript +import { VerifyCodeRequest } from 'bandwidth-sdk'; + +const instance: VerifyCodeRequest = { + to, + scope, + expirationTimeInMinutes, + code, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VerifyCodeResponse.md b/docs/VerifyCodeResponse.md new file mode 100644 index 0000000..4492b1f --- /dev/null +++ b/docs/VerifyCodeResponse.md @@ -0,0 +1,20 @@ +# VerifyCodeResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**valid** | **boolean** | Whether or not the supplied code is valid. | [optional] [default to undefined] + +## Example + +```typescript +import { VerifyCodeResponse } from 'bandwidth-sdk'; + +const instance: VerifyCodeResponse = { + valid, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VoiceApiError.md b/docs/VoiceApiError.md new file mode 100644 index 0000000..4764545 --- /dev/null +++ b/docs/VoiceApiError.md @@ -0,0 +1,24 @@ +# VoiceApiError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { VoiceApiError } from 'bandwidth-sdk'; + +const instance: VoiceApiError = { + type, + description, + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VoiceCodeResponse.md b/docs/VoiceCodeResponse.md new file mode 100644 index 0000000..5a8ac93 --- /dev/null +++ b/docs/VoiceCodeResponse.md @@ -0,0 +1,20 @@ +# VoiceCodeResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**callId** | **string** | Programmable Voice API Call ID. | [optional] [default to undefined] + +## Example + +```typescript +import { VoiceCodeResponse } from 'bandwidth-sdk'; + +const instance: VoiceCodeResponse = { + callId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebhookSubscription.md b/docs/WebhookSubscription.md new file mode 100644 index 0000000..c01a3d2 --- /dev/null +++ b/docs/WebhookSubscription.md @@ -0,0 +1,33 @@ +# WebhookSubscription + +Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [optional] [default to undefined] +**accountId** | **string** | | [optional] [default to undefined] +**callbackUrl** | **string** | Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID. | [default to undefined] +**type** | [**WebhookSubscriptionTypeEnum**](WebhookSubscriptionTypeEnum.md) | | [optional] [default to undefined] +**basicAuthentication** | [**WebhookSubscriptionBasicAuthentication**](WebhookSubscriptionBasicAuthentication.md) | | [optional] [default to undefined] +**createdDate** | **string** | | [optional] [default to undefined] +**modifiedDate** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { WebhookSubscription } from 'bandwidth-sdk'; + +const instance: WebhookSubscription = { + id, + accountId, + callbackUrl, + type, + basicAuthentication, + createdDate, + modifiedDate, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebhookSubscriptionBasicAuthentication.md b/docs/WebhookSubscriptionBasicAuthentication.md new file mode 100644 index 0000000..6425807 --- /dev/null +++ b/docs/WebhookSubscriptionBasicAuthentication.md @@ -0,0 +1,23 @@ +# WebhookSubscriptionBasicAuthentication + +Basic authentication credentials are not required, but if present, both username and password must be provided. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **string** | | [default to undefined] +**password** | **string** | | [default to undefined] + +## Example + +```typescript +import { WebhookSubscriptionBasicAuthentication } from 'bandwidth-sdk'; + +const instance: WebhookSubscriptionBasicAuthentication = { + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebhookSubscriptionRequestSchema.md b/docs/WebhookSubscriptionRequestSchema.md new file mode 100644 index 0000000..883221b --- /dev/null +++ b/docs/WebhookSubscriptionRequestSchema.md @@ -0,0 +1,24 @@ +# WebhookSubscriptionRequestSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**basicAuthentication** | [**TfvBasicAuthentication**](TfvBasicAuthentication.md) | | [optional] [default to undefined] +**callbackUrl** | **string** | Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID. | [default to undefined] +**sharedSecretKey** | **string** | An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks. | [optional] [default to undefined] + +## Example + +```typescript +import { WebhookSubscriptionRequestSchema } from 'bandwidth-sdk'; + +const instance: WebhookSubscriptionRequestSchema = { + basicAuthentication, + callbackUrl, + sharedSecretKey, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebhookSubscriptionTypeEnum.md b/docs/WebhookSubscriptionTypeEnum.md new file mode 100644 index 0000000..09375fe --- /dev/null +++ b/docs/WebhookSubscriptionTypeEnum.md @@ -0,0 +1,10 @@ +# WebhookSubscriptionTypeEnum + + +## Enum + +* `TollfreeVerificationStatus` (value: `'TOLLFREE_VERIFICATION_STATUS'`) + +* `MessagingPortoutApprovalStatus` (value: `'MESSAGING_PORTOUT_APPROVAL_STATUS'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebhookSubscriptionsListBody.md b/docs/WebhookSubscriptionsListBody.md new file mode 100644 index 0000000..8485b50 --- /dev/null +++ b/docs/WebhookSubscriptionsListBody.md @@ -0,0 +1,25 @@ +# WebhookSubscriptionsListBody + +A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated). + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**LinksObject**](LinksObject.md) | | [optional] [default to undefined] +**errors** | [**Array<ModelError>**](ModelError.md) | | [optional] [default to undefined] +**data** | [**Array<WebhookSubscription>**](WebhookSubscription.md) | | [default to undefined] + +## Example + +```typescript +import { WebhookSubscriptionsListBody } from 'bandwidth-sdk'; + +const instance: WebhookSubscriptionsListBody = { + links, + errors, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/models/callback-type-enum.ts b/models/callback-type-enum.ts index 554ac43..86f1d48 100644 --- a/models/callback-type-enum.ts +++ b/models/callback-type-enum.ts @@ -21,10 +21,10 @@ */ export const CallbackTypeEnum = { - Received: 'message-received', - Sending: 'message-sending', - Delivered: 'message-delivered', - Failed: 'message-failed' + MessageReceived: 'message-received', + MessageSending: 'message-sending', + MessageDelivered: 'message-delivered', + MessageFailed: 'message-failed' } as const; export type CallbackTypeEnum = typeof CallbackTypeEnum[keyof typeof CallbackTypeEnum]; diff --git a/openapitools.json b/openapitools.json index f8d07ce..151c200 100644 --- a/openapitools.json +++ b/openapitools.json @@ -2,6 +2,6 @@ "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "7.10.0" + "version": "7.13.0" } } diff --git a/tests/unit/models/callback-type-enum.test.ts b/tests/unit/models/callback-type-enum.test.ts index d5050b7..f81e99d 100644 --- a/tests/unit/models/callback-type-enum.test.ts +++ b/tests/unit/models/callback-type-enum.test.ts @@ -2,9 +2,9 @@ import { CallbackTypeEnum } from '../../../models/callback-type-enum'; describe('CallbackTypeEnum', () => { test('should define the expected values', () => { - expect(CallbackTypeEnum.Received).toBe('message-received'); - expect(CallbackTypeEnum.Delivered).toBe('message-delivered'); - expect(CallbackTypeEnum.Failed).toBe('message-failed'); - expect(CallbackTypeEnum.Sending).toBe('message-sending'); + expect(CallbackTypeEnum.MessageReceived).toBe('message-received'); + expect(CallbackTypeEnum.MessageDelivered).toBe('message-delivered'); + expect(CallbackTypeEnum.MessageFailed).toBe('message-failed'); + expect(CallbackTypeEnum.MessageSending).toBe('message-sending'); }); });